org.apache.reef.wake.remote

Interface RemoteManagerFactory

@DefaultImplementation(value=org.apache.reef.wake.remote.DefaultRemoteManagerFactory.class)
public interface RemoteManagerFactory

Injectable Factory for RemoteManager instances.

Use when direct injection of the RemoteManager is impossible.

Method Summary

Methods

Modifier and Type	Method and Description
RemoteManager	getInstance(String name)
<T> RemoteManager	getInstance(String name, Codec<T> codec, EventHandler<Throwable> errorHandler)
<T> RemoteManager	getInstance(String name, int listeningPort, Codec<T> codec, EventHandler<Throwable> errorHandler)
<T> RemoteManager	getInstance(String name, String hostAddress, int listeningPort, Codec<T> codec, EventHandler<Throwable> errorHandler, boolean orderingGuarantee, int numberOfTries, int retryTimeout) The old constructor of DefaultRemoteManagerImplementation.
<T> RemoteManager	getInstance(String name, String hostAddress, int listeningPort, Codec<T> codec, EventHandler<Throwable> errorHandler, boolean orderingGuarantee, int numberOfTries, int retryTimeout, LocalAddressProvider localAddressProvider, TcpPortProvider tcpPortProvider) The all-out constructor of DefaultRemoteManagerImplementation.

Method Detail

getInstance

RemoteManager getInstance(String name)

Parameters:

name - the name of used by the returned RemoteManager to determine the address to bind to. to instantiate.

Returns:

a new instance of RemoteManager with all parameters but the given one injected via Tang.

getInstance

<T> RemoteManager getInstance(String name,
                            Codec<T> codec,
                            EventHandler<Throwable> errorHandler)

Type Parameters:

T - the message type sent / received by the returned RemoteManager.

Parameters:

name - the name of the returned RemoteManager to instantiate.

codec - the codec to use to decode the messages sent to / by this RemoteManager.

errorHandler - the error handler invoked for exceptions by the returned RemoteManager.

Returns:

a new instance of RemoteManager with all parameters but the given one injected via Tang.

getInstance

<T> RemoteManager getInstance(String name,
                            int listeningPort,
                            Codec<T> codec,
                            EventHandler<Throwable> errorHandler)

Type Parameters:

T - the message type sent / received by the returned RemoteManager.

Parameters:

name - the name of the returned RemoteManager to instantiate.

listeningPort - the port on which the returned RemoteManager listens.

codec - the codec to use to decode the messages sent to / by this RemoteManager.

errorHandler - the error handler invoked for exceptions by the returned RemoteManager.

Returns:

a new instance of RemoteManager with all parameters but the given one injected via Tang.

getInstance

<T> RemoteManager getInstance(String name,
                            String hostAddress,
                            int listeningPort,
                            Codec<T> codec,
                            EventHandler<Throwable> errorHandler,
                            boolean orderingGuarantee,
                            int numberOfTries,
                            int retryTimeout)

The old constructor of DefaultRemoteManagerImplementation. Avoid if you can.

Type Parameters:

T - the message type sent / received by the returned RemoteManager.

Parameters:

name - the name of the returned RemoteManager to instantiate.

hostAddress - the address the returned RemoteManager binds to.

listeningPort - the port on which the returned RemoteManager listens.

codec - the codec to use to decode the messages sent to / by this RemoteManager.

errorHandler - the error handler invoked for exceptions by the returned RemoteManager.

orderingGuarantee - whether or not the returned RemoteManager should guarantee message orders.

numberOfTries - the number of retries before the returned RemoteManager declares sending a failure.

retryTimeout - the time (in ms) after which the returned RemoteManager considers a sending attempt failed.

Returns:

a new instance of RemoteManager with all parameters but the given one injected via Tang.

getInstance

<T> RemoteManager getInstance(String name,
                            String hostAddress,
                            int listeningPort,
                            Codec<T> codec,
                            EventHandler<Throwable> errorHandler,
                            boolean orderingGuarantee,
                            int numberOfTries,
                            int retryTimeout,
                            LocalAddressProvider localAddressProvider,
                            TcpPortProvider tcpPortProvider)

The all-out constructor of DefaultRemoteManagerImplementation. Avoid if you can.

Type Parameters:

T - the message type sent / received by the returned RemoteManager.

Parameters:

name - the name of the returned RemoteManager to instantiate.

hostAddress - the address the returned RemoteManager binds to.

listeningPort - the port on which the returned RemoteManager listens.

codec - the codec to use to decode the messages sent to / by this RemoteManager.

errorHandler - the error handler invoked for exceptions by the returned RemoteManager.

orderingGuarantee - whether or not the returned RemoteManager should guarantee message orders.

numberOfTries - the number of retries before the returned RemoteManager declares sending a failure.

retryTimeout - the time (in ms) after which the returned RemoteManager considers a sending attempt failed.

localAddressProvider - the LocalAddressProvider used by the returned RemoteManager to determine the address to bind to.

tcpPortProvider - the TcpPortProvider used by the returned RemoteManager to determine the port to listen to.

Returns:

a new instance of RemoteManager with all parameters but the given one injected via Tang.