Module org.glassfish.grizzly

Package org.glassfish.grizzly.nio.transport

Class TCPNIOTransport

java.lang.Object

org.glassfish.grizzly.AbstractTransport

org.glassfish.grizzly.nio.NIOTransport

org.glassfish.grizzly.nio.transport.TCPNIOTransport

All Implemented Interfaces:

AsyncQueueEnabledTransport, ConnectorHandler<SocketAddress>, FilterChainEnabledTransport, MonitoringAware<TransportProbe>, TemporarySelectorsEnabledTransport, SocketBinder, SocketConnectorHandler, Transport

public final class TCPNIOTransport
extends NIOTransport
implements AsyncQueueEnabledTransport, FilterChainEnabledTransport, TemporarySelectorsEnabledTransport

TCP Transport NIO implementation

Author:

Alexey Stashok, Jean-Francois Arcand

Nested Class Summary

Nested classes/interfaces inherited from interface org.glassfish.grizzly.Transport

Transport.State

Field Summary

Fields

Modifier and Type	Field	Description
static final ChannelConfigurator	DEFAULT_CHANNEL_CONFIGURATOR	Default ChannelConfigurator used to configure client and server side channels.
static final boolean	DEFAULT_KEEP_ALIVE
static final int	DEFAULT_LINGER
static final int	DEFAULT_SERVER_CONNECTION_BACKLOG
static final boolean	DEFAULT_TCP_NO_DELAY
static final int	MAX_RECEIVE_BUFFER_SIZE
static final int	MAX_SEND_BUFFER_SIZE

Fields inherited from class org.glassfish.grizzly.nio.NIOTransport

channelConfigurator, DEFAULT_CLIENT_SOCKET_SO_TIMEOUT, DEFAULT_CONNECTION_TIMEOUT, DEFAULT_OPTIMIZED_FOR_MULTIPLEXING, DEFAULT_REUSE_ADDRESS, DEFAULT_SELECTOR_RUNNER_COUNT, DEFAULT_SERVER_SOCKET_SO_TIMEOUT, nioChannelDistributor, selectionKeyHandler, selectorHandler, selectorProvider, selectorRunners, shutdownFuture, shutdownListeners, shutdownService, temporarySelectorIO

Fields inherited from class org.glassfish.grizzly.AbstractTransport

attributeBuilder, connectionMonitoringConfig, isBlocking, isStandalone, kernelPool, kernelPoolConfig, managedWorkerPool, memoryManager, name, processor, processorSelector, readBufferSize, readTimeout, state, strategy, threadPoolMonitoringConfig, transportMonitoringConfig, workerPoolConfig, workerThreadPool, writeBufferSize, writeTimeout

Fields inherited from interface org.glassfish.grizzly.Transport

DEFAULT_READ_BUFFER_SIZE, DEFAULT_READ_TIMEOUT, DEFAULT_WRITE_BUFFER_SIZE, DEFAULT_WRITE_TIMEOUT

Constructor Summary

Constructors

Constructor	Description
TCPNIOTransport()

Method Summary

Modifier and Type	Method	Description
TCPNIOServerConnection	bind(int port)	Binds Transport to the specific port on localhost.
TCPNIOServerConnection	bind(String host, int port)	Binds Transport to the specific host and port.
TCPNIOServerConnection	bind(String host, int port, int backlog)	Binds Transport to the specific host and port.
TCPNIOServerConnection	bind(String host, PortRange portRange, boolean randomStartPort, int backlog)	Binds Transport to the specific host, and port within a PortRange.
TCPNIOServerConnection	bind(String host, PortRange portRange, int backlog)	Binds Transport to the specific host, and port within a PortRange.
TCPNIOServerConnection	bind(SocketAddress socketAddress)	Binds Transport to the specific SocketAddress.
TCPNIOServerConnection	bind(SocketAddress socketAddress, int backlog)	Binds Transport to the specific SocketAddress.
TCPNIOServerConnection	bindToInherited()	Binds the Transport to the channel inherited from the entity that created this Java virtual machine.
protected void	closeConnection(Connection connection)	Close the connection, managed by Transport
void	configureStandalone(boolean isStandalone)
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 connects socket to the specific SocketAddress and returns Connection, representing socket.
GrizzlyFuture<Connection>	connect(SocketAddress remoteAddress, SocketAddress localAddress)	Creates, initializes socket, binds it to the specific local and remote SocketAddress and returns Connection, representing socket.
void	connect(SocketAddress remoteAddress, SocketAddress localAddress, CompletionHandler<Connection> completionHandler)	Creates, initializes socket, binds it to the specific local and remote SocketAddress and returns Connection, representing socket.
void	connect(SocketAddress remoteAddress, CompletionHandler<Connection> completionHandler)	Creates, initializes and connects socket to the specific SocketAddress and returns Connection, representing socket.
protected Object	createJmxManagementObject()	Create the Transport JMX management object.
protected TemporarySelectorIO	createTemporarySelectorIO()
void	fireIOEvent(IOEvent ioEvent, Connection connection, IOEventLifeCycleListener listener)	Fires specific IOEvent on the Connection
AsyncQueueIO<SocketAddress>	getAsyncQueueIO()	Get asynchronous queue implementation.
ChannelConfigurator	getChannelConfigurator()
protected int	getDefaultSelectorRunnersCount()
int	getLinger()
Reader<SocketAddress>	getReader(boolean isBlocking)	Get the Reader implementation, depending on the requested mode.
Reader<SocketAddress>	getReader(Connection connection)	Get the Reader to read data from the Connection.
int	getServerConnectionBackLog()	Get the default server connection backlog size.
TemporarySelectorIO	getTemporarySelectorIO()
Filter	getTransportFilter()	Get transport Filter, which is aware of Transport specifics; knows how to read/write from/to Transport specific Connection streams.
Writer<SocketAddress>	getWriter(boolean isBlocking)	Get the Writer implementation, depending on the requested mode.
Writer<SocketAddress>	getWriter(Connection connection)	Get the Writer to write data to the Connection.
boolean	isKeepAlive()
boolean	isTcpNoDelay()
protected void	listen()
Buffer	read(Connection connection, Buffer buffer)
void	setKeepAlive(boolean isKeepAlive)
void	setLinger(int linger)
void	setServerConnectionBackLog(int serverConnectionBackLog)	Set the default server connection backlog size.
void	setTcpNoDelay(boolean tcpNoDelay)
void	unbind(Connection connection)	Unbinds bound Transport connection.
void	unbindAll()	Unbinds all bound Transport connections.
int	write(TCPNIOConnection connection, WritableMessage message)
int	write(TCPNIOConnection connection, WritableMessage message, WriteResult currentResult)

Methods inherited from class org.glassfish.grizzly.nio.NIOTransport

addShutdownListener, configureNIOConnection, createShutdownExecutorService, finalizeShutdown, getClientSocketSoTimeout, getConnectionTimeout, getNIOChannelDistributor, getSelectionKeyHandler, getSelectorHandler, getSelectorProvider, getSelectorRunners, getSelectorRunnersCount, getServerSocketSoTimeout, isOptimizedForMultiplexing, isReuseAddress, notifyProbesError, notifyProbesPause, notifyProbesResume, notifyProbesStart, notifyProbesStop, notifyTransportError, pause, resume, setChannelConfigurator, setClientSocketSoTimeout, setConnectionTimeout, setNIOChannelDistributor, setOptimizedForMultiplexing, setReuseAddress, setSelectionKeyHandler, setSelectorHandler, setSelectorProvider, setSelectorRunnersCount, setServerSocketSoTimeout, shutdown, shutdown, shutdownNow, start, startSelectorRunners, stopSelectorRunners

Methods inherited from class org.glassfish.grizzly.AbstractTransport

configureBlocking, getAttributeBuilder, getConnectionMonitoringConfig, getIOStrategy, getKernelThreadPool, getKernelThreadPoolConfig, getMemoryManager, getMonitoringConfig, getName, getProcessor, getProcessorSelector, getReadBufferSize, getReadTimeout, getState, getThreadPoolMonitoringConfig, getWorkerThreadPool, getWorkerThreadPoolConfig, getWriteBufferSize, getWriteTimeout, isBlocking, isPaused, isStandalone, isStopped, notifyProbesBeforePause, notifyProbesBeforeResume, notifyProbesBeforeStart, notifyProbesBeforeStop, notifyProbesConfigChanged, notifyProbesPause, notifyProbesStop, obtainProcessor, setAttributeBuilder, setIOStrategy, setKernelPool0, setKernelThreadPool, setKernelThreadPoolConfig, setMemoryManager, setName, setProcessor, setProcessorSelector, setReadBufferSize, setReadTimeout, setWorkerThreadPool, setWorkerThreadPool0, setWorkerThreadPoolConfig, setWriteBufferSize, setWriteTimeout, stop

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_CHANNEL_CONFIGURATOR

public static final ChannelConfigurator DEFAULT_CHANNEL_CONFIGURATOR

Default ChannelConfigurator used to configure client and server side channels.

MAX_RECEIVE_BUFFER_SIZE

public static final int MAX_RECEIVE_BUFFER_SIZE

MAX_SEND_BUFFER_SIZE

public static final int MAX_SEND_BUFFER_SIZE

DEFAULT_TCP_NO_DELAY

public static final boolean DEFAULT_TCP_NO_DELAY

See Also:

• Constant Field Values

DEFAULT_KEEP_ALIVE

public static final boolean DEFAULT_KEEP_ALIVE

See Also:

• Constant Field Values

DEFAULT_LINGER

public static final int DEFAULT_LINGER

See Also:

• Constant Field Values

DEFAULT_SERVER_CONNECTION_BACKLOG

public static final int DEFAULT_SERVER_CONNECTION_BACKLOG

See Also:

• Constant Field Values

Constructor Details

TCPNIOTransport

public TCPNIOTransport()

Method Details

createTemporarySelectorIO

protected TemporarySelectorIO createTemporarySelectorIO()

Specified by:

createTemporarySelectorIO in class NIOTransport

listen

protected void listen()

Specified by:

listen in class NIOTransport

getDefaultSelectorRunnersCount

protected int getDefaultSelectorRunnersCount()

Overrides:

getDefaultSelectorRunnersCount in class NIOTransport

bind

public TCPNIOServerConnection bind(int port)
                            throws IOException

Binds Transport to the specific port on localhost.

Specified by:

bind in interface SocketBinder

Parameters:

port - the port to bind to

Returns:

bound Connection

Throws:

IOException - if unable to bind i.e. if port already bound

bind

public TCPNIOServerConnection bind(String host,
 int port)
                            throws IOException

Binds Transport to the specific host and port.

Specified by:

bind in interface SocketBinder

Parameters:

host - the local host the server will bind to

port - specific port to bind to

Returns:

bound Connection

Throws:

IOException - if unable to bind i.e. if port already bound

bind

public TCPNIOServerConnection bind(String host,
 int port,
 int backlog)
                            throws IOException

Binds Transport to the specific host and port.

Specified by:

bind in interface SocketBinder

Parameters:

host - the local host the server will bind to

port - the port to bind to

backlog - the maximum length of the queue

Returns:

bound Connection

Throws:

IOException - if unable to bind i.e. if port already bound

bind

public TCPNIOServerConnection bind(SocketAddress socketAddress)
                            throws IOException

Binds Transport to the specific SocketAddress.

Specified by:

bind in interface SocketBinder

Parameters:

socketAddress - the local address the server will bind to

Returns:

bound Connection

Throws:

IOException - if unable to bind i.e. if port already bound

bind

public TCPNIOServerConnection bind(SocketAddress socketAddress,
 int backlog)
                            throws IOException

Binds Transport to the specific SocketAddress.

Specified by:

bind in interface SocketBinder

Parameters:

socketAddress - the local address the server will bind to

backlog - the maximum length of the queue

Returns:

bound Connection

Throws:

IOException - if unable to bind i.e. if port already bound

bindToInherited

public TCPNIOServerConnection bindToInherited()
                                       throws IOException

Binds the Transport to the channel inherited from the entity that created this Java virtual machine.

Specified by:

bindToInherited in interface SocketBinder

Returns:

bound Connection

Throws:

IOException - if unable to bind i.e. if port already bound

bind

public TCPNIOServerConnection bind(String host,
 PortRange portRange,
 int backlog)
                            throws IOException

Binds Transport to the specific host, and port within a PortRange.

Specified by:

bind in interface SocketBinder

Parameters:

host - the local host the server will bind to

portRange - PortRange.

backlog - the maximum length of the queue

Returns:

bound Connection

Throws:

IOException - if unable to bind i.e. if port already bound

bind

public TCPNIOServerConnection bind(String host,
 PortRange portRange,
 boolean randomStartPort,
 int backlog)
                            throws IOException

Binds Transport to the specific host, and port within a PortRange.

Specified by:

bind in interface SocketBinder

Parameters:

host - the local host the server will bind to

portRange - PortRange.

randomStartPort - if true, a random port in the range will be used as the initial port.

backlog - the maximum length of the queue

Returns:

bound Connection

Throws:

IOException - if unable to bind i.e. if port already bound

unbind

public void unbind(Connection connection)

Unbinds bound Transport connection.

Specified by:

unbind in interface SocketBinder

Parameters:

connection - Connection

unbindAll

public void unbindAll()

Description copied from interface: SocketBinder

Unbinds all bound Transport connections.

Specified by:

unbindAll in interface SocketBinder

Specified by:

unbindAll in class NIOTransport

connect

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

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:

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

connect

public GrizzlyFuture<Connection> connect(SocketAddress remoteAddress)

Creates, initializes and connects socket to the specific SocketAddress and returns Connection, representing socket.

Specified by:

connect in interface ConnectorHandler<SocketAddress>

Parameters:

remoteAddress - remote address to connect to.

Returns:

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

connect

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

Creates, initializes and connects socket to the specific SocketAddress and returns Connection, representing socket.

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)

Creates, initializes socket, binds it to the specific local and remote SocketAddress and returns Connection, representing socket.

Specified by:

connect in interface ConnectorHandler<SocketAddress>

Parameters:

remoteAddress - remote address to connect to.

localAddress - local address to bind socket to.

Returns:

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

connect

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

Creates, initializes socket, binds it to the specific local and remote SocketAddress and returns Connection, representing socket.

Specified by:

connect in interface ConnectorHandler<SocketAddress>

Parameters:

remoteAddress - remote address to connect to.

localAddress - local address to bind socket to.

completionHandler - CompletionHandler.

closeConnection

protected void closeConnection(Connection connection)
                        throws IOException

Description copied from class: AbstractTransport

Close the connection, managed by Transport

Specified by:

closeConnection in class NIOTransport

Parameters:

connection - NIOConnection to close

Throws:

IOException - not used

getChannelConfigurator

public ChannelConfigurator getChannelConfigurator()

Overrides:

getChannelConfigurator in class NIOTransport

Returns:

the configurator responsible for initial SelectableChannel configuration

getAsyncQueueIO

public AsyncQueueIO<SocketAddress> getAsyncQueueIO()

Description copied from interface: AsyncQueueEnabledTransport

Get asynchronous queue implementation.

Specified by:

getAsyncQueueIO in interface AsyncQueueEnabledTransport

Returns:

asynchronous queue implementation.

configureStandalone

public void configureStandalone(boolean isStandalone)

Specified by:

configureStandalone in interface Transport

getLinger

public int getLinger()

setLinger

public void setLinger(int linger)

isKeepAlive

public boolean isKeepAlive()

setKeepAlive

public void setKeepAlive(boolean isKeepAlive)

isTcpNoDelay

public boolean isTcpNoDelay()

setTcpNoDelay

public void setTcpNoDelay(boolean tcpNoDelay)

getServerConnectionBackLog

public int getServerConnectionBackLog()

Get the default server connection backlog size.

Returns:

the default server connection backlog size.

setServerConnectionBackLog

public void setServerConnectionBackLog(int serverConnectionBackLog)

Set the default server connection backlog size.

Parameters:

serverConnectionBackLog - the default server connection backlog size.

getTransportFilter

public Filter getTransportFilter()

Description copied from interface: FilterChainEnabledTransport

Get transport Filter, which is aware of Transport specifics; knows how to read/write from/to Transport specific Connection streams. Each Transport should provide transport Filter implementation.

Specified by:

getTransportFilter in interface FilterChainEnabledTransport

Returns:

transport Filter, which is aware of Transport specifics; knows how to read/write from/to Transport specific Connections.

getTemporarySelectorIO

public TemporarySelectorIO getTemporarySelectorIO()

Specified by:

getTemporarySelectorIO in interface TemporarySelectorsEnabledTransport

Overrides:

getTemporarySelectorIO in class NIOTransport

fireIOEvent

public void fireIOEvent(IOEvent ioEvent,
 Connection connection,
 IOEventLifeCycleListener listener)

Description copied from interface: Transport

Fires specific IOEvent on the Connection

Specified by:

fireIOEvent in interface Transport

Parameters:

ioEvent - I/O event

connection - Connection, on which we fire the event.

listener - I/O event life-cycle listener.

getReader

public Reader<SocketAddress> getReader(Connection connection)

Get the Reader to read data from the Connection. The Transport may decide to return blocking or non-blocking Reader depending on the Connection settings.

Specified by:

getReader in interface Transport

Parameters:

connection - Connection.

Returns:

Reader.

getReader

public Reader<SocketAddress> getReader(boolean isBlocking)

Get the Reader implementation, depending on the requested mode.

Specified by:

getReader in interface Transport

Parameters:

isBlocking - blocking mode.

Returns:

Reader.

getWriter

public Writer<SocketAddress> getWriter(Connection connection)

Get the Writer to write data to the Connection. The Transport may decide to return blocking or non-blocking Writer depending on the Connection settings.

Specified by:

getWriter in interface Transport

Parameters:

connection - Connection.

Returns:

Writer.

getWriter

public Writer<SocketAddress> getWriter(boolean isBlocking)

Get the Writer implementation, depending on the requested mode.

Specified by:

getWriter in interface Transport

Parameters:

isBlocking - blocking mode.

Returns:

Writer.

read

public Buffer read(Connection connection,
 Buffer buffer)
            throws IOException

Throws:

IOException

write

public int write(TCPNIOConnection connection,
 WritableMessage message)
          throws IOException

Throws:

IOException

write

public int write(TCPNIOConnection connection,
 WritableMessage message,
 WriteResult currentResult)
          throws IOException

Throws:

IOException

createJmxManagementObject

protected Object createJmxManagementObject()

Create the Transport JMX management object.

Specified by:

createJmxManagementObject in class AbstractTransport

Returns:

the Transport JMX management object.