Package org.apache.nemo.runtime.common.message.local

Class LocalMessageEnvironment

java.lang.Object

org.apache.nemo.runtime.common.message.local.LocalMessageEnvironment

All Implemented Interfaces:

MessageEnvironment

public final class LocalMessageEnvironment
extends java.lang.Object
implements MessageEnvironment

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

Field Summary

Fields

Modifier and Type	Field	Description
static org.apache.reef.tang.Configuration	LOCAL_MESSAGE_ENVIRONMENT_CONFIGURATION

Fields inherited from interface org.apache.nemo.runtime.common.message.MessageEnvironment

BLOCK_MANAGER_MASTER_MESSAGE_LISTENER_ID, EXECUTOR_MESSAGE_LISTENER_ID, MASTER_COMMUNICATION_ID, PIPE_MANAGER_MASTER_MESSAGE_LISTENER_ID, RUNTIME_MASTER_MESSAGE_LISTENER_ID

Method Summary

Modifier and Type	Method	Description
<T> java.util.concurrent.Future<MessageSender<T>>	asyncConnect(java.lang.String targetId, java.lang.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.
static org.apache.reef.tang.Injector	forkInjector(org.apache.reef.tang.Injector baseInjector, java.lang.String senderId)	Extends baseInjector to have LocalMessageEnvironment instance for the given senderId.
java.lang.String	getId()
void	removeListener(java.lang.String listenerId)	Remove the MessageListener bound to a specific listener ID.
<T> void	setupListener(java.lang.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

Field Detail

LOCAL_MESSAGE_ENVIRONMENT_CONFIGURATION

public static final org.apache.reef.tang.Configuration LOCAL_MESSAGE_ENVIRONMENT_CONFIGURATION

Method Detail

setupListener

public <T> void setupListener(java.lang.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(java.lang.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> java.util.concurrent.Future<MessageSender<T>> asyncConnect(java.lang.String targetId,
                                                                      java.lang.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 java.lang.String getId()

Specified by:

getId in interface MessageEnvironment

Returns:

identifier for this node

close

public void close()

Description copied from interface: MessageEnvironment

Close this message environment.

Specified by:

close in interface MessageEnvironment

forkInjector

public static org.apache.reef.tang.Injector forkInjector(org.apache.reef.tang.Injector baseInjector,
                                                         java.lang.String senderId)
                                                  throws org.apache.reef.tang.exceptions.InjectionException

Extends baseInjector to have LocalMessageEnvironment instance for the given senderId.

Parameters:

baseInjector - provided by LocalMessageDispatcher.getInjector() or LocalMessageDispatcher.forkInjector(Injector)

senderId - the identifier for the sender

Returns:

an Injector which has LocalMessageDispatcher instance for MessageEnvironment

Throws:

org.apache.reef.tang.exceptions.InjectionException - when fails to inject MessageEnvironment