org.apache.reef.io.network

Interface NetworkConnectionService

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

NetworkConnectionServiceImpl

@DefaultImplementation(value=NetworkConnectionServiceImpl.class)
public interface NetworkConnectionService
extends AutoCloseable

NetworkConnectionService.

NetworkConnectionService is a service which is designed for communicating messages with each other. It creates multiple ConnectionFactories, which create multiple connections.

Flow of message transfer:

• [Downstream]: connection.write(message) -> ConnectionFactory -> src NetworkConnectionService (encode) -> dest NetworkConnectionService.
• [Upstream]: message -> dest NetworkConnectionService (decode) -> ConnectionFactory -> EventHandler.

Users can register a ConnectionFactory by registering their Codec, EventHandler, LinkListener and end point id. When users send messages via connections created by the ConnectionFactory,

NetworkConnectionService encodes the messages according to the Codec registered in the ConnectionFactory and sends them to the destination NetworkConnectionService.

Also, it receives the messages by decoding the messages and forwarding them to the corresponding EventHandler registered in the ConnectionFactory.

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 connectionFactoryId) Gets an instance of ConnectionFactory which is registered by the registerConnectionFactory method.
<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 connectionFactoryId) Unregisters a connectionFactory corresponding to the connectionFactoryId and removes the localEndPointID of the connection factory from NameServer.

Method Detail

registerConnectionFactory

<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. 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.

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

void unregisterConnectionFactory(Identifier connectionFactoryId)

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

Parameters:

connectionFactoryId - a connection factory id

getConnectionFactory

<T> ConnectionFactory<T> getConnectionFactory(Identifier connectionFactoryId)

Gets an instance of ConnectionFactory which is registered by the registerConnectionFactory method.

Parameters:

connectionFactoryId - a connection factory id

close

void close()
           throws Exception

Closes all resources and unregisters all registered connection factories.

Specified by:

close in interface AutoCloseable

Throws:

Exception - if this resource cannot be closed