org.cojen.dirmi.io

Class RecyclableSocketChannelConnector

java.lang.Object

org.cojen.dirmi.io.RecyclableSocketChannelConnector

All Implemented Interfaces:

Closeable, AutoCloseable, ChannelConnector

public class RecyclableSocketChannelConnector
extends Object

Implements a connector using TCP/IP which supports channel recycling. A recycler must be installed on connected channels, and remote endpoint must be using RecyclableSocketChannelAcceptor.

Author:

Brian S O'Neill

Nested Class Summary

Nested classes/interfaces inherited from interface org.cojen.dirmi.io.ChannelConnector

ChannelConnector.Listener

Constructor Summary

Constructors

Constructor and Description
RecyclableSocketChannelConnector(IOExecutor executor, SocketAddress remoteAddress)
RecyclableSocketChannelConnector(IOExecutor executor, SocketAddress remoteAddress, SocketAddress localAddress)
RecyclableSocketChannelConnector(IOExecutor executor, SocketAddress remoteAddress, SocketAddress localAddress, SocketFactory factory)

Method Summary

Modifier and Type	Method and Description
void	close() Prevents new channels from being connected and closes all connected channels.
Channel	connect() Returns a new channel, possibly blocking until it has been established.
void	connect(ChannelConnector.Listener listener) Register a listener which is asynchronously given a connected channel.
Channel	connect(long timeout, TimeUnit unit) Returns a new channel, possibly blocking until it has been established.
Channel	connect(Timer timer) Returns a new channel, possibly blocking until it has been established.
protected IOExecutor	executor()
SocketAddress	getLocalAddress()
SocketAddress	getRemoteAddress()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RecyclableSocketChannelConnector

public RecyclableSocketChannelConnector(IOExecutor executor,
                                        SocketAddress remoteAddress)

Parameters:

remoteAddress - address to connect to

RecyclableSocketChannelConnector

public RecyclableSocketChannelConnector(IOExecutor executor,
                                        SocketAddress remoteAddress,
                                        SocketAddress localAddress)

Parameters:

remoteAddress - address to connect to

localAddress - local address to bind to; pass null for any

RecyclableSocketChannelConnector

public RecyclableSocketChannelConnector(IOExecutor executor,
                                        SocketAddress remoteAddress,
                                        SocketAddress localAddress,
                                        SocketFactory factory)

Parameters:

remoteAddress - address to connect to

localAddress - local address to bind to; pass null for any

Method Detail

connect

public Channel connect()
                throws IOException

Description copied from interface: ChannelConnector

Returns a new channel, possibly blocking until it has been established.

Specified by:

connect in interface ChannelConnector

Throws:

IOException

connect

public Channel connect(long timeout,
                       TimeUnit unit)
                throws IOException

Description copied from interface: ChannelConnector

Returns a new channel, possibly blocking until it has been established.

Specified by:

connect in interface ChannelConnector

Throws:

IOException

connect

public Channel connect(Timer timer)
                throws IOException

Description copied from interface: ChannelConnector

Returns a new channel, possibly blocking until it has been established.

Specified by:

connect in interface ChannelConnector

Throws:

IOException

connect

public void connect(ChannelConnector.Listener listener)

Description copied from interface: ChannelConnector

Register a listener which is asynchronously given a connected channel. Listener is called at most once per registration.

Specified by:

connect in interface ChannelConnector

close

public void close()

Description copied from interface: ChannelConnector

Prevents new channels from being connected and closes all connected channels.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ChannelConnector

toString

public String toString()

Overrides:

toString in class Object

getRemoteAddress

public final SocketAddress getRemoteAddress()

Specified by:

getRemoteAddress in interface ChannelConnector

Returns:

remote address of connected channels or null if unknown

getLocalAddress

public final SocketAddress getLocalAddress()

Specified by:

getLocalAddress in interface ChannelConnector

Returns:

local address of connected channels or null if unknown

executor

protected IOExecutor executor()