edu.snu.coral.runtime.common.message.local

Class LocalMessageEnvironment

java.lang.Object

edu.snu.coral.runtime.common.message.local.LocalMessageEnvironment

All Implemented Interfaces:

MessageEnvironment

public final class LocalMessageEnvironment
extends Object
implements MessageEnvironment

A simple MessageEnvironment implementation that works on a single node. Used for unit tests.

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

Constructor Summary

Constructors

Constructor and Description
LocalMessageEnvironment(String currentNodeId, LocalMessageDispatcher dispatcher)

Method Summary

Modifier and Type	Method and Description
<T> Future<MessageSender<T>>	asyncConnect(String targetId, String messageTypeId) 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.
String	getId()
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

Constructor Detail

LocalMessageEnvironment

public LocalMessageEnvironment(String currentNodeId,
                               LocalMessageDispatcher dispatcher)

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 targetId,
                                                 String messageTypeId)

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:

targetId - a receiver id

messageTypeId - an identifier of the message listener

Returns:

a message sender

getId

public String getId()

close

public void close()

Description copied from interface: MessageEnvironment

Close this message environment.

Specified by:

close in interface MessageEnvironment