org.apache.reef.wake.remote.transport.netty

Class NettyMessagingTransport

java.lang.Object

org.apache.reef.wake.remote.transport.netty.NettyMessagingTransport

All Implemented Interfaces:

AutoCloseable, Transport, Stage

public class NettyMessagingTransport
extends Object
implements Transport

Messaging transport implementation with Netty

Constructor Summary

Constructors

Constructor and Description
NettyMessagingTransport(String hostAddress, int port, EStage<TransportEvent> clientStage, EStage<TransportEvent> serverStage, int numberOfTries, int retryTimeout) Constructs a messaging transport

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes all channels and releases all resources
<T> Link<T>	get(SocketAddress remoteAddr) Returns a link for the remote address if already cached; otherwise, returns null
int	getListeningPort() Gets a server listening port of this transport
SocketAddress	getLocalAddress() Gets a server local socket address of this transport
<T> Link<T>	open(SocketAddress remoteAddr, Encoder<? super T> encoder, LinkListener<? super T> listener) Returns a link for the remote address if cached; otherwise opens, caches and returns When it opens a link for the remote address, only one attempt for the address is made at a given time
void	registerErrorHandler(EventHandler<Exception> handler) Registers the exception event handler

Methods inherited from class java.lang.Object

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

Constructor Detail

NettyMessagingTransport

public NettyMessagingTransport(String hostAddress,
                       int port,
                       EStage<TransportEvent> clientStage,
                       EStage<TransportEvent> serverStage,
                       int numberOfTries,
                       int retryTimeout)

Constructs a messaging transport

Parameters:

hostAddress - the server host address

port - the server listening port; when it is 0, randomly assign a port number

clientStage - the client-side stage that handles transport events

serverStage - the server-side stage that handles transport events

numberOfTries - the number of tries of connection

retryTimeout - the timeout of reconnection

Method Detail

close

public void close()
           throws Exception

Closes all channels and releases all resources

Specified by:

close in interface AutoCloseable

Throws:

Exception

open

public <T> Link<T> open(SocketAddress remoteAddr,
               Encoder<? super T> encoder,
               LinkListener<? super T> listener)
             throws IOException

Returns a link for the remote address if cached; otherwise opens, caches and returns When it opens a link for the remote address, only one attempt for the address is made at a given time

Specified by:

open in interface Transport

Parameters:

remoteAddr - the remote socket address

encoder - the encoder

listener - the link listener

Returns:

a link associated with the address

Throws:

IOException

get

public <T> Link<T> get(SocketAddress remoteAddr)

Returns a link for the remote address if already cached; otherwise, returns null

Specified by:

get in interface Transport

Parameters:

remoteAddr - the remote address

Returns:

a link if already cached; otherwise, null

getLocalAddress

public SocketAddress getLocalAddress()

Gets a server local socket address of this transport

Specified by:

getLocalAddress in interface Transport

Returns:

a server local socket address

getListeningPort

public int getListeningPort()

Gets a server listening port of this transport

Specified by:

getListeningPort in interface Transport

Returns:

a listening port number

registerErrorHandler

public void registerErrorHandler(EventHandler<Exception> handler)

Registers the exception event handler

Specified by:

registerErrorHandler in interface Transport

Parameters:

handler - the exception event handler