API (cloudi_api_java 2.0.1 API)

java.lang.Object
- org.cloudi.API

```
public class API
extends Object
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`API.FatalError`
`static class`	`API.ForwardAsyncException`
`static class`	`API.ForwardSyncException`
`static class`	`API.InvalidInputException`
`static class`	`API.MessageDecodingException`
`static class`	`API.Response`
`static class`	`API.ReturnAsyncException`
`static class`	`API.ReturnSyncException`
`static class`	`API.TerminateException`
`static class`	`API.TransId`

Field Summary

Fields
Modifier and Type Field and Description

static int ASYNC

static PrintStream err

static PrintStream out

static int SYNC

static byte[] TransIdNull

Fields
Modifier and Type	Field and Description
`static int`	`ASYNC`
`static PrintStream`	`err`
`static PrintStream`	`out`
`static int`	`SYNC`
`static byte[]`	`TransIdNull`

Constructor Summary

Constructors
Constructor and Description

API(int thread_index)

Constructors
Constructor and Description
`API(int thread_index)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`forward_(Integer request_type, String name, byte[] request_info, byte[] request, Integer timeout, Byte priority, byte[] trans_id, OtpErlangPid pid)` Forward a message to another service subscribed that matches the destination service `name`.
`void`	`forward_async(String name, byte[] request_info, byte[] request, Integer timeout, Byte priority, byte[] trans_id, OtpErlangPid pid)` Asynchronously forward a message to another service subscribed that matches the destination service `name`.
`void`	`forward_sync(String name, byte[] request_info, byte[] request, Integer timeout, Byte priority, byte[] trans_id, OtpErlangPid pid)` Synchronously forward a message to another service subscribed that matches the destination service `name`.
`static byte[]`	`info_key_value_new(Map<String,List<String>> pairs)` Encode service response info key/value data
`static byte[]`	`info_key_value_new(Map<String,List<String>> pairs, boolean response)` Encode service response info key/value data
`static HashMap<String,ArrayList<String>>`	`info_key_value_parse(byte[] info)` Decode service request info key/value data
`ArrayList<API.TransId>`	`mcast_async(String name, byte[] request)` Asynchronous point-multicast communication to services subscribed that matches the destination service `name`.
`ArrayList<API.TransId>`	`mcast_async(String name, byte[] request_info, byte[] request, Integer timeout, Byte priority)` Asynchronous point-multicast communication to services subscribed that matches the destination service `name`.
`boolean`	`poll()` Blocks to process incoming CloudI service requests
`boolean`	`poll(int timeout)` Blocks to process incoming CloudI service requests
`String`	`prefix()`
`int`	`process_count_max()`
`int`	`process_count_min()`
`int`	`process_count()`
`int`	`process_index()`
`API.Response`	`recv_async()` Asynchronously receive a response.
`API.Response`	`recv_async(boolean consume)` Asynchronously receive a response.
`API.Response`	`recv_async(byte[] trans_id)` Asynchronously receive a response.
`API.Response`	`recv_async(byte[] trans_id, boolean consume)` Asynchronously receive a response.
`API.Response`	`recv_async(Integer timeout)` Asynchronously receive a response.
`API.Response`	`recv_async(Integer timeout, boolean consume)` Asynchronously receive a response.
`API.Response`	`recv_async(Integer timeout, byte[] trans_id)` Asynchronously receive a response.
`API.Response`	`recv_async(Integer timeout, byte[] trans_id, boolean consume)` Asynchronously receive a response.
`void`	`return_(Integer request_type, String name, String pattern, byte[] response_info, byte[] response, Integer timeout, byte[] trans_id, OtpErlangPid pid)` Returns a response from a service request.
`void`	`return_async(String name, String pattern, byte[] response_info, byte[] response, Integer timeout, byte[] trans_id, OtpErlangPid pid)` Asynchronously returns a response from a service request.
`void`	`return_sync(String name, String pattern, byte[] response_info, byte[] response, Integer timeout, byte[] trans_id, OtpErlangPid pid)` Synchronously returns a response from a service request.
`API.TransId`	`send_async(String name, byte[] request)` Asynchronous point-to-point communication to a service subscribed that matches the destination service `name`.
`API.TransId`	`send_async(String name, byte[] request_info, byte[] request, Integer timeout, Byte priority)` Asynchronous point-to-point communication to a service subscribed that matches the destination service `name`.
`API.Response`	`send_sync(String name, byte[] request)` Synchronous point-to-point communication to a service subscribed that matches the destination service `name`.
`API.Response`	`send_sync(String name, byte[] request_info, byte[] request, Integer timeout, Byte priority)` Synchronous point-to-point communication to a service subscribed that matches the destination service `name`.
`void`	`shutdown()` Shutdown the service successfully
`void`	`shutdown(String reason)` Shutdown the service successfully
`int`	`subscribe_count(String pattern)` Determine how may service name pattern subscriptions have occurred.
`void`	`subscribe(String pattern, Class<?> clazz, String methodName)` Subscribes a static method to a service name pattern.
`void`	`subscribe(String pattern, FunctionInterface10 callback)` Subscribes a static method to a service name pattern.
`void`	`subscribe(String pattern, FunctionInterface9 callback)` Subscribes an object method to a service name pattern.
`void`	`subscribe(String pattern, Object instance, String methodName)` Subscribes an object method to a service name pattern.
`static int`	`thread_count()`
`int`	`timeout_async()`
`int`	`timeout_initialize()`
`int`	`timeout_sync()`
`int`	`timeout_terminate()`
`void`	`unsubscribe(String pattern)` Unsubscribes from a service name pattern.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - out
```
public static final PrintStream out
```
  - err
```
public static final PrintStream err
```
  - ASYNC
```
public static final int ASYNC
```
    See Also:
    
    Constant Field Values
  - SYNC
```
public static final int SYNC
```
    See Also:
    
    Constant Field Values
  - TransIdNull
```
public static final byte[] TransIdNull
```
- Constructor Detail
  - API
```
public API(int thread_index)
    throws API.InvalidInputException,
           API.MessageDecodingException,
           API.TerminateException
```
    Throws:
    
    API.InvalidInputException
    
    API.MessageDecodingException
    
    API.TerminateException
- Method Detail
  - thread_count
```
public static int thread_count()
                        throws API.InvalidInputException
```
    Returns:
    
    the number of threads to create per operating system process
    
    Throws:
    
    API.InvalidInputException - service execution failure
  - subscribe
```
public void subscribe(String pattern,
                      Object instance,
                      String methodName)
               throws NoSuchMethodException
```
    Subscribes an object method to a service name pattern.
    
    Parameters:
    
    pattern - the service name pattern
    
    instance - the object instance
    
    methodName - the object method to handle matching requests
    
    Throws:
    
    NoSuchMethodException - instance method arity is invalid
  - subscribe
```
public void subscribe(String pattern,
                      Class<?> clazz,
                      String methodName)
               throws NoSuchMethodException
```
    Subscribes a static method to a service name pattern.
    
    Parameters:
    
    pattern - the service name pattern
    
    clazz - the class of the static method
    
    methodName - the static method to handle matching requests
    
    Throws:
    
    NoSuchMethodException - instance method arity is invalid
  - subscribe
```
public void subscribe(String pattern,
                      FunctionInterface10 callback)
```
    Subscribes a static method to a service name pattern.
    
    Parameters:
    
    pattern - the service name pattern
    
    callback - method reference for callback (Java 8 or higher)
  - subscribe
```
public void subscribe(String pattern,
                      FunctionInterface9 callback)
```
    Subscribes an object method to a service name pattern.
    
    Parameters:
    
    pattern - the service name pattern
    
    callback - method reference for callback (Java 8 or higher)
  - subscribe_count
```
public int subscribe_count(String pattern)
                    throws API.InvalidInputException,
                           API.TerminateException
```
    Determine how may service name pattern subscriptions have occurred.
    
    Parameters:
    
    pattern - the service name pattern
    
    Returns:
    
    count of active subscriptions
    
    Throws:
    
    API.InvalidInputException - invalid input to internal function call
    
    API.TerminateException - service execution must terminate
  - unsubscribe
```
public void unsubscribe(String pattern)
                 throws API.InvalidInputException
```
    Unsubscribes from a service name pattern.
    
    Parameters:
    
    pattern - the service name pattern
    
    Throws:
    
    API.InvalidInputException - not subscribed to service name pattern
  - send_async
```
public API.TransId send_async(String name,
                              byte[] request)
                       throws API.InvalidInputException,
                              API.MessageDecodingException,
                              API.TerminateException
```
    Asynchronous point-to-point communication to a service subscribed that matches the destination service name.
    
    Parameters:
    
    name - the destination service name
    
    request - the request data
    
    Returns:
    
    a transaction ID
    
    Throws:
    
    API.InvalidInputException - invalid input to internal function call
    
    API.MessageDecodingException - service messaging failure
    
    API.TerminateException - service execution must terminate
  - send_async
```
public API.TransId send_async(String name,
                              byte[] request_info,
                              byte[] request,
                              Integer timeout,
                              Byte priority)
                       throws API.InvalidInputException,
                              API.MessageDecodingException,
                              API.TerminateException
```
    Asynchronous point-to-point communication to a service subscribed that matches the destination service name.
    
    Parameters:
    
    name - the destination service name
    
    request_info - any request metadata
    
    request - the request data
    
    timeout - the request timeout in milliseconds
    
    priority - the request priority
    
    Returns:
    
    a transaction ID
    
    Throws:
    
    API.InvalidInputException - invalid input to internal function call
    
    API.MessageDecodingException - service messaging failure
    
    API.TerminateException - service execution must terminate
  - send_sync
```
public API.Response send_sync(String name,
                              byte[] request)
                       throws API.InvalidInputException,
                              API.MessageDecodingException,
                              API.TerminateException
```
    Synchronous point-to-point communication to a service subscribed that matches the destination service name.
    
    Parameters:
    
    name - the destination service name
    
    request - the request data
    
    Returns:
    
    the response
    
    Throws:
    
    API.InvalidInputException - invalid input to internal function call
    
    API.MessageDecodingException - service messaging failure
    
    API.TerminateException - service execution must terminate
  - send_sync
```
public API.Response send_sync(String name,
                              byte[] request_info,
                              byte[] request,
                              Integer timeout,
                              Byte priority)
                       throws API.InvalidInputException,
                              API.MessageDecodingException,
                              API.TerminateException
```
    Synchronous point-to-point communication to a service subscribed that matches the destination service name.
    
    Parameters:
    
    name - the destination service name
    
    request_info - any request metadata
    
    request - the request data
    
    timeout - the request timeout in milliseconds
    
    priority - the request priority
    
    Returns:
    
    the response
    
    Throws:
    
    API.InvalidInputException - invalid input to internal function call
    
    API.MessageDecodingException - service messaging failure
    
    API.TerminateException - service execution must terminate
  - mcast_async
```
public ArrayList<API.TransId> mcast_async(String name,
                                          byte[] request)
                                   throws API.InvalidInputException,
                                          API.MessageDecodingException,
                                          API.TerminateException
```
    Asynchronous point-multicast communication to services subscribed that matches the destination service name.
    
    Parameters:
    
    name - the destination service name
    
    request - the request data
    
    Returns:
    
    transaction IDs
    
    Throws:
    
    API.InvalidInputException - invalid input to internal function call
    
    API.MessageDecodingException - service messaging failure
    
    API.TerminateException - service execution must terminate
  - mcast_async
```
public ArrayList<API.TransId> mcast_async(String name,
                                          byte[] request_info,
                                          byte[] request,
                                          Integer timeout,
                                          Byte priority)
                                   throws API.InvalidInputException,
                                          API.MessageDecodingException,
                                          API.TerminateException
```
    Asynchronous point-multicast communication to services subscribed that matches the destination service name.
    
    Parameters:
    
    name - the destination service name
    
    request_info - any request metadata
    
    request - the request data
    
    timeout - the request timeout in milliseconds
    
    priority - the priority of this request
    
    Returns:
    
    transaction IDs
    
    Throws:
    
    API.InvalidInputException - invalid input to internal function call
    
    API.MessageDecodingException - service messaging failure
    
    API.TerminateException - service execution must terminate
  - forward_
```
public void forward_(Integer request_type,
                     String name,
                     byte[] request_info,
                     byte[] request,
                     Integer timeout,
                     Byte priority,
                     byte[] trans_id,
                     OtpErlangPid pid)
              throws API.ForwardAsyncException,
                     API.ForwardSyncException,
                     API.InvalidInputException
```
    Forward a message to another service subscribed that matches the destination service name.
    
    Parameters:
    
    request_type - constant API.SYNC or API.ASYNC
    
    name - the destination service name
    
    request_info - any request metadata
    
    request - the request data
    
    timeout - the request timeout in milliseconds
    
    priority - the priority of this request
    
    trans_id - the transaction ID
    
    pid - the request's source process ID
    
    Throws:
    
    API.ForwardAsyncException - async service request was forwarded
    
    API.ForwardSyncException - sync service request was forwarded
    
    API.InvalidInputException - invalid service request type
  - forward_async
```
public void forward_async(String name,
                          byte[] request_info,
                          byte[] request,
                          Integer timeout,
                          Byte priority,
                          byte[] trans_id,
                          OtpErlangPid pid)
                   throws API.ForwardAsyncException
```
    Asynchronously forward a message to another service subscribed that matches the destination service name.
    
    Parameters:
    
    name - the destination service name
    
    request_info - any request metadata
    
    request - the request data
    
    timeout - the request timeout in milliseconds
    
    priority - the priority of this request
    
    trans_id - the transaction ID
    
    pid - the request's source process ID
    
    Throws:
    
    API.ForwardAsyncException - async service request was forwarded
  - forward_sync
```
public void forward_sync(String name,
                         byte[] request_info,
                         byte[] request,
                         Integer timeout,
                         Byte priority,
                         byte[] trans_id,
                         OtpErlangPid pid)
                  throws API.ForwardSyncException
```
    Synchronously forward a message to another service subscribed that matches the destination service name.
    
    Parameters:
    
    name - the destination service name
    
    request_info - any request metadata
    
    request - the request data
    
    timeout - the request timeout in milliseconds
    
    priority - the priority of this request
    
    trans_id - the transaction ID
    
    pid - the request's source process ID
    
    Throws:
    
    API.ForwardSyncException - sync service request was forwarded
  - return_
```
public void return_(Integer request_type,
                    String name,
                    String pattern,
                    byte[] response_info,
                    byte[] response,
                    Integer timeout,
                    byte[] trans_id,
                    OtpErlangPid pid)
             throws API.ReturnAsyncException,
                    API.ReturnSyncException,
                    API.InvalidInputException
```
    Returns a response from a service request.
    
    Parameters:
    
    request_type - constant API.SYNC or API.SYNC
    
    name - the service name
    
    pattern - the service name pattern
    
    response_info - any response metadata
    
    response - the response data
    
    timeout - the request timeout in milliseconds
    
    trans_id - the transaction ID
    
    pid - the request's source process ID
    
    Throws:
    
    API.ReturnAsyncException - async service request returned
    
    API.ReturnSyncException - sync service request returned
    
    API.InvalidInputException - invalid service request type
  - return_async
```
public void return_async(String name,
                         String pattern,
                         byte[] response_info,
                         byte[] response,
                         Integer timeout,
                         byte[] trans_id,
                         OtpErlangPid pid)
                  throws API.ReturnAsyncException
```
    Asynchronously returns a response from a service request.
    
    Parameters:
    
    name - the service name
    
    pattern - the service name pattern
    
    response_info - any response metadata
    
    response - the response data
    
    timeout - the request timeout in milliseconds
    
    trans_id - the transaction ID
    
    pid - the request's source process ID
    
    Throws:
    
    API.ReturnAsyncException - async service request returned
  - return_sync
```
public void return_sync(String name,
                        String pattern,
                        byte[] response_info,
                        byte[] response,
                        Integer timeout,
                        byte[] trans_id,
                        OtpErlangPid pid)
                 throws API.ReturnSyncException
```
    Synchronously returns a response from a service request.
    
    Parameters:
    
    name - the service name
    
    pattern - the service name pattern
    
    response_info - any response metadata
    
    response - the response data
    
    timeout - the request timeout in milliseconds
    
    trans_id - the transaction ID
    
    pid - the request's source process ID
    
    Throws:
    
    API.ReturnSyncException - sync service request returned
  - recv_async
```
public API.Response recv_async()
                        throws API.InvalidInputException,
                               API.MessageDecodingException,
                               API.TerminateException
```
    Asynchronously receive a response.
    
    Returns:
    
    the response
    
    Throws:
    
    API.InvalidInputException - invalid input to internal function call
    
    API.MessageDecodingException - service messaging failure
    
    API.TerminateException - service execution must terminate
  - recv_async
```
public API.Response recv_async(Integer timeout)
                        throws API.InvalidInputException,
                               API.MessageDecodingException,
                               API.TerminateException
```
    Asynchronously receive a response.
    
    Parameters:
    
    timeout - the receive timeout in milliseconds
    
    Returns:
    
    the response
    
    Throws:
    
    API.InvalidInputException - invalid input to internal function call
    
    API.MessageDecodingException - service messaging failure
    
    API.TerminateException - service execution must terminate
  - recv_async
```
public API.Response recv_async(byte[] trans_id)
                        throws API.InvalidInputException,
                               API.MessageDecodingException,
                               API.TerminateException
```
    Asynchronously receive a response.
    
    Parameters:
    
    trans_id - the transaction ID to receive
    
    Returns:
    
    the response
    
    Throws:
    
    API.InvalidInputException - invalid input to internal function call
    
    API.MessageDecodingException - service messaging failure
    
    API.TerminateException - service execution must terminate
  - recv_async
```
public API.Response recv_async(boolean consume)
                        throws API.InvalidInputException,
                               API.MessageDecodingException,
                               API.TerminateException
```
    Asynchronously receive a response.
    
    Parameters:
    
    consume - if true, will consume the service request so it is not accessible with the same function call in the future
    
    Returns:
    
    the response
    
    Throws:
    
    API.InvalidInputException - invalid input to internal function call
    
    API.MessageDecodingException - service messaging failure
    
    API.TerminateException - service execution must terminate
  - recv_async
```
public API.Response recv_async(Integer timeout,
                               byte[] trans_id)
                        throws API.InvalidInputException,
                               API.MessageDecodingException,
                               API.TerminateException
```
    Asynchronously receive a response.
    
    Parameters:
    
    timeout - the receive timeout in milliseconds
    
    trans_id - the transaction ID to receive
    
    Returns:
    
    the response
    
    Throws:
    
    API.InvalidInputException - invalid input to internal function call
    
    API.MessageDecodingException - service messaging failure
    
    API.TerminateException - service execution must terminate
  - recv_async
```
public API.Response recv_async(Integer timeout,
                               boolean consume)
                        throws API.InvalidInputException,
                               API.MessageDecodingException,
                               API.TerminateException
```
    Asynchronously receive a response.
    
    Parameters:
    
    timeout - the receive timeout in milliseconds
    
    consume - if true, will consume the service request so it is not accessible with the same function call in the future
    
    Returns:
    
    the response
    
    Throws:
    
    API.InvalidInputException - invalid input to internal function call
    
    API.MessageDecodingException - service messaging failure
    
    API.TerminateException - service execution must terminate
  - recv_async
```
public API.Response recv_async(byte[] trans_id,
                               boolean consume)
                        throws API.InvalidInputException,
                               API.MessageDecodingException,
                               API.TerminateException
```
    Asynchronously receive a response.
    
    Parameters:
    
    trans_id - the transaction ID to receive
    
    consume - if true, will consume the service request so it is not accessible with the same function call in the future
    
    Returns:
    
    the response
    
    Throws:
    
    API.InvalidInputException - invalid input to internal function call
    
    API.MessageDecodingException - service messaging failure
    
    API.TerminateException - service execution must terminate
  - recv_async
```
public API.Response recv_async(Integer timeout,
                               byte[] trans_id,
                               boolean consume)
                        throws API.InvalidInputException,
                               API.MessageDecodingException,
                               API.TerminateException
```
    Asynchronously receive a response.
    
    Parameters:
    
    timeout - the receive timeout in milliseconds
    
    trans_id - the transaction ID to receive
    
    consume - if true, will consume the service request so it is not accessible with the same function call in the future
    
    Returns:
    
    the response
    
    Throws:
    
    API.InvalidInputException - invalid input to internal function call
    
    API.MessageDecodingException - service messaging failure
    
    API.TerminateException - service execution must terminate
  - process_index
```
public int process_index()
```
  - process_count
```
public int process_count()
```
  - process_count_max
```
public int process_count_max()
```
  - process_count_min
```
public int process_count_min()
```
  - prefix
```
public String prefix()
```
  - timeout_initialize
```
public int timeout_initialize()
```
  - timeout_async
```
public int timeout_async()
```
  - timeout_sync
```
public int timeout_sync()
```
  - timeout_terminate
```
public int timeout_terminate()
```
  - poll
```
public boolean poll()
             throws API.InvalidInputException,
                    API.MessageDecodingException,
                    API.TerminateException
```
    Blocks to process incoming CloudI service requests
    
    Returns:
    
    false
    
    Throws:
    
    API.InvalidInputException - invalid input to internal function call
    
    API.MessageDecodingException - service messaging failure
    
    API.TerminateException - service execution must terminate
  - poll
```
public boolean poll(int timeout)
             throws API.InvalidInputException,
                    API.MessageDecodingException,
                    API.TerminateException
```
    Blocks to process incoming CloudI service requests
    
    Parameters:
    
    timeout - the block timeout in milliseconds (-1 is infinity)
    
    Returns:
    
    a boolean to determine if a timeout occurred
    
    Throws:
    
    API.InvalidInputException - invalid input to internal function call
    
    API.MessageDecodingException - service messaging failure
    
    API.TerminateException - service execution must terminate
  - shutdown
```
public void shutdown()
```
    Shutdown the service successfully
  - shutdown
```
public void shutdown(String reason)
```
    Shutdown the service successfully
    
    Parameters:
    
    reason - the shutdown reason
  - info_key_value_parse
```
public static HashMap<String,ArrayList<String>> info_key_value_parse(byte[] info)
```
    Decode service request info key/value data
    
    Parameters:
    
    info - encoded binary
    
    Returns:
    
    info key/value map
  - info_key_value_new
```
public static byte[] info_key_value_new(Map<String,List<String>> pairs)
```
    Encode service response info key/value data
    
    Parameters:
    
    pairs - info key/value map
    
    Returns:
    
    encoded binary
  - info_key_value_new
```
public static byte[] info_key_value_new(Map<String,List<String>> pairs,
                                        boolean response)
```
    Encode service response info key/value data
    
    Parameters:
    
    pairs - info key/value map
    
    response - if encoding response data
    
    Returns:
    
    encoded binary

Class API

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

out

err

ASYNC

SYNC

TransIdNull

Constructor Detail

API

Method Detail

thread_count

subscribe

subscribe

subscribe

subscribe

subscribe_count

unsubscribe

send_async

send_async

send_sync

send_sync

mcast_async

mcast_async

forward_

forward_async

forward_sync

return_

return_async

return_sync

recv_async

recv_async

recv_async

recv_async

recv_async

recv_async

recv_async

recv_async

process_index

process_count

process_count_max

process_count_min

prefix

timeout_initialize

timeout_async

timeout_sync

timeout_terminate

poll

poll

shutdown

shutdown

info_key_value_parse

info_key_value_new

info_key_value_new