org.apache.reef.io.network.impl

Class NetworkConnectionServiceImpl

java.lang.Object

org.apache.reef.io.network.impl.NetworkConnectionServiceImpl

All Implemented Interfaces:

AutoCloseable, NetworkConnectionService

public final class NetworkConnectionServiceImpl
extends Object
implements NetworkConnectionService

Default Network connection service implementation.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes all resources and unregisters all registered connection factories.
<T> ConnectionFactory<T>	getConnectionFactory(Identifier connFactoryId) Gets a ConnectionFactory.
<T> ConnectionFactory<T>	registerConnectionFactory(Identifier connectionFactoryId, Codec<T> codec, EventHandler<Message<T>> eventHandler, LinkListener<Message<T>> linkListener, Identifier localEndPointId) Registers an instance of ConnectionFactory corresponding to the connectionFactoryId.
void	unregisterConnectionFactory(Identifier connFactoryId) Unregisters a connectionFactory corresponding to the connectionFactoryId and removes the localEndPointID of the connection factory from NameServer.

Methods inherited from class java.lang.Object

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

Method Detail

registerConnectionFactory

public <T> ConnectionFactory<T> registerConnectionFactory(Identifier connectionFactoryId,
                                                 Codec<T> codec,
                                                 EventHandler<Message<T>> eventHandler,
                                                 LinkListener<Message<T>> linkListener,
                                                 Identifier localEndPointId)

Description copied from interface: NetworkConnectionService

Registers an instance of ConnectionFactory corresponding to the connectionFactoryId. Binds Codec, EventHandler, LinkListener and localEndPointId to the ConnectionFactory. ConnectionFactory can create multiple connections between other NetworkConnectionServices. The connectionFactoryId is used to distinguish the type of connection and the localEndPointId is the contact point, which is registered to NameServer through this method.

Specified by:

registerConnectionFactory in interface NetworkConnectionService

Parameters:

connectionFactoryId - a connection factory id

codec - a codec for type T

eventHandler - an event handler for type T

linkListener - a link listener

localEndPointId - a local end point id

Returns:

the registered connection factory

unregisterConnectionFactory

public void unregisterConnectionFactory(Identifier connFactoryId)

Description copied from interface: NetworkConnectionService

Unregisters a connectionFactory corresponding to the connectionFactoryId and removes the localEndPointID of the connection factory from NameServer.

Specified by:

unregisterConnectionFactory in interface NetworkConnectionService

Parameters:

connFactoryId - a connection factory id

getConnectionFactory

public <T> ConnectionFactory<T> getConnectionFactory(Identifier connFactoryId)

Gets a ConnectionFactory.

Specified by:

getConnectionFactory in interface NetworkConnectionService

Parameters:

connFactoryId - the identifier of the ConnectionFactory

close

public void close()
           throws Exception

Description copied from interface: NetworkConnectionService

Closes all resources and unregisters all registered connection factories.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface NetworkConnectionService

Throws:

Exception - if this resource cannot be closed