org.apache.tomcat.util.net
Class NioEndpoint

java.lang.Object
  org.apache.tomcat.util.net.AbstractEndpoint
      org.apache.tomcat.util.net.NioEndpoint

public class NioEndpoint
extends AbstractEndpoint

NIO tailored thread pool, providing the following services:

• Socket acceptor thread
• Socket poller thread
• Worker threads pool

Author:

Mladen Turk, Remy Maucherat, Filip Hanik

log

protected static Log log

sm

protected static StringManager sm

CIPHER_SUITE_KEY

public static final java.lang.String CIPHER_SUITE_KEY

The Request attribute key for the cipher suite.

See Also:

Constant Field Values

KEY_SIZE_KEY

public static final java.lang.String KEY_SIZE_KEY

The Request attribute key for the key size.

See Also:

Constant Field Values

CERTIFICATE_KEY

public static final java.lang.String CERTIFICATE_KEY

The Request attribute key for the client certificate chain.

See Also:

Constant Field Values

SESSION_ID_KEY

public static final java.lang.String SESSION_ID_KEY

The Request attribute key for the session id. This one is a Tomcat extension to the Servlet spec.

See Also:

Constant Field Values

OP_REGISTER

public static final int OP_REGISTER

See Also:

Constant Field Values

OP_CALLBACK

public static final int OP_CALLBACK

See Also:

Constant Field Values

workers

protected NioEndpoint.WorkerStack workers

Available workers.

running

protected volatile boolean running

Running state of the endpoint.

paused

protected volatile boolean paused

Will be set to true whenever the endpoint is paused.

initialized

protected boolean initialized

Track the initialization state of the endpoint.

curThreadsBusy

protected int curThreadsBusy

Current worker threads busy count.

curThreads

protected int curThreads

Current worker threads count.

sequence

protected int sequence

Sequence number used to generate thread names.

selectorPool

protected NioSelectorPool selectorPool

serverSock

protected java.nio.channels.ServerSocketChannel serverSock

Server socket "pointer".

useSendfile

protected boolean useSendfile

use send file

oomParachute

protected int oomParachute

The size of the OOM parachute.

oomParachuteData

protected byte[] oomParachuteData

The oom parachute, when an OOM error happens, will release the data, giving the JVM instantly a chunk of data to be able to recover with.

oomParachuteMsg

protected static final java.lang.String oomParachuteMsg

Make sure this string has already been allocated

See Also:

Constant Field Values

activeSocketProcessors

protected java.util.concurrent.atomic.AtomicInteger activeSocketProcessors

Keep track of how many threads are in use

stopLatch

protected volatile java.util.concurrent.CountDownLatch stopLatch

processorCache

protected java.util.concurrent.ConcurrentLinkedQueue<NioEndpoint.SocketProcessor> processorCache

Cache for SocketProcessor objects

keyCache

protected java.util.concurrent.ConcurrentLinkedQueue<NioEndpoint.KeyAttachment> keyCache

Cache for key attachment objects

eventCache

protected java.util.concurrent.ConcurrentLinkedQueue<NioEndpoint.PollerEvent> eventCache

Cache for poller events

nioChannels

protected java.util.concurrent.ConcurrentLinkedQueue<NioChannel> nioChannels

Bytebuffer cache, each channel holds a set of buffers (two, except for SSL holds four)

executor

protected java.util.concurrent.Executor executor

External Executor based thread pool.

useExecutor

protected boolean useExecutor

maxThreads

protected int maxThreads

Maximum amount of worker threads.

threadPriority

protected int threadPriority

Priority of the worker threads.

acceptorThreadPriority

protected int acceptorThreadPriority

Priority of the acceptor threads.

pollerThreadPriority

protected int pollerThreadPriority

Priority of the poller threads.

port

protected int port

Server socket port.

address

protected java.net.InetAddress address

Address for the server socket.

handler

protected NioEndpoint.Handler handler

Handling of accepted sockets.

backlog

protected int backlog

Allows the server developer to specify the backlog that should be used for server sockets. By default, this value is 100.

socketProperties

protected SocketProperties socketProperties

daemon

protected boolean daemon

The default is true - the created threads will be in daemon mode. If set to false, the control thread will not be daemon - and will keep the process alive.

name

protected java.lang.String name

Name of the thread pool, which will be used for naming child threads.

useComet

protected boolean useComet

Allow comet request handling.

acceptorThreadCount

protected int acceptorThreadCount

Acceptor thread count.

pollerThreadCount

protected int pollerThreadCount

Poller thread count.

selectorTimeout

protected long selectorTimeout

pollers

protected NioEndpoint.Poller[] pollers

The socket poller.

pollerRotater

protected java.util.concurrent.atomic.AtomicInteger pollerRotater

truststoreFile

protected java.lang.String truststoreFile

truststorePass

protected java.lang.String truststorePass

truststoreType

protected java.lang.String truststoreType

keystoreFile

protected java.lang.String keystoreFile

algorithm

protected java.lang.String algorithm

clientAuth

protected java.lang.String clientAuth

keystorePass

protected java.lang.String keystorePass

keystoreType

protected java.lang.String keystoreType

sslProtocol

protected java.lang.String sslProtocol

sslEnabledProtocols

protected java.lang.String sslEnabledProtocols

sslEnabledProtocolsarr

protected java.lang.String[] sslEnabledProtocolsarr

ciphers

protected java.lang.String ciphers

ciphersarr

protected java.lang.String[] ciphersarr

sessionCacheSize

protected int sessionCacheSize

sessionTimeout

protected int sessionTimeout

SSLEnabled

protected boolean SSLEnabled

SSL engine.

secure

protected boolean secure

sslContext

protected javax.net.ssl.SSLContext sslContext

NioEndpoint

public NioEndpoint()

setExecutor

public void setExecutor(java.util.concurrent.Executor executor)

getExecutor

public java.util.concurrent.Executor getExecutor()

setUseExecutor

public void setUseExecutor(boolean useexec)

getUseExecutor

public boolean getUseExecutor()

setMaxThreads

public void setMaxThreads(int maxThreads)

getMaxThreads

public int getMaxThreads()

setThreadPriority

public void setThreadPriority(int threadPriority)

getThreadPriority

public int getThreadPriority()

setAcceptorThreadPriority

public void setAcceptorThreadPriority(int acceptorThreadPriority)

getAcceptorThreadPriority

public int getAcceptorThreadPriority()

setPollerThreadPriority

public void setPollerThreadPriority(int pollerThreadPriority)

getPollerThreadPriority

public int getPollerThreadPriority()

getPort

public int getPort()

setPort

public void setPort(int port)

getAddress

public java.net.InetAddress getAddress()

setAddress

public void setAddress(java.net.InetAddress address)

setHandler

public void setHandler(NioEndpoint.Handler handler)

getHandler

public NioEndpoint.Handler getHandler()

setBacklog

public void setBacklog(int backlog)

getBacklog

public int getBacklog()

getTcpNoDelay

public boolean getTcpNoDelay()

Socket TCP no delay.

setTcpNoDelay

public void setTcpNoDelay(boolean tcpNoDelay)

getSoLinger

public int getSoLinger()

Socket linger.

setSoLinger

public void setSoLinger(int soLinger)

getSoTimeout

public int getSoTimeout()

Socket timeout.

setSoTimeout

public void setSoTimeout(int soTimeout)

setDaemon

public void setDaemon(boolean b)

getDaemon

public boolean getDaemon()

setName

public void setName(java.lang.String name)

getName

public java.lang.String getName()

setUseComet

public void setUseComet(boolean useComet)

getUseComet

public boolean getUseComet()

setAcceptorThreadCount

public void setAcceptorThreadCount(int acceptorThreadCount)

getAcceptorThreadCount

public int getAcceptorThreadCount()

setPollerThreadCount

public void setPollerThreadCount(int pollerThreadCount)

getPollerThreadCount

public int getPollerThreadCount()

setSelectorTimeout

public void setSelectorTimeout(long timeout)

getSelectorTimeout

public long getSelectorTimeout()

getPoller0

public NioEndpoint.Poller getPoller0()

Return an available poller in true round robin fashion

getMaxSpareThreads

public int getMaxSpareThreads()

Dummy maxSpareThreads property.

getMinSpareThreads

public int getMinSpareThreads()

Dummy minSpareThreads property.

setProperty

public boolean setProperty(java.lang.String name,
                           java.lang.String value)

Generic properties, introspected

adjustRelativePath

public java.lang.String adjustRelativePath(java.lang.String path,
                                           java.lang.String relativeTo)

defaultIfNull

public java.lang.String defaultIfNull(java.lang.String val,
                                      java.lang.String defaultValue)

setTruststoreFile

public void setTruststoreFile(java.lang.String s)

getTruststoreFile

public java.lang.String getTruststoreFile()

setTruststorePass

public void setTruststorePass(java.lang.String truststorePass)

getTruststorePass

public java.lang.String getTruststorePass()

setTruststoreType

public void setTruststoreType(java.lang.String truststoreType)

getTruststoreType

public java.lang.String getTruststoreType()

getKeystoreFile

public java.lang.String getKeystoreFile()

setKeystoreFile

public void setKeystoreFile(java.lang.String s)

setKeystore

public void setKeystore(java.lang.String s)

getKeystore

public java.lang.String getKeystore()

getKeyAlias

public java.lang.String getKeyAlias()

setKeyAlias

public void setKeyAlias(java.lang.String s)

getAlgorithm

public java.lang.String getAlgorithm()

setAlgorithm

public void setAlgorithm(java.lang.String s)

getClientAuth

public java.lang.String getClientAuth()

setClientAuth

public void setClientAuth(java.lang.String s)

getKeystorePass

public java.lang.String getKeystorePass()

setKeystorePass

public void setKeystorePass(java.lang.String s)

getKeystoreType

public java.lang.String getKeystoreType()

setKeystoreType

public void setKeystoreType(java.lang.String s)

getSslProtocol

public java.lang.String getSslProtocol()

setSslProtocol

public void setSslProtocol(java.lang.String s)

setSslEnabledProtocols

public void setSslEnabledProtocols(java.lang.String s)

getCiphers

public java.lang.String getCiphers()

setCiphers

public void setCiphers(java.lang.String s)

getSessionCacheSize

public int getSessionCacheSize()

setSessionCacheSize

public void setSessionCacheSize(int i)

getSessionTimeout

public int getSessionTimeout()

setSessionTimeout

public void setSessionTimeout(int i)

isSSLEnabled

public boolean isSSLEnabled()

setSSLEnabled

public void setSSLEnabled(boolean SSLEnabled)

getSecure

public boolean getSecure()

setSecure

public void setSecure(boolean b)

setSelectorPool

public void setSelectorPool(NioSelectorPool selectorPool)

setSocketProperties

public void setSocketProperties(SocketProperties socketProperties)

setUseSendfile

public void setUseSendfile(boolean useSendfile)

setOomParachute

public void setOomParachute(int oomParachute)

setOomParachuteData

public void setOomParachuteData(byte[] oomParachuteData)

getSSLContext

public javax.net.ssl.SSLContext getSSLContext()

setSSLContext

public void setSSLContext(javax.net.ssl.SSLContext c)

getLocalPort

public int getLocalPort()

Port in use.

Specified by:

getLocalPort in class AbstractEndpoint

checkParachute

protected void checkParachute()

reclaimParachute

protected boolean reclaimParachute(boolean force)

releaseCaches

protected void releaseCaches()

getKeepAliveCount

public int getKeepAliveCount()

Number of keepalive sockets.

getCurrentThreadCount

public int getCurrentThreadCount()

Return the amount of threads that are managed by the pool.

Returns:

the amount of threads that are managed by the pool

getCurrentThreadsBusy

public int getCurrentThreadsBusy()

Return the amount of threads that are in use

Returns:

the amount of threads that are in use

isRunning

public boolean isRunning()

Return the state of the endpoint.

Returns:

true if the endpoint is running, false otherwise

isPaused

public boolean isPaused()

Return the state of the endpoint.

Returns:

true if the endpoint is paused, false otherwise

init

public void init()
          throws java.lang.Exception

Initialize the endpoint.

Throws:

java.lang.Exception

wrap

public javax.net.ssl.KeyManager[] wrap(javax.net.ssl.KeyManager[] managers)

start

public void start()
           throws java.lang.Exception

Start the NIO endpoint, creating acceptor, poller threads.

Throws:

java.lang.Exception

pause

public void pause()

Pause the endpoint, which will make it stop accepting new sockets.

resume

public void resume()

Resume the endpoint, which will make it start accepting new sockets again.

stop

public void stop()

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

destroy

public void destroy()
             throws java.lang.Exception

Deallocate NIO memory pools, and close server socket.

Throws:

java.lang.Exception

getSequence

protected int getSequence()

Get a sequence number used for thread naming.

getWriteBufSize

public int getWriteBufSize()

getReadBufSize

public int getReadBufSize()

getSelectorPool

public NioSelectorPool getSelectorPool()

getSocketProperties

public SocketProperties getSocketProperties()

getUseSendfile

public boolean getUseSendfile()

getOomParachute

public int getOomParachute()

getOomParachuteData

public byte[] getOomParachuteData()

unlockAccept

protected void unlockAccept()

Unlock the server socket accept using a bogus connection.

setSocketOptions

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

Process the specified connection.

createSSLEngine

protected javax.net.ssl.SSLEngine createSSLEngine()

isWorkerAvailable

protected boolean isWorkerAvailable()

Returns true if a worker thread is available for processing.

Returns:

boolean

createWorkerThread

protected NioEndpoint.Worker createWorkerThread()

Create (or allocate) and return an available processor for use in processing a specific HTTP request, if possible. If the maximum allowed processors have already been created and are in use, return null instead.

newWorkerThread

protected NioEndpoint.Worker newWorkerThread()

Create and return a new processor suitable for processing HTTP requests and returning the corresponding responses.

getWorkerThread

protected NioEndpoint.Worker getWorkerThread()

Return a new worker thread, and block while to worker is available.

recycleWorkerThread

protected void recycleWorkerThread(NioEndpoint.Worker workerThread)

Recycle the specified Processor so that it can be used again.

Parameters:

workerThread - The processor to be recycled

processSocket

protected boolean processSocket(NioChannel socket)

Process given socket.

processSocket

protected boolean processSocket(NioChannel socket,
                                SocketStatus status)

Process given socket for an event.

processSocket

protected boolean processSocket(NioChannel socket,
                                SocketStatus status,
                                boolean dispatch)