org.cloudi

Class 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.ForwardAsyncException
static class	API.ForwardSyncException
static class	API.InvalidInputException
static class	API.MessageDecodingException
class	API.Response
static class	API.ReturnAsyncException
static class	API.ReturnSyncException
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

Constructor Summary

Constructors

Constructor and Description
API(int thread_index)

Method Summary

Methods

Modifier and Type	Method and Description
void	forward_(Integer command, String name, byte[] request_info, byte[] request, Integer timeout, Byte priority, byte[] transId, com.ericsson.otp.erlang.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[] transId, com.ericsson.otp.erlang.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[] transId, com.ericsson.otp.erlang.OtpErlangPid pid) Synchronously forward a message to another service subscribed that matches the destination service name.
HashMap<String,List<String>>	info_key_value_parse(byte[] info)
List<API.TransId>	mcast_async(String name, byte[] request) Asynchronous point-multicast communication to services subscribed that matches the destination service name.
List<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.
Object	poll()
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[] transId) Asynchronously receive a response.
API.Response	recv_async(byte[] transId, 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[] transId) Asynchronously receive a response.
API.Response	recv_async(Integer timeout, byte[] transId, boolean consume) Asynchronously receive a response.
HashMap<String,List<String>>	request_http_qs_parse(byte[] request)
void	return_(Integer command, String name, String pattern, byte[] response_info, byte[] response, Integer timeout, byte[] transId, com.ericsson.otp.erlang.OtpErlangPid pid) Returns a response from a service request.
void	return_async(String name, String pattern, byte[] response_info, byte[] response, Integer timeout, byte[] transId, com.ericsson.otp.erlang.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[] transId, com.ericsson.otp.erlang.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	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_sync()
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

Throws:

API.InvalidInputException

API.MessageDecodingException

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

subscribe

public void subscribe(String pattern,
             Object instance,
             String methodName)

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

unsubscribe

public void unsubscribe(String pattern)
                 throws API.InvalidInputException

Unsubscribes from a service name pattern.

Parameters:

pattern - the service name pattern

Throws:

API.InvalidInputException

send_async

public API.TransId send_async(String name,
                     byte[] request)
                       throws API.MessageDecodingException

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.MessageDecodingException

send_async

public API.TransId send_async(String name,
                     byte[] request_info,
                     byte[] request,
                     Integer timeout,
                     Byte priority)
                       throws API.MessageDecodingException

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.MessageDecodingException

send_sync

public API.Response send_sync(String name,
                     byte[] request)
                       throws API.MessageDecodingException

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.MessageDecodingException

send_sync

public API.Response send_sync(String name,
                     byte[] request_info,
                     byte[] request,
                     Integer timeout,
                     Byte priority)
                       throws API.MessageDecodingException

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.MessageDecodingException

mcast_async

public List<API.TransId> mcast_async(String name,
                            byte[] request)
                              throws API.MessageDecodingException

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.MessageDecodingException

mcast_async

public List<API.TransId> mcast_async(String name,
                            byte[] request_info,
                            byte[] request,
                            Integer timeout,
                            Byte priority)
                              throws API.MessageDecodingException

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.MessageDecodingException

forward_

public void forward_(Integer command,
            String name,
            byte[] request_info,
            byte[] request,
            Integer timeout,
            Byte priority,
            byte[] transId,
            com.ericsson.otp.erlang.OtpErlangPid pid)
              throws API.ForwardAsyncException,
                     API.ForwardSyncException,
                     API.InvalidInputException

Forward a message to another service subscribed that matches the destination service name.

Parameters:

command - 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

transId - the transaction ID

pid - the request's source process ID

Throws:

API.ForwardAsyncException

API.ForwardSyncException

API.InvalidInputException

forward_async

public void forward_async(String name,
                 byte[] request_info,
                 byte[] request,
                 Integer timeout,
                 Byte priority,
                 byte[] transId,
                 com.ericsson.otp.erlang.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

transId - the transaction ID

pid - the request's source process ID

Throws:

API.ForwardAsyncException

forward_sync

public void forward_sync(String name,
                byte[] request_info,
                byte[] request,
                Integer timeout,
                Byte priority,
                byte[] transId,
                com.ericsson.otp.erlang.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

transId - the transaction ID

pid - the request's source process ID

Throws:

API.ForwardSyncException

return_

public void return_(Integer command,
           String name,
           String pattern,
           byte[] response_info,
           byte[] response,
           Integer timeout,
           byte[] transId,
           com.ericsson.otp.erlang.OtpErlangPid pid)
             throws API.ReturnAsyncException,
                    API.ReturnSyncException,
                    API.InvalidInputException

Returns a response from a service request.

Parameters:

command - 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

transId - the transaction ID

pid - the request's source process ID

Throws:

API.ReturnAsyncException

API.ReturnSyncException

API.InvalidInputException

return_async

public void return_async(String name,
                String pattern,
                byte[] response_info,
                byte[] response,
                Integer timeout,
                byte[] transId,
                com.ericsson.otp.erlang.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

transId - the transaction ID

pid - the request's source process ID

Throws:

API.ReturnAsyncException

return_sync

public void return_sync(String name,
               String pattern,
               byte[] response_info,
               byte[] response,
               Integer timeout,
               byte[] transId,
               com.ericsson.otp.erlang.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

transId - the transaction ID

pid - the request's source process ID

Throws:

API.ReturnSyncException

recv_async

public API.Response recv_async()
                        throws API.MessageDecodingException

Asynchronously receive a response.

Returns:

the response

Throws:

API.MessageDecodingException

recv_async

public API.Response recv_async(Integer timeout)
                        throws API.MessageDecodingException

Asynchronously receive a response.

Parameters:

timeout - the receive timeout in milliseconds

Returns:

the response

Throws:

API.MessageDecodingException

recv_async

public API.Response recv_async(byte[] transId)
                        throws API.MessageDecodingException

Asynchronously receive a response.

Parameters:

transId - the transaction ID to receive

Returns:

the response

Throws:

API.MessageDecodingException

recv_async

public API.Response recv_async(boolean consume)
                        throws API.MessageDecodingException

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.MessageDecodingException

recv_async

public API.Response recv_async(Integer timeout,
                      byte[] transId)
                        throws API.MessageDecodingException

Asynchronously receive a response.

Parameters:

timeout - the receive timeout in milliseconds

transId - the transaction ID to receive

Returns:

the response

Throws:

API.MessageDecodingException

recv_async

public API.Response recv_async(Integer timeout,
                      boolean consume)
                        throws API.MessageDecodingException

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.MessageDecodingException

recv_async

public API.Response recv_async(byte[] transId,
                      boolean consume)
                        throws API.MessageDecodingException

Asynchronously receive a response.

Parameters:

transId - 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.MessageDecodingException

recv_async

public API.Response recv_async(Integer timeout,
                      byte[] transId,
                      boolean consume)
                        throws API.MessageDecodingException

Asynchronously receive a response.

Parameters:

timeout - the receive timeout in milliseconds

transId - 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.MessageDecodingException

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_async

public int timeout_async()

timeout_sync

public int timeout_sync()

poll

public Object poll()
            throws API.MessageDecodingException

Throws:

API.MessageDecodingException

request_http_qs_parse

public HashMap<String,List<String>> request_http_qs_parse(byte[] request)

info_key_value_parse

public HashMap<String,List<String>> info_key_value_parse(byte[] info)