Package org.apache.tomcat.util.net

Class NioEndpoint

java.lang.Object

org.apache.tomcat.util.net.AbstractEndpoint<S,U>

org.apache.tomcat.util.net.AbstractJsseEndpoint<NioChannel,java.nio.channels.SocketChannel>

org.apache.tomcat.util.net.NioEndpoint

public class NioEndpoint
extends AbstractJsseEndpoint<NioChannel,java.nio.channels.SocketChannel>

NIO endpoint.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NioEndpoint.NioSocketWrapper	NIO socket wrapper that wraps an NioChannel.
class	NioEndpoint.Poller	Poller class.
static class	NioEndpoint.PollerEvent	PollerEvent, cacheable object for poller events to avoid GC
static class	NioEndpoint.SendfileData	SendfileData class.
protected class	NioEndpoint.SocketProcessor	This class is the equivalent of the Worker, but will simply use in an external Executor thread pool.

Nested classes/interfaces inherited from class org.apache.tomcat.util.net.AbstractEndpoint

AbstractEndpoint.BindState, AbstractEndpoint.Handler<S>

Field Summary

Fields

Modifier and Type	Field	Description
static int	OP_REGISTER	Custom operation for registering interest in a socket.

Fields inherited from class org.apache.tomcat.util.net.AbstractEndpoint

acceptor, acceptorThreadPriority, attributes, connections, internalExecutor, negotiableProtocols, paused, processorCache, running, sm, socketProperties, sslHostConfigs, threadPriority

Constructor Summary

Constructors

Constructor	Description
NioEndpoint()	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	bind()	Initialize the endpoint.
protected SocketProcessorBase<NioChannel>	createSocketProcessor(SocketWrapperBase<NioChannel> socketWrapper, SocketEvent event)	Create a socket processor for the given socket wrapper.
protected void	destroySocket(java.nio.channels.SocketChannel socket)	Close the socket.
protected void	doCloseServerSocket()	Actually close the server socket but don't perform any other clean-up.
java.lang.String	getId()	The default behavior is to identify connectors uniquely with address and port.
int	getKeepAliveCount()	Number of keep-alive sockets.
protected Log	getLog()	Get the logger for this endpoint.
protected Log	getLogCertificate()	Get the logger for certificate-related messages.
protected SynchronizedStack<NioChannel>	getNioChannels()	Returns the NIO channel cache.
protected NioEndpoint.Poller	getPoller()	Returns the poller instance.
int	getPollerThreadPriority()	Returns the poller thread priority.
long	getSelectorTimeout()	Returns the selector timeout.
protected java.nio.channels.NetworkChannel	getServerSocket()
protected java.util.concurrent.CountDownLatch	getStopLatch()	Returns the stop latch.
java.lang.String	getUnixDomainSocketPath()	Returns the Unix domain socket path.
java.lang.String	getUnixDomainSocketPathPermissions()	Returns the Unix domain socket path permissions.
boolean	getUseInheritedChannel()	Returns whether an inherited channel is used.
protected void	initServerSocket()	Initializes the server socket channel.
protected java.nio.channels.SocketChannel	serverSocketAccept()	Accept a connection from the server socket.
void	setPollerThreadPriority(int pollerThreadPriority)	Sets the poller thread priority.
void	setSelectorTimeout(long timeout)	Sets the selector timeout.
protected boolean	setSocketOptions(java.nio.channels.SocketChannel socket)	Process the specified connection.
protected void	setStopLatch(java.util.concurrent.CountDownLatch stopLatch)	Sets the stop latch.
void	setUnixDomainSocketPath(java.lang.String unixDomainSocketPath)	Sets the Unix domain socket path.
void	setUnixDomainSocketPathPermissions(java.lang.String unixDomainSocketPathPermissions)	Sets the Unix domain socket path permissions.
void	setUseInheritedChannel(boolean useInheritedChannel)	Sets whether to use an inherited channel.
void	startInternal()	Start the NIO endpoint, creating acceptor, poller threads.
void	stopInternal()	Stop the endpoint.
void	unbind()	Deallocate NIO memory pools, and close server socket.
protected void	unlockAccept()	Unlock the server socket acceptor threads using bogus connections.

Methods inherited from class org.apache.tomcat.util.net.AbstractJsseEndpoint

createSSLContext, createSSLEngine, getLocalAddress, getSniParseLimit, getSslImplementation, getSslImplementationName, initialiseSsl, setSniParseLimit, setSslImplementationName

Methods inherited from class org.apache.tomcat.util.net.AbstractEndpoint

addNegotiatedProtocol, addSslHostConfig, addSslHostConfig, awaitConnectionsClose, checkSni, closeServerSocketGraceful, closeSocket, countDownConnection, countUpOrAwaitConnection, createExecutor, destroy, destroySsl, findSslHostConfigs, generateCertificateDebug, getAcceptCount, getAcceptorThreadPriority, getAddress, getAttribute, getBindOnInit, getBindState, getConnectionCount, getConnectionLinger, getConnections, getConnectionTimeout, getCurrentThreadCount, getCurrentThreadsBusy, getDaemon, getDefaultSSLHostConfigName, getDeferAccept, getDomain, getExecutor, getExecutorTerminationTimeoutMillis, getHandler, getKeepAliveTimeout, getLocalPort, getMaxConnections, getMaxKeepAliveRequests, getMaxQueueSize, getMaxThreads, getMinSpareThreads, getName, getPort, getPortOffset, getPortWithOffset, getProperty, getSocketProperties, getSSLHostConfig, getStrictSni, getTcpNoDelay, getThreadPriority, getThreadsMaxIdleTime, getUseAsyncIO, getUseSendfile, getUseVirtualThreads, getUtilityExecutor, hasNegotiableProtocols, init, initializeConnectionLatch, isPaused, isRunning, isSSLEnabled, logCertificate, pause, processSocket, releaseSSLContext, reloadSslHostConfig, reloadSslHostConfigs, removeSslHostConfig, resume, setAcceptCount, setAcceptorThreadPriority, setAddress, setAttribute, setBindOnInit, setConnectionLinger, setConnectionTimeout, setDaemon, setDefaultSSLHostConfigName, setDomain, setExecutor, setExecutorTerminationTimeoutMillis, setHandler, setKeepAliveTimeout, setMaxConnections, setMaxKeepAliveRequests, setMaxQueueSize, setMaxThreads, setMinSpareThreads, setName, setPort, setPortOffset, setProperty, setSSLEnabled, setStrictSni, setTcpNoDelay, setThreadPriority, setThreadsMaxIdleTime, setUseAsyncIO, setUseSendfile, setUseVirtualThreads, setUtilityExecutor, shutdownExecutor, start, startAcceptorThread, stop, toTimeout

Methods inherited from class java.lang.Object

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

Field Detail

OP_REGISTER

public static final int OP_REGISTER

Custom operation for registering interest in a socket.

See Also:

Constant Field Values

Constructor Detail

NioEndpoint

public NioEndpoint()

Default constructor.

Method Detail

setUseInheritedChannel

public void setUseInheritedChannel(boolean useInheritedChannel)

Sets whether to use an inherited channel.

Parameters:

useInheritedChannel - true to use System.inheritedChannel

getUseInheritedChannel

public boolean getUseInheritedChannel()

Returns whether an inherited channel is used.

Returns:

true if System.inheritedChannel is used

getUnixDomainSocketPath

public java.lang.String getUnixDomainSocketPath()

Returns the Unix domain socket path.

Returns:

the Unix domain socket path

setUnixDomainSocketPath

public void setUnixDomainSocketPath(java.lang.String unixDomainSocketPath)

Sets the Unix domain socket path.

Parameters:

unixDomainSocketPath - the path to the Unix domain socket

getUnixDomainSocketPathPermissions

public java.lang.String getUnixDomainSocketPathPermissions()

Returns the Unix domain socket path permissions.

Returns:

the permissions string

setUnixDomainSocketPathPermissions

public void setUnixDomainSocketPathPermissions(java.lang.String unixDomainSocketPathPermissions)

Sets the Unix domain socket path permissions.

Parameters:

unixDomainSocketPathPermissions - the permissions string

setPollerThreadPriority

public void setPollerThreadPriority(int pollerThreadPriority)

Sets the poller thread priority.

Parameters:

pollerThreadPriority - the thread priority

getPollerThreadPriority

public int getPollerThreadPriority()

Returns the poller thread priority.

Returns:

the thread priority

setSelectorTimeout

public void setSelectorTimeout(long timeout)

Sets the selector timeout.

Parameters:

timeout - The timeout in milliseconds

getSelectorTimeout

public long getSelectorTimeout()

Returns the selector timeout.

Returns:

the timeout in milliseconds

getKeepAliveCount

public int getKeepAliveCount()

Number of keep-alive sockets.

Returns:

The number of sockets currently in the keep-alive state waiting for the next request to be received on the socket

getId

public java.lang.String getId()

Description copied from class: AbstractEndpoint

The default behavior is to identify connectors uniquely with address and port. However, certain connectors are not using that and need some other identifier, which then can be used as a replacement.

Overrides:

getId in class AbstractEndpoint<NioChannel,java.nio.channels.SocketChannel>

Returns:

the id

bind

public void bind()
          throws java.lang.Exception

Initialize the endpoint.

Specified by:

bind in class AbstractEndpoint<NioChannel,java.nio.channels.SocketChannel>

Throws:

java.lang.Exception - If an error occurs during binding

initServerSocket

protected void initServerSocket()
                         throws java.lang.Exception

Initializes the server socket channel.

Throws:

java.lang.Exception - If initialization fails

startInternal

public void startInternal()
                   throws java.lang.Exception

Start the NIO endpoint, creating acceptor, poller threads.

Specified by:

startInternal in class AbstractEndpoint<NioChannel,java.nio.channels.SocketChannel>

Throws:

java.lang.Exception - If an error occurs during startup

stopInternal

public void stopInternal()

Stop the endpoint. This will cause all processing threads to stop.

Specified by:

stopInternal in class AbstractEndpoint<NioChannel,java.nio.channels.SocketChannel>

unbind

public void unbind()
            throws java.lang.Exception

Deallocate NIO memory pools, and close server socket.

Overrides:

unbind in class AbstractJsseEndpoint<NioChannel,java.nio.channels.SocketChannel>

Throws:

java.lang.Exception

doCloseServerSocket

protected void doCloseServerSocket()
                            throws java.io.IOException

Description copied from class: AbstractEndpoint

Actually close the server socket but don't perform any other clean-up.

Specified by:

doCloseServerSocket in class AbstractEndpoint<NioChannel,java.nio.channels.SocketChannel>

Throws:

java.io.IOException - If an error occurs closing the socket

unlockAccept

protected void unlockAccept()

Description copied from class: AbstractEndpoint

Unlock the server socket acceptor threads using bogus connections.

Overrides:

unlockAccept in class AbstractEndpoint<NioChannel,java.nio.channels.SocketChannel>

getNioChannels

protected SynchronizedStack<NioChannel> getNioChannels()

Returns the NIO channel cache.

Returns:

the channel cache stack

getPoller

protected NioEndpoint.Poller getPoller()

Returns the poller instance.

Returns:

the poller

getStopLatch

protected java.util.concurrent.CountDownLatch getStopLatch()

Returns the stop latch.

Returns:

the stop latch

setStopLatch

protected void setStopLatch(java.util.concurrent.CountDownLatch stopLatch)

Sets the stop latch.

Parameters:

stopLatch - the stop latch

setSocketOptions

protected boolean setSocketOptions(java.nio.channels.SocketChannel socket)

Process the specified connection.

Specified by:

setSocketOptions in class AbstractEndpoint<NioChannel,java.nio.channels.SocketChannel>

Parameters:

socket - The socket channel

Returns:

true if the socket was correctly configured and processing may continue, false if the socket needs to be close immediately

destroySocket

protected void destroySocket(java.nio.channels.SocketChannel socket)

Description copied from class: AbstractEndpoint

Close the socket. This is used when the connector is not in a state which allows processing the socket, or if there was an error which prevented the allocation of the socket wrapper.

Specified by:

destroySocket in class AbstractEndpoint<NioChannel,java.nio.channels.SocketChannel>

Parameters:

socket - The newly accepted socket

getServerSocket

protected java.nio.channels.NetworkChannel getServerSocket()

Specified by:

getServerSocket in class AbstractJsseEndpoint<NioChannel,java.nio.channels.SocketChannel>

serverSocketAccept

protected java.nio.channels.SocketChannel serverSocketAccept()
                                                      throws java.lang.Exception

Description copied from class: AbstractEndpoint

Accept a connection from the server socket.

Specified by:

serverSocketAccept in class AbstractEndpoint<NioChannel,java.nio.channels.SocketChannel>

Returns:

The accepted socket

Throws:

java.lang.Exception - If an error occurs during accept

getLog

protected Log getLog()

Description copied from class: AbstractEndpoint

Get the logger for this endpoint.

Specified by:

getLog in class AbstractEndpoint<NioChannel,java.nio.channels.SocketChannel>

Returns:

The logger

getLogCertificate

protected Log getLogCertificate()

Description copied from class: AbstractEndpoint

Get the logger for certificate-related messages.

Overrides:

getLogCertificate in class AbstractEndpoint<NioChannel,java.nio.channels.SocketChannel>

Returns:

The logger (defaults to AbstractEndpoint.getLog())

createSocketProcessor

protected SocketProcessorBase<NioChannel> createSocketProcessor(SocketWrapperBase<NioChannel> socketWrapper,
                                                                SocketEvent event)

Description copied from class: AbstractEndpoint

Create a socket processor for the given socket wrapper.

Specified by:

createSocketProcessor in class AbstractEndpoint<NioChannel,java.nio.channels.SocketChannel>

Parameters:

socketWrapper - The socket wrapper to process

event - The socket event

Returns:

The socket processor