org.glassfish.grizzly.nio

Class NIOTransport

java.lang.Object

org.glassfish.grizzly.AbstractTransport

org.glassfish.grizzly.nio.NIOTransport

All Implemented Interfaces:

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

Direct Known Subclasses:

TCPNIOTransport, UDPNIOTransport

public abstract class NIOTransport
extends AbstractTransport
implements SocketBinder, SocketConnectorHandler, TemporarySelectorsEnabledTransport, AsyncQueueEnabledTransport

Author:

oleksiys

Nested Class Summary

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

Transport.State

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CLIENT_SOCKET_SO_TIMEOUT
static int	DEFAULT_CONNECTION_TIMEOUT
static boolean	DEFAULT_OPTIMIZED_FOR_MULTIPLEXING
static boolean	DEFAULT_REUSE_ADDRESS
static int	DEFAULT_SELECTOR_RUNNER_COUNT
static int	DEFAULT_SERVER_SOCKET_SO_TIMEOUT
protected NIOChannelDistributor	nioChannelDistributor
protected SelectionKeyHandler	selectionKeyHandler
protected SelectorHandler	selectorHandler
protected SelectorProvider	selectorProvider
protected SelectorRunner[]	selectorRunners
protected FutureImpl<Transport>	shutdownFuture Future to control graceful shutdown status
protected Set<GracefulShutdownListener>	shutdownListeners
protected ExecutorService	shutdownService ExecutorService hosting shutdown listener threads.
protected TemporarySelectorIO	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 and Description
NIOTransport(String name)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addShutdownListener(GracefulShutdownListener shutdownListener) Adds a GracefulShutdownListener which will be called when Transport.shutdown() is called to enable graceful shutdown of transports.
protected abstract void	closeConnection(Connection connection) Close the connection, managed by Transport
protected void	configureNIOConnection(NIOConnection connection)
protected ExecutorService	createShutdownExecutorService()
protected abstract TemporarySelectorIO	createTemporarySelectorIO()
protected void	finalizeShutdown()
int	getClientSocketSoTimeout()
int	getConnectionTimeout()
protected int	getDefaultSelectorRunnersCount()
NIOChannelDistributor	getNIOChannelDistributor()
SelectionKeyHandler	getSelectionKeyHandler()
SelectorHandler	getSelectorHandler()
SelectorProvider	getSelectorProvider() Get the SelectorProvider to be used by this transport.
protected SelectorRunner[]	getSelectorRunners()
int	getSelectorRunnersCount()
int	getServerSocketSoTimeout()
TemporarySelectorIO	getTemporarySelectorIO()
boolean	isOptimizedForMultiplexing() Returns true, if NIOTransport is configured to use AsyncQueueWriter, optimized to be used in connection multiplexing mode, or false otherwise.
boolean	isReuseAddress()
protected abstract void	listen()
protected static void	notifyProbesError(NIOTransport transport, Throwable error) Notify registered TransportProbes about the error.
protected static void	notifyProbesPause(NIOTransport transport) Notify registered TransportProbes about the pause event.
protected static void	notifyProbesResume(NIOTransport transport) Notify registered TransportProbes about the resume event.
protected static void	notifyProbesStart(NIOTransport transport) Notify registered TransportProbes about the start event.
protected static void	notifyProbesStop(NIOTransport transport) Notify registered TransportProbes about the stop event.
void	notifyTransportError(Throwable error) Method gets invoked, when error occur during the Transport lifecycle.
void	pause() Pause UDPNIOTransport, so I/O events coming on its UDPNIOConnections will not be processed.
void	resume() Resume UDPNIOTransport, which has been paused before using pause().
void	setClientSocketSoTimeout(int socketTimeout)
void	setConnectionTimeout(int connectionTimeout)
void	setNIOChannelDistributor(NIOChannelDistributor nioChannelDistributor)
void	setOptimizedForMultiplexing(boolean optimizedForMultiplexing) Configures NIOTransport to be optimized for specific for the connection multiplexing usecase, when different threads will try to write data simultaneously.
void	setReuseAddress(boolean reuseAddress)
void	setSelectionKeyHandler(SelectionKeyHandler selectionKeyHandler)
void	setSelectorHandler(SelectorHandler selectorHandler)
void	setSelectorProvider(SelectorProvider selectorProvider) Set the SelectorProvider to be used by this transport.
void	setSelectorRunnersCount(int selectorRunnersCount)
void	setServerSocketSoTimeout(int serverSocketSoTimeout)
GrizzlyFuture<Transport>	shutdown() Gracefully stops the transport accepting new connections and allows existing work to complete before finalizing the shutdown.
GrizzlyFuture<Transport>	shutdown(long gracePeriod, TimeUnit timeUnit) Gracefully stops the transport accepting new connections and allows existing work to complete before finalizing the shutdown.
void	shutdownNow() Forcibly stops the transport and closes all connections.
void	start() Start TCPNIOTransport.
protected void	startSelectorRunners()
protected void	stopSelectorRunners()
abstract void	unbindAll() Unbinds all bound Transport connections.

Methods inherited from class org.glassfish.grizzly.AbstractTransport

configureBlocking, createJmxManagementObject, 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

Methods inherited from interface org.glassfish.grizzly.SocketBinder

bind, bind, bind, bind, bind, bind, bindToInherited, unbind

Methods inherited from interface org.glassfish.grizzly.SocketConnectorHandler

connect

Methods inherited from interface org.glassfish.grizzly.ConnectorHandler

connect, connect, connect, connect

Methods inherited from interface org.glassfish.grizzly.asyncqueue.AsyncQueueEnabledTransport

getAsyncQueueIO

Methods inherited from interface org.glassfish.grizzly.Transport

configureStandalone, fireIOEvent, getReader, getReader, getWriter, getWriter

Field Detail

DEFAULT_SERVER_SOCKET_SO_TIMEOUT

public static final int DEFAULT_SERVER_SOCKET_SO_TIMEOUT

See Also:

Constant Field Values

DEFAULT_REUSE_ADDRESS

public static final boolean DEFAULT_REUSE_ADDRESS

See Also:

Constant Field Values

DEFAULT_CLIENT_SOCKET_SO_TIMEOUT

public static final int DEFAULT_CLIENT_SOCKET_SO_TIMEOUT

See Also:

Constant Field Values

DEFAULT_CONNECTION_TIMEOUT

public static final int DEFAULT_CONNECTION_TIMEOUT

See Also:

Constant Field Values

DEFAULT_SELECTOR_RUNNER_COUNT

public static final int DEFAULT_SELECTOR_RUNNER_COUNT

See Also:

Constant Field Values

DEFAULT_OPTIMIZED_FOR_MULTIPLEXING

public static final boolean DEFAULT_OPTIMIZED_FOR_MULTIPLEXING

See Also:

Constant Field Values

selectorHandler

protected SelectorHandler selectorHandler

selectionKeyHandler

protected SelectionKeyHandler selectionKeyHandler

selectorRunners

protected SelectorRunner[] selectorRunners

nioChannelDistributor

protected NIOChannelDistributor nioChannelDistributor

selectorProvider

protected SelectorProvider selectorProvider

temporarySelectorIO

protected final TemporarySelectorIO temporarySelectorIO

shutdownListeners

protected Set<GracefulShutdownListener> shutdownListeners

shutdownFuture

protected FutureImpl<Transport> shutdownFuture

Future to control graceful shutdown status

shutdownService

protected ExecutorService shutdownService

ExecutorService hosting shutdown listener threads.

Constructor Detail

NIOTransport

public NIOTransport(String name)

Method Detail

unbindAll

public abstract void unbindAll()

Description copied from interface: SocketBinder

Unbinds all bound Transport connections.

Specified by:

unbindAll in interface SocketBinder

addShutdownListener

public boolean addShutdownListener(GracefulShutdownListener shutdownListener)

Description copied from interface: Transport

Adds a GracefulShutdownListener which will be called when Transport.shutdown() is called to enable graceful shutdown of transports. This allows the owner of the listener to signal that all shutdown tasks are complete and that it's safe to finalize the termination of the transport

Specified by:

addShutdownListener in interface Transport

Parameters:

shutdownListener - the GracefulShutdownListener

Returns:

true if the listener was successfully registered, otherwise false. When this method returns false it means one of two things: the transport is stopping or is stopped, or the listener has already been registered.

getTemporarySelectorIO

public TemporarySelectorIO getTemporarySelectorIO()

Specified by:

getTemporarySelectorIO in interface TemporarySelectorsEnabledTransport

getSelectionKeyHandler

public SelectionKeyHandler getSelectionKeyHandler()

setSelectionKeyHandler

public void setSelectionKeyHandler(SelectionKeyHandler selectionKeyHandler)

getSelectorHandler

public SelectorHandler getSelectorHandler()

setSelectorHandler

public void setSelectorHandler(SelectorHandler selectorHandler)

getSelectorRunnersCount

public int getSelectorRunnersCount()

setSelectorRunnersCount

public void setSelectorRunnersCount(int selectorRunnersCount)

getSelectorProvider

public SelectorProvider getSelectorProvider()

Get the SelectorProvider to be used by this transport.

Returns:

the SelectorProvider to be used by this transport.

setSelectorProvider

public void setSelectorProvider(SelectorProvider selectorProvider)

Set the SelectorProvider to be used by this transport.

Parameters:

selectorProvider - the SelectorProvider.

isOptimizedForMultiplexing

public boolean isOptimizedForMultiplexing()

Returns true, if NIOTransport is configured to use AsyncQueueWriter, optimized to be used in connection multiplexing mode, or false otherwise.

Returns:

true, if NIOTransport is configured to use AsyncQueueWriter, optimized to be used in connection multiplexing mode, or false otherwise.

setOptimizedForMultiplexing

public void setOptimizedForMultiplexing(boolean optimizedForMultiplexing)

Configures NIOTransport to be optimized for specific for the connection multiplexing usecase, when different threads will try to write data simultaneously.

startSelectorRunners

protected void startSelectorRunners()
                             throws IOException

Throws:

IOException

stopSelectorRunners

protected void stopSelectorRunners()

getNIOChannelDistributor

public NIOChannelDistributor getNIOChannelDistributor()

setNIOChannelDistributor

public void setNIOChannelDistributor(NIOChannelDistributor nioChannelDistributor)

notifyTransportError

public void notifyTransportError(Throwable error)

Method gets invoked, when error occur during the Transport lifecycle.

Specified by:

notifyTransportError in interface Transport

Parameters:

error - Throwable.

getSelectorRunners

protected SelectorRunner[] getSelectorRunners()

notifyProbesError

protected static void notifyProbesError(NIOTransport transport,
                     Throwable error)

Notify registered TransportProbes about the error.

Parameters:

transport - the Transport event occurred on.

notifyProbesStart

protected static void notifyProbesStart(NIOTransport transport)

Notify registered TransportProbes about the start event.

Parameters:

transport - the Transport event occurred on.

notifyProbesStop

protected static void notifyProbesStop(NIOTransport transport)

Notify registered TransportProbes about the stop event.

Parameters:

transport - the Transport event occurred on.

notifyProbesPause

protected static void notifyProbesPause(NIOTransport transport)

Notify registered TransportProbes about the pause event.

Parameters:

transport - the Transport event occurred on.

notifyProbesResume

protected static void notifyProbesResume(NIOTransport transport)

Notify registered TransportProbes about the resume event.

Parameters:

transport - the Transport event occurred on.

start

public void start()
           throws IOException

Start TCPNIOTransport.

The transport will be started only if its current state is State#STOPPED, otherwise the call will be ignored without exception thrown and the transport state will remain the same as it was before the method call.

Specified by:

start in interface Transport

Throws:

IOException

shutdown

public GrizzlyFuture<Transport> shutdown()

Description copied from interface: Transport

Gracefully stops the transport accepting new connections and allows existing work to complete before finalizing the shutdown. This method will wait indefinitely for all interested parties to signal it is safe to terminate the transport. Invoke Transport.shutdownNow() to terminate the transport if the graceful shutdown is taking too long.

Specified by:

shutdown in interface Transport

Returns:

a GrizzlyFuture which will return the stopped transport.

See Also:

GracefulShutdownListener

shutdown

public GrizzlyFuture<Transport> shutdown(long gracePeriod,
                                TimeUnit timeUnit)

Gracefully stops the transport accepting new connections and allows existing work to complete before finalizing the shutdown. This method will wait for the specified time for all interested parties to signal it is safe to terminate the transport. If the timeout is exceeded, the transport will be terminated forcefully.

Specified by:

shutdown in interface Transport

Parameters:

gracePeriod - the grace period for a graceful shutdown before the transport is forcibly terminated. If gracePeriod is zero or less, then there is no time limit for the shutdown.

timeUnit - the TimeUnit of the specified grace period.

Returns:

a GrizzlyFuture which will return the stopped transport.

shutdownNow

public void shutdownNow()
                 throws IOException

Forcibly stops the transport and closes all connections.

Specified by:

shutdownNow in interface Transport

Throws:

IOException

closeConnection

protected abstract void closeConnection(Connection connection)
                                 throws IOException

Description copied from class: AbstractTransport

Close the connection, managed by Transport

Specified by:

closeConnection in class AbstractTransport

Throws:

IOException

createTemporarySelectorIO

protected abstract TemporarySelectorIO createTemporarySelectorIO()

listen

protected abstract void listen()

getDefaultSelectorRunnersCount

protected int getDefaultSelectorRunnersCount()

finalizeShutdown

protected void finalizeShutdown()

pause

public void pause()

Pause UDPNIOTransport, so I/O events coming on its UDPNIOConnections will not be processed. Use resume() in order to resume UDPNIOTransport processing. The transport will be paused only if its current state is Transport.State.STARTED, otherwise the call will be ignored without exception thrown and the transport state will remain the same as it was before the method call.

Specified by:

pause in interface Transport

resume

public void resume()

Resume UDPNIOTransport, which has been paused before using pause(). The transport will be resumed only if its current state is Transport.State.PAUSED, otherwise the call will be ignored without exception thrown and the transport state will remain the same as it was before the method call.

Specified by:

resume in interface Transport

configureNIOConnection

protected void configureNIOConnection(NIOConnection connection)

isReuseAddress

public boolean isReuseAddress()

setReuseAddress

public void setReuseAddress(boolean reuseAddress)

getClientSocketSoTimeout

public int getClientSocketSoTimeout()

setClientSocketSoTimeout

public void setClientSocketSoTimeout(int socketTimeout)

getConnectionTimeout

public int getConnectionTimeout()

setConnectionTimeout

public void setConnectionTimeout(int connectionTimeout)

getServerSocketSoTimeout

public int getServerSocketSoTimeout()

setServerSocketSoTimeout

public void setServerSocketSoTimeout(int serverSocketSoTimeout)

createShutdownExecutorService

protected ExecutorService createShutdownExecutorService()