Grizzly NIO 5.0.2 · org.glassfish.grizzly.nio.NIOTransport

Modifier and Type	Field and Description
protected ChannelConfigurator	channelConfigurator
pack-priv int	clientSocketSoTimeout The socket time out
pack-priv int	connectionTimeout Default channel connection timeout
public static final int	DEFAULT_CLIENT_SOCKET_SO_TIMEOUT
public static final int	DEFAULT_CONNECTION_TIMEOUT Hides org.glassfish.grizzly.SocketConnectorHandler.DEFAULT_CONNECTION_TIMEOUT.
public static final boolean	DEFAULT_OPTIMIZED_FOR_MULTIPLEXING
public static final boolean	DEFAULT_REUSE_ADDRESS
public static final boolean	DEFAULT_REUSE_PORT
public static final int	DEFAULT_SELECTOR_RUNNER_COUNT
public static final int	DEFAULT_SERVER_SOCKET_SO_TIMEOUT
private static final Logger	LOGGER
protected NIOChannelDistributor	nioChannelDistributor
private boolean	optimizedForMultiplexing
pack-priv boolean	reuseAddress The socket reuseAddress
pack-priv boolean	reusePort The socket reusePort
private static final Holder<Boolean>	REUSEPORT_AVAILABLE_HOLDER
protected SelectionKeyHandler	selectionKeyHandler
protected SelectorHandler	selectorHandler
protected SelectorProvider	selectorProvider
protected SelectorRunner[]	selectorRunners
private int	selectorRunnersCount
pack-priv int	serverSocketSoTimeout The server socket time out
protected FutureImpl<Transport>	shutdownFuture Future to control graceful shutdown status
protected Set<GracefulShutdownListener>	shutdownListeners
protected ExecutorService	shutdownService ExecutorService hosting shutdown listener threads.
protected final TemporarySelectorIO	temporarySelectorIO

Access	Constructor and Description
public	NIOTransport(final String name)

Method Summary

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

Inherited from 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

channelConfigurator	back to summary
protected ChannelConfigurator channelConfigurator

clientSocketSoTimeout	back to summary
pack-priv int clientSocketSoTimeout The socket time out

connectionTimeout	back to summary
pack-priv int connectionTimeout Default channel connection timeout

DEFAULT_CLIENT_SOCKET_SO_TIMEOUT	back to summary
public static final int DEFAULT_CLIENT_SOCKET_SO_TIMEOUT

DEFAULT_CONNECTION_TIMEOUT	back to summary
public static final int DEFAULT_CONNECTION_TIMEOUT Hides org.glassfish.grizzly.SocketConnectorHandler.DEFAULT_CONNECTION_TIMEOUT.

DEFAULT_OPTIMIZED_FOR_MULTIPLEXING	back to summary
public static final boolean DEFAULT_OPTIMIZED_FOR_MULTIPLEXING

DEFAULT_REUSE_ADDRESS	back to summary
public static final boolean DEFAULT_REUSE_ADDRESS

DEFAULT_REUSE_PORT	back to summary
public static final boolean DEFAULT_REUSE_PORT

DEFAULT_SELECTOR_RUNNER_COUNT	back to summary
public static final int DEFAULT_SELECTOR_RUNNER_COUNT

DEFAULT_SERVER_SOCKET_SO_TIMEOUT	back to summary
public static final int DEFAULT_SERVER_SOCKET_SO_TIMEOUT

LOGGER	back to summary
private static final Logger LOGGER

nioChannelDistributor	back to summary
protected NIOChannelDistributor nioChannelDistributor

optimizedForMultiplexing	back to summary
private boolean optimizedForMultiplexing

reuseAddress	back to summary
pack-priv boolean reuseAddress The socket reuseAddress

reusePort	back to summary
pack-priv boolean reusePort The socket reusePort

REUSEPORT_AVAILABLE_HOLDER	back to summary
private static final Holder<Boolean> REUSEPORT_AVAILABLE_HOLDER

selectionKeyHandler	back to summary
protected SelectionKeyHandler selectionKeyHandler

selectorHandler	back to summary
protected SelectorHandler selectorHandler

selectorProvider	back to summary
protected SelectorProvider selectorProvider

selectorRunners	back to summary
protected SelectorRunner[] selectorRunners

selectorRunnersCount	back to summary
private int selectorRunnersCount

serverSocketSoTimeout	back to summary
pack-priv int serverSocketSoTimeout The server socket time out

shutdownFuture	back to summary
protected FutureImpl<Transport> shutdownFuture Future to control graceful shutdown status

shutdownListeners	back to summary
protected Set<GracefulShutdownListener> shutdownListeners

shutdownService	back to summary
protected ExecutorService shutdownService ExecutorService hosting shutdown listener threads.

temporarySelectorIO	back to summary
protected final TemporarySelectorIO temporarySelectorIO

NIOTransport	back to summary
public NIOTransport(final String name)

Method Detail

addShutdownListener back to summary

addShutdownListener	back to summary
public boolean addShutdownListener(final GracefulShutdownListener shutdownListener) Implements org.glassfish.grizzly.Transport.addShutdownListener. Doc from org.glassfish.grizzly.Transport.addShutdownListener. Adds a `GracefulShutdownListener` which will be called when `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 Annotations @Override

public boolean addShutdownListener(final GracefulShutdownListener shutdownListener)

Implements org.glassfish.grizzly.Transport.addShutdownListener.

Doc from org.glassfish.grizzly.Transport.addShutdownListener.

Adds a GracefulShutdownListener which will be called when 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

Annotations

@Override

closeConnection	back to summary
protected abstract void closeConnection(Connection<L> connection) throws IOException Implements abstract org.glassfish.grizzly.AbstractTransport.closeConnection. Doc from org.glassfish.grizzly.AbstractTransport.closeConnection. Close the connection, managed by Transport Annotations @Override Exceptions IOException: not used

closeConnection

back to summary

protected abstract void closeConnection(Connection<L> connection) throws IOException

Implements abstract org.glassfish.grizzly.AbstractTransport.closeConnection.

Doc from org.glassfish.grizzly.AbstractTransport.closeConnection.

Close the connection, managed by Transport

Annotations

@Override

Exceptions

IOException:: not used

configureNIOConnection	back to summary
protected void configureNIOConnection(NIOConnection connection)

createShutdownExecutorService	back to summary
protected ExecutorService createShutdownExecutorService()

createTemporarySelectorIO	back to summary
protected abstract TemporarySelectorIO createTemporarySelectorIO()

finalizeShutdown	back to summary
protected void finalizeShutdown()

getChannelConfigurator	back to summary
public ChannelConfigurator getChannelConfigurator() Returns:ChannelConfigurator the configurator responsible for initial `SelectableChannel` configuration

getClientSocketSoTimeout	back to summary
public int getClientSocketSoTimeout()

getConnectionTimeout	back to summary
public int getConnectionTimeout()

getDefaultSelectorRunnersCount	back to summary
protected int getDefaultSelectorRunnersCount()

getNIOChannelDistributor	back to summary
public NIOChannelDistributor getNIOChannelDistributor()

getSelectionKeyHandler	back to summary
public SelectionKeyHandler getSelectionKeyHandler()

getSelectorHandler	back to summary
public SelectorHandler getSelectorHandler()

getSelectorProvider back to summary

getSelectorProvider	back to summary
public SelectorProvider getSelectorProvider() Get the `SelectorProvider` to be used by this transport. Returns:SelectorProvider the `SelectorProvider` to be used by this transport.

public SelectorProvider getSelectorProvider()

Get the SelectorProvider to be used by this transport.

Returns:SelectorProvider: the SelectorProvider to be used by this transport.

getSelectorRunners	back to summary
protected SelectorRunner[] getSelectorRunners()

getSelectorRunnersCount	back to summary
public int getSelectorRunnersCount() Returns:int the number of `SelectorRunner`s used for handling NIO events

getServerSocketSoTimeout	back to summary
public int getServerSocketSoTimeout()

getTemporarySelectorIO	back to summary
public TemporarySelectorIO getTemporarySelectorIO() Implements org.glassfish.grizzly.nio.tmpselectors.TemporarySelectorsEnabledTransport.getTemporarySelectorIO. Annotations @Override

getTemporarySelectorIO

back to summary

public TemporarySelectorIO getTemporarySelectorIO()

Implements org.glassfish.grizzly.nio.tmpselectors.TemporarySelectorsEnabledTransport.getTemporarySelectorIO.

Annotations

@Override

isOptimizedForMultiplexing back to summary

isOptimizedForMultiplexing	back to summary
public boolean isOptimizedForMultiplexing() Returns `true`, if `NIOTransport` is configured to use `org.glassfish.grizzly.asyncqueue.AsyncQueueWriter`, optimized to be used in connection multiplexing mode, or `false` otherwise. Returns:boolean `true`, if `NIOTransport` is configured to use `org.glassfish.grizzly.asyncqueue.AsyncQueueWriter`, optimized to be used in connection multiplexing mode, or `false` otherwise. Annotations @SuppressWarnings:UnusedDeclaration

public boolean isOptimizedForMultiplexing()

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

Returns:boolean

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

Annotations

@SuppressWarnings:UnusedDeclaration

isReuseAddress	back to summary
public boolean isReuseAddress()

isReusePort	back to summary
public boolean isReusePort()

isReusePortAvailable	back to summary
public boolean isReusePortAvailable() Tells whether SO_REUSEPORT is supported.

listen	back to summary
protected abstract void listen()

notifyProbesError back to summary

protected static void notifyProbesError(final NIOTransport transport, final Throwable error)

Notify registered TransportProbes about the error.

Parameters

transport:NIOTransport: the Transport event occurred on.

notifyProbesPause back to summary

protected static void notifyProbesPause(final NIOTransport transport)

Notify registered TransportProbes about the pause event.

Parameters

transport:NIOTransport: the Transport event occurred on.

notifyProbesResume back to summary

protected static void notifyProbesResume(final NIOTransport transport)

Notify registered TransportProbes about the resume event.

Parameters

transport:NIOTransport: the Transport event occurred on.

notifyProbesStart back to summary

protected static void notifyProbesStart(final NIOTransport transport)

Notify registered TransportProbes about the start event.

Parameters

transport:NIOTransport: the Transport event occurred on.

notifyProbesStop back to summary

protected static void notifyProbesStop(final NIOTransport transport)

Notify registered TransportProbes about the stop event.

Parameters

transport:NIOTransport: the Transport event occurred on.

notifyTransportError back to summary

public void notifyTransportError(final Throwable error)

Implements org.glassfish.grizzly.Transport.notifyTransportError.

Doc from org.glassfish.grizzly.Transport.notifyTransportError.

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

Annotations

@Override

pause back to summary

public void pause()

Implements org.glassfish.grizzly.Transport.pause.

Pause UDPNIOTransport, so I/O events coming on its org.glassfish.grizzly.nio.transport.UDPNIOConnections will not be processed. Use resume() in order to resume UDPNIOTransport processing. The transport will be paused only if its current state is org.glassfish.grizzly.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.

Annotations

@Override

resume back to summary

public void resume()

Implements org.glassfish.grizzly.Transport.resume.

Resume UDPNIOTransport, which has been paused before using pause(). The transport will be resumed only if its current state is org.glassfish.grizzly.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.

Annotations

@Override

setChannelConfigurator back to summary

public void setChannelConfigurator(final ChannelConfigurator channelConfigurator)

Sets the configurator responsible for initial SelectableChannel configuration.

Parameters

channelConfigurator:ChannelConfigurator: ChannelConfigurator

setClientSocketSoTimeout	back to summary
public void setClientSocketSoTimeout(final int socketTimeout) Annotations @SuppressWarnings:UnusedDeclaration

setConnectionTimeout	back to summary
public void setConnectionTimeout(final int connectionTimeout) Annotations @SuppressWarnings:UnusedDeclaration

setNIOChannelDistributor	back to summary
public void setNIOChannelDistributor(final NIOChannelDistributor nioChannelDistributor)

setOptimizedForMultiplexing	back to summary
public void setOptimizedForMultiplexing(final boolean optimizedForMultiplexing) Configures `NIOTransport` to be optimized for specific for the connection multiplexing usecase, when different threads will try to write data simultaneously.

setReuseAddress	back to summary
public void setReuseAddress(final boolean reuseAddress)

setReusePort	back to summary
public void setReusePort(final boolean reusePort)

setSelectionKeyHandler	back to summary
public void setSelectionKeyHandler(final SelectionKeyHandler selectionKeyHandler)

setSelectorHandler	back to summary
public void setSelectorHandler(final SelectorHandler selectorHandler)

setSelectorProvider back to summary

public void setSelectorProvider(final SelectorProvider selectorProvider)

Set the SelectorProvider to be used by this transport.

Parameters

selectorProvider:SelectorProvider: the SelectorProvider.

setSelectorRunnersCount	back to summary
public void setSelectorRunnersCount(final int selectorRunnersCount) Sets the number of `SelectorRunner`s used for handling NIO events.

setServerSocketSoTimeout	back to summary
public void setServerSocketSoTimeout(final int serverSocketSoTimeout) Annotations @SuppressWarnings:UnusedDeclaration

shutdown back to summary

public GrizzlyFuture<Transport> shutdown()

Implements org.glassfish.grizzly.Transport.shutdown.

Doc from org.glassfish.grizzly.Transport.shutdown.

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 shutdownNow() to terminate the transport if the graceful shutdown is taking too long.

Annotations

@Override

shutdown

back to summary

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

Implements org.glassfish.grizzly.Transport.shutdown.

Doc from org.glassfish.grizzly.Transport.shutdown.

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.

Annotations

@Override

shutdownNow

back to summary

public void shutdownNow() throws IOException

Implements org.glassfish.grizzly.Transport.shutdownNow.

Doc from org.glassfish.grizzly.Transport.shutdownNow.

Forcibly stops the transport and closes all connections.

Annotations

@Override

Exceptions

IOException:: if there was an error shutting down

start back to summary

public void start() throws IOException

Implements org.glassfish.grizzly.Transport.start.

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.

Annotations