edu.snu.coral.runtime.common.message

Interface MessageEnvironment

All Known Implementing Classes:

GrpcMessageEnvironment, LocalMessageEnvironment, NcsMessageEnvironment

@DefaultImplementation(value=NcsMessageEnvironment.class)
public interface MessageEnvironment

Set up MessageListeners to handle incoming messages on this node, and connect to remote nodes and return MessageSenders to send message to them.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BLOCK_MANAGER_MASTER_MESSAGE_LISTENER_ID
static String	EXECUTOR_MESSAGE_LISTENER_ID
static String	MASTER_COMMUNICATION_ID
static String	RUNTIME_MASTER_MESSAGE_LISTENER_ID

Method Summary

Modifier and Type	Method and Description
<T> Future<MessageSender<T>>	asyncConnect(String receiverId, String listenerId) Asynchronously connect to the node called receiverId and return a future of MessageSender that sends messages to the listener with listenerId.
void	close() Close this message environment.
void	removeListener(String listenerId) Remove the MessageListener bound to a specific listener ID.
<T> void	setupListener(String listenerId, MessageListener<T> listener) Set up a MessageListener with a listener id.

Field Detail

MASTER_COMMUNICATION_ID

static final String MASTER_COMMUNICATION_ID

See Also:

Constant Field Values

RUNTIME_MASTER_MESSAGE_LISTENER_ID

static final String RUNTIME_MASTER_MESSAGE_LISTENER_ID

See Also:

Constant Field Values

BLOCK_MANAGER_MASTER_MESSAGE_LISTENER_ID

static final String BLOCK_MANAGER_MASTER_MESSAGE_LISTENER_ID

See Also:

Constant Field Values

EXECUTOR_MESSAGE_LISTENER_ID

static final String EXECUTOR_MESSAGE_LISTENER_ID

See Also:

Constant Field Values

Method Detail

setupListener

<T> void setupListener(String listenerId,
                       MessageListener<T> listener)

Set up a MessageListener with a listener id.

Type Parameters:

T - The type of the message to be sent in the environment

Parameters:

listenerId - an identifier of the message listener

listener - a message listener

removeListener

void removeListener(String listenerId)

Remove the MessageListener bound to a specific listener ID.

Parameters:

listenerId - the ID of the listener to remove.

asyncConnect

<T> Future<MessageSender<T>> asyncConnect(String receiverId,
                                          String listenerId)

Asynchronously connect to the node called receiverId and return a future of MessageSender that sends messages to the listener with listenerId.

Type Parameters:

T - The type of the message to be sent in the environment

Parameters:

receiverId - a receiver id

listenerId - an identifier of the message listener

Returns:

a message sender

close

void close()
    throws Exception

Close this message environment.

Throws:

Exception - while closing