org.apache.reef.wake.remote

Interface RemoteManager

All Superinterfaces:

AutoCloseable, Stage

All Known Implementing Classes:

DefaultRemoteManagerImplementation

@DefaultImplementation(value=DefaultRemoteManagerImplementation.class)
public interface RemoteManager
extends Stage

Represents all remote connections to and from one process to another.

Method Summary

Methods

Modifier and Type	Method and Description
<T> EventHandler<T>	getHandler(RemoteIdentifier destinationIdentifier, Class<? extends T> messageType) Returns an event handler that can be used to send messages of type T to the given destination.
RemoteIdentifier	getMyIdentifier() Access the Identifier of this.
<T,U extends T> AutoCloseable	registerHandler(Class<U> messageType, EventHandler<RemoteMessage<T>> theHandler) Registers the given EventHandler to be called for the given message type from any source.
<T,U extends T> AutoCloseable	registerHandler(RemoteIdentifier sourceIdentifier, Class<U> messageType, EventHandler<T> theHandler) Registers the given EventHandler to be invoked when messages of Type T arrive from sourceIdentifier.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

getHandler

<T> EventHandler<T> getHandler(RemoteIdentifier destinationIdentifier,
                             Class<? extends T> messageType)

Returns an event handler that can be used to send messages of type T to the given destination.

Type Parameters:

T - type of message

Parameters:

destinationIdentifier - a destination identifier

messageType - a message class type

Returns:

an event handler

registerHandler

<T,U extends T> AutoCloseable registerHandler(RemoteIdentifier sourceIdentifier,
                                            Class<U> messageType,
                                            EventHandler<T> theHandler)

Registers the given EventHandler to be invoked when messages of Type T arrive from sourceIdentifier.

Calling this method twice overrides the initial registration.

Type Parameters:

T - type of event

U - type of message

Parameters:

sourceIdentifier - a source identifier

messageType - a message class type

theHandler - the event handler

Returns:

the subscription that can be used to unsubscribe later

registerHandler

<T,U extends T> AutoCloseable registerHandler(Class<U> messageType,
                                            EventHandler<RemoteMessage<T>> theHandler)

Registers the given EventHandler to be called for the given message type from any source.

If there is an EventHandler registered for this EventType

Type Parameters:

T - a type of remote message of event

U - a type of message

Parameters:

messageType - a message class type

theHandler - the event handler

Returns:

the subscription that can be used to unsubscribe later

getMyIdentifier

RemoteIdentifier getMyIdentifier()

Access the Identifier of this.

Returns:

the Identifier of this.