edu.snu.coral.runtime.common.message.grpc

Class GrpcMessageEnvironment

java.lang.Object

edu.snu.coral.runtime.common.message.grpc.GrpcMessageEnvironment

All Implemented Interfaces:

MessageEnvironment

public final class GrpcMessageEnvironment
extends Object
implements MessageEnvironment

This class is installed when every node, containing both driver and evaluator, has been started, and setup grpc environment to implement RPC semantics defined in edu.snu.coral.runtime.common.message package. For each GrpcMessageEnvironment, there are a single GrpcMessageServer and multiple GrpcMessageClient, which are responsible for responding replies for messages from other clients, and for transferring messages to other servers, respectively. The GrpcMessageServer is started as soon as the environment is initialized, and registers the unique sender id of the local node to name server, which is used for id-based communication. The MessageListeners should be setup to correctly handle incoming messages. The GrpcMessageClients are created whenever there is a request to create a MessageSender, a component to issue RPC calls to other servers. Like the GrpcMessageServer registers its id to the name server, the GrpcMessageClient uses target receiver id to look up the name server to resolve the ip address of the target server before establishing a connection to the server.

Field Summary

Fields inherited from interface edu.snu.coral.runtime.common.message.MessageEnvironment

BLOCK_MANAGER_MASTER_MESSAGE_LISTENER_ID, EXECUTOR_MESSAGE_LISTENER_ID, MASTER_COMMUNICATION_ID, 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setupListener

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

Description copied from interface: MessageEnvironment

Set up a MessageListener with a listener id.

Specified by:

setupListener in interface MessageEnvironment

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

public void removeListener(String listenerId)

Description copied from interface: MessageEnvironment

Remove the MessageListener bound to a specific listener ID.

Specified by:

removeListener in interface MessageEnvironment

Parameters:

listenerId - the ID of the listener to remove.

asyncConnect

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

Description copied from interface: MessageEnvironment

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

Specified by:

asyncConnect in interface MessageEnvironment

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

public void close()
           throws Exception

Description copied from interface: MessageEnvironment

Close this message environment.

Specified by:

close in interface MessageEnvironment

Throws:

Exception - while closing