Package org.glassfish.grizzly

Class AbstractSocketConnectorHandler

java.lang.Object

org.glassfish.grizzly.AbstractSocketConnectorHandler

All Implemented Interfaces:

ConnectorHandler<SocketAddress>, SocketConnectorHandler

Direct Known Subclasses:

TCPNIOConnectorHandler, UDPNIOConnectorHandler

public abstract class AbstractSocketConnectorHandler
extends Object
implements SocketConnectorHandler

Abstract class simplifies the implementation of SocketConnectorHandler interface by pre-implementing some of its methods.

Author:

Alexey Stashok

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractSocketConnectorHandler.Builder<E extends AbstractSocketConnectorHandler.Builder>	Builder

Field Summary

Fields

Modifier and Type	Field	Description
protected List<ConnectionProbe>	probes
protected Transport	transport

Fields inherited from interface org.glassfish.grizzly.SocketConnectorHandler

DEFAULT_CONNECTION_TIMEOUT

Constructor Summary

Constructors

Constructor	Description
AbstractSocketConnectorHandler(Transport transport)

Method Summary

Modifier and Type	Method	Description
void	addMonitoringProbe(ConnectionProbe probe)	Add the ConnectionProbe, which will be notified about Connection life-cycle events.
GrizzlyFuture<Connection>	connect(String host, int port)	Creates, initializes and connects socket to the specific remote host and port and returns Connection, representing socket.
GrizzlyFuture<Connection>	connect(SocketAddress remoteAddress)	Creates, initializes and establishes Connection to the specific remoteAddress.
GrizzlyFuture<Connection>	connect(SocketAddress remoteAddress, SocketAddress localAddress)	Creates, initializes Connection, binds it to the specific local and remote remoteAddress.
void	connect(SocketAddress remoteAddress, SocketAddress localAddress, CompletionHandler<Connection> completionHandler)	Creates, initializes Connection, binds it to the specific local and remote remoteAddress.
void	connect(SocketAddress remoteAddress, CompletionHandler<Connection> completionHandler)	Creates, initializes and establishes Connection to the specific remoteAddress.
protected abstract FutureImpl<Connection>	connectAsync(SocketAddress remoteAddress, SocketAddress localAddress, CompletionHandler<Connection> completionHandler, boolean needFuture)
ConnectionProbe[]	getMonitoringProbes()	Get the ConnectionProbe, which are registered on the Connection.
Processor	getProcessor()	Get the default Processor to process IOEvent, occurring on connection phase.
ProcessorSelector	getProcessorSelector()	Gets the default ProcessorSelector, which will be used to get Processor to process I/O events, occurring on connection phase.
protected FutureImpl<Connection>	makeCancellableFuture(Connection connection)
protected void	preConfigure(Connection connection)	Pre-configures Connection object before actual connecting phase will be started.
boolean	removeMonitoringProbe(ConnectionProbe probe)	Remove the ConnectionProbe.
void	setProcessor(Processor processor)	Set the default Processor to process IOEvent, occurring on connection phase.
void	setProcessorSelector(ProcessorSelector processorSelector)	Sets the default ProcessorSelector, which will be used to get Processor to process I/O events, occurring on connection phase.

Methods inherited from class java.lang.Object

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

Field Detail

transport

protected final Transport transport

probes

protected final List<ConnectionProbe> probes

Constructor Detail

AbstractSocketConnectorHandler

public AbstractSocketConnectorHandler(Transport transport)

Method Detail

connect

public GrizzlyFuture<Connection> connect(String host,
                                         int port)

Description copied from interface: SocketConnectorHandler

Creates, initializes and connects socket to the specific remote host and port and returns Connection, representing socket.

Specified by:

connect in interface SocketConnectorHandler

Parameters:

host - remote host to connect to.

port - remote port to connect to.

Returns:

Future of connect operation, which could be used to get resulting Connection.

connect

public GrizzlyFuture<Connection> connect(SocketAddress remoteAddress)

Description copied from interface: ConnectorHandler

Creates, initializes and establishes Connection to the specific remoteAddress.

Specified by:

connect in interface ConnectorHandler<SocketAddress>

Parameters:

remoteAddress - remote address to connect to

Returns:

Future of connect operation, which could be used to get resulting Connection

connect

public void connect(SocketAddress remoteAddress,
                    CompletionHandler<Connection> completionHandler)

Description copied from interface: ConnectorHandler

Creates, initializes and establishes Connection to the specific remoteAddress.

Specified by:

connect in interface ConnectorHandler<SocketAddress>

Parameters:

remoteAddress - remote address to connect to

completionHandler - CompletionHandler

connect

public GrizzlyFuture<Connection> connect(SocketAddress remoteAddress,
                                         SocketAddress localAddress)

Description copied from interface: ConnectorHandler

Creates, initializes Connection, binds it to the specific local and remote remoteAddress.

Specified by:

connect in interface ConnectorHandler<SocketAddress>

Parameters:

remoteAddress - remote address to connect to

localAddress - local address to bind a Connection to

Returns:

Future of connect operation, which could be used to get resulting Connection

connect

public void connect(SocketAddress remoteAddress,
                    SocketAddress localAddress,
                    CompletionHandler<Connection> completionHandler)

Description copied from interface: ConnectorHandler

Creates, initializes Connection, binds it to the specific local and remote remoteAddress.

Specified by:

connect in interface ConnectorHandler<SocketAddress>

Parameters:

remoteAddress - remote address to connect to

localAddress - local address to bind a Connection to

completionHandler - CompletionHandler

connectAsync

protected abstract FutureImpl<Connection> connectAsync(SocketAddress remoteAddress,
                                                       SocketAddress localAddress,
                                                       CompletionHandler<Connection> completionHandler,
                                                       boolean needFuture)

getProcessor

public Processor getProcessor()

Get the default Processor to process IOEvent, occurring on connection phase.

Returns:

the default Processor to process IOEvent, occurring on connection phase.

setProcessor

public void setProcessor(Processor processor)

Set the default Processor to process IOEvent, occurring on connection phase.

Parameters:

processor - the default Processor to process IOEvent, occurring on connection phase.

getProcessorSelector

public ProcessorSelector getProcessorSelector()

Gets the default ProcessorSelector, which will be used to get Processor to process I/O events, occurring on connection phase.

Returns:

the default ProcessorSelector, which will be used to get Processor to process I/O events, occurring on connection phase.

setProcessorSelector

public void setProcessorSelector(ProcessorSelector processorSelector)

Sets the default ProcessorSelector, which will be used to get Processor to process I/O events, occurring on connection phase.

Parameters:

processorSelector - the default ProcessorSelector, which will be used to get Processor to process I/O events, occurring on connection phase.

addMonitoringProbe

public void addMonitoringProbe(ConnectionProbe probe)

Add the ConnectionProbe, which will be notified about Connection life-cycle events.

Parameters:

probe - the ConnectionProbe.

removeMonitoringProbe

public boolean removeMonitoringProbe(ConnectionProbe probe)

Remove the ConnectionProbe.

Parameters:

probe - the ConnectionProbe.

Returns:

true if probe was in the list and is now removed

getMonitoringProbes

public ConnectionProbe[] getMonitoringProbes()

Get the ConnectionProbe, which are registered on the Connection. Please note, it's not appropriate to modify the returned array's content. Please use addMonitoringProbe(org.glassfish.grizzly.ConnectionProbe) and removeMonitoringProbe(org.glassfish.grizzly.ConnectionProbe) instead.

Returns:

the ConnectionProbe, which are registered on the Connection.

preConfigure

protected void preConfigure(Connection connection)

Pre-configures Connection object before actual connecting phase will be started.

Parameters:

connection - Connection to pre-configure.

makeCancellableFuture

protected FutureImpl<Connection> makeCancellableFuture(Connection connection)