NioEndpoint (Apache Tomcat 8.0.15 API Documentation)

java.lang.Object
- org.apache.tomcat.util.net.AbstractEndpoint<NioChannel>
- - org.apache.tomcat.util.net.NioEndpoint

```
public class NioEndpoint
extends AbstractEndpoint<NioChannel>
```
NIO tailored thread pool, providing the following services:
- Socket acceptor thread
- Socket poller thread
- Worker threads pool
When switching to Java 5, there's an opportunity to use the virtual machine's thread pool.
Author:

Mladen Turk, Remy Maucherat

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`NioEndpoint.Acceptor` The background thread that listens for incoming TCP/IP connections and hands them off to an appropriate processor.
`static interface`	`NioEndpoint.Handler` Bare bones interface used for socket processing.
`static class`	`NioEndpoint.KeyAttachment`
`static class`	`NioEndpoint.NioBufferHandler`
`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.AsyncTimeout, AbstractEndpoint.BindState

Field Summary

Fields
Modifier and Type Field and Description

static int OP_CALLBACK

static int OP_REGISTER
- Fields inherited from class org.apache.tomcat.util.net.AbstractEndpoint
  acceptors, acceptorThreadCount, acceptorThreadPriority, attributes, DEFAULT_CIPHERS, internalExecutor, paused, running, sm, socketProperties, threadPriority, waitingRequests

Fields
Modifier and Type	Field and Description
`static int`	`OP_CALLBACK`
`static int`	`OP_REGISTER`

Constructor Summary

Constructors
Constructor and Description

NioEndpoint()

Constructors
Constructor and Description
`NioEndpoint()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`bind()` Initialize the endpoint.
`protected void`	`checkParachute()`
`protected AbstractEndpoint.Acceptor`	`createAcceptor()` Hook to allow Endpoints to provide a specific Acceptor implementation.
`protected SSLEngine`	`createSSLEngine()`
`String[]`	`getCiphersUsed()`
`boolean`	`getDeferAccept()` Is deferAccept supported?
`NioEndpoint.Handler`	`getHandler()`
`int`	`getKeepAliveCount()` Number of keepalive sockets.
`int`	`getLocalPort()` Port in use.
`protected Log`	`getLog()`
`int`	`getOomParachute()`
`byte[]`	`getOomParachuteData()`
`NioEndpoint.Poller`	`getPoller0()` Return an available poller in true round robin fashion
`int`	`getPollerThreadCount()`
`int`	`getPollerThreadPriority()`
`int`	`getReadBufSize()`
`NioSelectorPool`	`getSelectorPool()`
`long`	`getSelectorTimeout()`
`SSLContext`	`getSSLContext()`
`boolean`	`getUseComet()`
`boolean`	`getUseCometTimeout()`
`boolean`	`getUsePolling()`
`boolean`	`getUseSendfile()`
`int`	`getWriteBufSize()`
`protected boolean`	`isWorkerAvailable()` Returns true if a worker thread is available for processing.
`protected boolean`	`processSocket(NioEndpoint.KeyAttachment attachment, SocketStatus status, boolean dispatch)`
`void`	`processSocket(SocketWrapper<NioChannel> socketWrapper, SocketStatus socketStatus, boolean dispatch)` Process the given SocketWrapper with the given status.
`protected boolean`	`reclaimParachute(boolean force)`
`protected void`	`releaseCaches()`
`void`	`setHandler(NioEndpoint.Handler handler)`
`void`	`setOomParachute(int oomParachute)`
`void`	`setOomParachuteData(byte[] oomParachuteData)`
`void`	`setPollerThreadCount(int pollerThreadCount)`
`void`	`setPollerThreadPriority(int pollerThreadPriority)`
`boolean`	`setProperty(String name, String value)` Generic properties, introspected
`void`	`setSelectorPool(NioSelectorPool selectorPool)`
`void`	`setSelectorTimeout(long timeout)`
`protected boolean`	`setSocketOptions(SocketChannel socket)` Process the specified connection.
`void`	`setSocketProperties(SocketProperties socketProperties)`
`void`	`setSSLContext(SSLContext c)`
`void`	`setUseComet(boolean useComet)`
`void`	`setUseSendfile(boolean useSendfile)`
`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.
`KeyManager[]`	`wrap(KeyManager[] managers)`

Methods inherited from class org.apache.tomcat.util.net.AbstractEndpoint
countDownConnection, countUpOrAwaitConnection, createExecutor, destroy, executeNonBlockingDispatches, getAcceptorThreadCount, getAcceptorThreadPriority, getAddress, getAlgorithm, getAllowUnsafeLegacyRenegotiation, getAsyncTimeout, getAttribute, getBacklog, getBindOnInit, getCiphers, getClientAuth, getConnectionCount, getCrlFile, getCurrentThreadCount, getCurrentThreadsBusy, getDaemon, getExecutor, getExecutorTerminationTimeoutMillis, getKeepAliveTimeout, getKeyAlias, getKeyPass, getKeystoreFile, getKeystorePass, getKeystoreProvider, getKeystoreType, getMaxConnections, getMaxHeaderCount, getMaxKeepAliveRequests, getMaxThreads, getMaxThreadsExecutor, getMinSpareThreads, getName, getPort, getProperty, getSessionCacheSize, getSessionTimeout, getSocketProperties, getSoLinger, getSoTimeout, getSslEnabledProtocolsArray, getSslProtocol, getTcpNoDelay, getThreadPriority, getTrustManagerClassName, getTrustMaxCertLength, getTruststoreAlgorithm, getTruststoreFile, getTruststorePass, getTruststoreProvider, getTruststoreType, handleExceptionWithDelay, init, initializeConnectionLatch, isPaused, isRunning, isSSLEnabled, pause, releaseConnectionLatch, resume, setAcceptorThreadCount, setAcceptorThreadPriority, setAddress, setAlgorithm, setAllowUnsafeLegacyRenegotiation, setAsyncTimeout, setAttribute, setBacklog, setBindOnInit, setCiphers, setClientAuth, setCrlFile, setDaemon, setExecutor, setExecutorTerminationTimeoutMillis, setKeepAliveTimeout, setKeyAlias, setKeyPass, setKeystoreFile, setKeystorePass, setKeystoreProvider, setKeystoreType, setMaxConnections, setMaxHeaderCount, setMaxKeepAliveRequests, setMaxThreads, setMinSpareThreads, setName, setPort, setSessionCacheSize, setSessionTimeout, setSoLinger, setSoTimeout, setSSLEnabled, setSslEnabledProtocols, setSslProtocol, setTcpNoDelay, setThreadPriority, setTrustManagerClassName, setTrustMaxCertLength, setTruststoreAlgorithm, setTruststoreFile, setTruststorePass, setTruststoreProvider, setTruststoreType, shutdownExecutor, start, startAcceptorThreads, stop, unlockAccept

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
```
    See Also:
    Constant Field Values
  - OP_CALLBACK
```
public static final int OP_CALLBACK
```
    See Also:
    Constant Field Values
- Constructor Detail
  - NioEndpoint
```
public NioEndpoint()
```
- Method Detail
  - setProperty
```
public boolean setProperty(String name,
                  String value)
```
    Generic properties, introspected
    
    Overrides:
    
    setProperty in class AbstractEndpoint<NioChannel>
  - setPollerThreadPriority
```
public void setPollerThreadPriority(int pollerThreadPriority)
```
  - getPollerThreadPriority
```
public int getPollerThreadPriority()
```
  - setHandler
```
public void setHandler(NioEndpoint.Handler handler)
```
  - getHandler
```
public NioEndpoint.Handler getHandler()
```
  - setUseComet
```
public void setUseComet(boolean useComet)
```
  - getUseComet
```
public boolean getUseComet()
```
    Specified by:
    
    getUseComet in class AbstractEndpoint<NioChannel>
  - getUseCometTimeout
```
public boolean getUseCometTimeout()
```
    Specified by:
    
    getUseCometTimeout in class AbstractEndpoint<NioChannel>
  - getUsePolling
```
public boolean getUsePolling()
```
    Specified by:
    
    getUsePolling in class AbstractEndpoint<NioChannel>
  - 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
  - setSelectorPool
```
public void setSelectorPool(NioSelectorPool selectorPool)
```
  - setSocketProperties
```
public void setSocketProperties(SocketProperties socketProperties)
```
  - setUseSendfile
```
public void setUseSendfile(boolean useSendfile)
```
  - getDeferAccept
```
public boolean getDeferAccept()
```
    Is deferAccept supported?
    
    Specified by:
    
    getDeferAccept in class AbstractEndpoint<NioChannel>
  - setOomParachute
```
public void setOomParachute(int oomParachute)
```
  - setOomParachuteData
```
public void setOomParachuteData(byte[] oomParachuteData)
```
  - getSSLContext
```
public SSLContext getSSLContext()
```
  - setSSLContext
```
public void setSSLContext(SSLContext c)
```
  - getLocalPort
```
public int getLocalPort()
```
    Port in use.
    
    Specified by:
    
    getLocalPort in class AbstractEndpoint<NioChannel>
  - getCiphersUsed
```
public String[] getCiphersUsed()
```
    Specified by:
    
    getCiphersUsed in class AbstractEndpoint<NioChannel>
    
    Returns:
    The ciphers in use by this Endpoint
  - checkParachute
```
protected void checkParachute()
```
  - reclaimParachute
```
protected boolean reclaimParachute(boolean force)
```
  - releaseCaches
```
protected void releaseCaches()
```
  - getKeepAliveCount
```
public int getKeepAliveCount()
```
    Number of keepalive sockets.
  - bind
```
public void bind()
          throws Exception
```
    Initialize the endpoint.
    
    Specified by:
    
    bind in class AbstractEndpoint<NioChannel>
    
    Throws:
    
    Exception
  - wrap
```
public KeyManager[] wrap(KeyManager[] managers)
```
  - startInternal
```
public void startInternal()
                   throws Exception
```
    Start the NIO endpoint, creating acceptor, poller threads.
    
    Specified by:
    
    startInternal in class AbstractEndpoint<NioChannel>
    
    Throws:
    
    Exception
  - stopInternal
```
public void stopInternal()
```
    Stop the endpoint. This will cause all processing threads to stop.
    
    Specified by:
    
    stopInternal in class AbstractEndpoint<NioChannel>
  - unbind
```
public void unbind()
            throws Exception
```
    Deallocate NIO memory pools, and close server socket.
    
    Specified by:
    
    unbind in class AbstractEndpoint<NioChannel>
    
    Throws:
    
    Exception
  - getWriteBufSize
```
public int getWriteBufSize()
```
  - getReadBufSize
```
public int getReadBufSize()
```
  - getSelectorPool
```
public NioSelectorPool getSelectorPool()
```
  - getUseSendfile
```
public boolean getUseSendfile()
```
    Specified by:
    
    getUseSendfile in class AbstractEndpoint<NioChannel>
  - getOomParachute
```
public int getOomParachute()
```
  - getOomParachuteData
```
public byte[] getOomParachuteData()
```
  - createAcceptor
```
protected AbstractEndpoint.Acceptor createAcceptor()
```
    Description copied from class: AbstractEndpoint
    
    Hook to allow Endpoints to provide a specific Acceptor implementation.
    
    Specified by:
    
    createAcceptor in class AbstractEndpoint<NioChannel>
  - setSocketOptions
```
protected boolean setSocketOptions(SocketChannel socket)
```
    Process the specified connection.
  - createSSLEngine
```
protected SSLEngine createSSLEngine()
```
  - isWorkerAvailable
```
protected boolean isWorkerAvailable()
```
    Returns true if a worker thread is available for processing.
    
    Returns:
    boolean
  - processSocket
```
public void processSocket(SocketWrapper<NioChannel> socketWrapper,
                 SocketStatus socketStatus,
                 boolean dispatch)
```
    Description copied from class: AbstractEndpoint
    
    Process the given SocketWrapper with the given status. Used to trigger processing as if the Poller (for those endpoints that have one) selected the socket.
    
    Specified by:
    
    processSocket in class AbstractEndpoint<NioChannel>
    
    Parameters:
    socketWrapper - The socket wrapper to process
    socketStatus - The input status to the processing
    dispatch - Should the processing be performed on a new container thread
  - processSocket
```
protected boolean processSocket(NioEndpoint.KeyAttachment attachment,
                    SocketStatus status,
                    boolean dispatch)
```
  - getLog
```
protected Log getLog()
```
    Specified by:
    
    getLog in class AbstractEndpoint<NioChannel>

Class NioEndpoint

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

OP_REGISTER

OP_CALLBACK

Constructor Detail

NioEndpoint

Method Detail

setProperty

setPollerThreadPriority

getPollerThreadPriority

setHandler

getHandler

setUseComet

getUseComet

getUseCometTimeout

getUsePolling

setPollerThreadCount

getPollerThreadCount

setSelectorTimeout

getSelectorTimeout

getPoller0

setSelectorPool

setSocketProperties

setUseSendfile

getDeferAccept

setOomParachute

setOomParachuteData

getSSLContext

setSSLContext

getLocalPort

getCiphersUsed

checkParachute

reclaimParachute

releaseCaches

getKeepAliveCount

bind

wrap

startInternal

stopInternal

unbind

getWriteBufSize

getReadBufSize

getSelectorPool

getUseSendfile

getOomParachute

getOomParachuteData

createAcceptor

setSocketOptions

createSSLEngine

isWorkerAvailable

processSocket

processSocket

getLog