Nio2Endpoint (Apache Tomcat 8.0.15 API Documentation)

java.lang.Object
- org.apache.tomcat.util.net.AbstractEndpoint<Nio2Channel>
- - org.apache.tomcat.util.net.Nio2Endpoint

public class Nio2Endpoint
extends AbstractEndpoint<Nio2Channel>

NIO2 endpoint.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`Nio2Endpoint.Acceptor` With NIO2, the main acceptor thread only initiates the initial accept but periodically checks that the connector is still accepting (if not it will attempt to start again).
`static interface`	`Nio2Endpoint.Handler` Bare bones interface used for socket processing.
`static class`	`Nio2Endpoint.Nio2SocketWrapper`
`static class`	`Nio2Endpoint.NioBufferHandler`
`static class`	`Nio2Endpoint.SendfileData` SendfileData class.
`static class`	`Nio2Endpoint.SendfileState`
`protected class`	`Nio2Endpoint.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 inherited from class org.apache.tomcat.util.net.AbstractEndpoint
  acceptors, acceptorThreadCount, acceptorThreadPriority, attributes, DEFAULT_CIPHERS, internalExecutor, paused, running, sm, socketProperties, threadPriority, waitingRequests

Constructor Summary

Constructors
Constructor and Description

Nio2Endpoint()

Constructors
Constructor and Description
`Nio2Endpoint()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addTimeout(SocketWrapper<Nio2Channel> socket)`
`void`	`awaitBytes(SocketWrapper<Nio2Channel> socket)`
`void`	`bind()` Initialize the endpoint.
`protected void`	`checkParachute()`
`void`	`closeSocket(SocketWrapper<Nio2Channel> socket, SocketStatus status)`
`protected AbstractEndpoint.Acceptor`	`createAcceptor()` Hook to allow Endpoints to provide a specific Acceptor implementation.
`protected SSLEngine`	`createSSLEngine()`
`static void`	`endInline()`
`String[]`	`getCiphersUsed()`
`boolean`	`getDeferAccept()` Is deferAccept supported?
`Nio2Endpoint.Handler`	`getHandler()`
`int`	`getKeepAliveCount()` Number of keepalive sockets.
`int`	`getLocalPort()` Port in use.
`protected Log`	`getLog()`
`int`	`getOomParachute()`
`byte[]`	`getOomParachuteData()`
`int`	`getPollerThreadPriority()`
`int`	`getReadBufSize()`
`SSLContext`	`getSSLContext()`
`boolean`	`getUseCaches()`
`boolean`	`getUseComet()`
`boolean`	`getUseCometTimeout()`
`boolean`	`getUsePolling()`
`boolean`	`getUseSendfile()`
`int`	`getWriteBufSize()`
`static boolean`	`isInline()`
`protected boolean`	`isWorkerAvailable()` Returns true if a worker thread is available for processing.
`Nio2Endpoint.SendfileState`	`processSendfile(Nio2Endpoint.Nio2SocketWrapper socket)`
`void`	`processSocket(SocketWrapper<Nio2Channel> socketWrapper, SocketStatus socketStatus, boolean dispatch)` Process the given SocketWrapper with the given status.
`protected boolean`	`processSocket0(SocketWrapper<Nio2Channel> socketWrapper, SocketStatus status, boolean dispatch)`
`protected boolean`	`reclaimParachute(boolean force)`
`protected void`	`releaseCaches()`
`boolean`	`removeTimeout(SocketWrapper<Nio2Channel> socket)`
`void`	`setHandler(Nio2Endpoint.Handler handler)`
`void`	`setOomParachute(int oomParachute)`
`void`	`setOomParachuteData(byte[] oomParachuteData)`
`void`	`setPollerThreadPriority(int pollerThreadPriority)`
`protected boolean`	`setSocketOptions(AsynchronousSocketChannel socket)` Process the specified connection.
`void`	`setSocketProperties(SocketProperties socketProperties)`
`void`	`setSSLContext(SSLContext c)`
`void`	`setUseCaches(boolean useCaches)`
`void`	`setUseComet(boolean useComet)`
`void`	`setUseSendfile(boolean useSendfile)`
`void`	`shutdownExecutor()`
`static void`	`startInline()`
`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, setProperty, setSessionCacheSize, setSessionTimeout, setSoLinger, setSoTimeout, setSSLEnabled, setSslEnabledProtocols, setSslProtocol, setTcpNoDelay, setThreadPriority, setTrustManagerClassName, setTrustMaxCertLength, setTruststoreAlgorithm, setTruststoreFile, setTruststorePass, setTruststoreProvider, setTruststoreType, start, startAcceptorThreads, stop, unlockAccept

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Nio2Endpoint
```
public Nio2Endpoint()
```
- Method Detail
  - setUseCaches
```
public void setUseCaches(boolean useCaches)
```
  - getUseCaches
```
public boolean getUseCaches()
```
  - setPollerThreadPriority
```
public void setPollerThreadPriority(int pollerThreadPriority)
```
  - getPollerThreadPriority
```
public int getPollerThreadPriority()
```
  - setHandler
```
public void setHandler(Nio2Endpoint.Handler handler)
```
  - getHandler
```
public Nio2Endpoint.Handler getHandler()
```
  - setUseComet
```
public void setUseComet(boolean useComet)
```
  - getUseComet
```
public boolean getUseComet()
```
    Specified by:
    
    getUseComet in class AbstractEndpoint<Nio2Channel>
  - getUseCometTimeout
```
public boolean getUseCometTimeout()
```
    Specified by:
    
    getUseCometTimeout in class AbstractEndpoint<Nio2Channel>
  - getUsePolling
```
public boolean getUsePolling()
```
    Specified by:
    
    getUsePolling in class AbstractEndpoint<Nio2Channel>
  - 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<Nio2Channel>
  - 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<Nio2Channel>
  - getCiphersUsed
```
public String[] getCiphersUsed()
```
    Specified by:
    
    getCiphersUsed in class AbstractEndpoint<Nio2Channel>
    
    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<Nio2Channel>
    
    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<Nio2Channel>
    
    Throws:
    
    Exception
  - stopInternal
```
public void stopInternal()
```
    Stop the endpoint. This will cause all processing threads to stop.
    
    Specified by:
    
    stopInternal in class AbstractEndpoint<Nio2Channel>
  - unbind
```
public void unbind()
            throws Exception
```
    Deallocate NIO memory pools, and close server socket.
    
    Specified by:
    
    unbind in class AbstractEndpoint<Nio2Channel>
    
    Throws:
    
    Exception
  - shutdownExecutor
```
public void shutdownExecutor()
```
    Overrides:
    
    shutdownExecutor in class AbstractEndpoint<Nio2Channel>
  - getWriteBufSize
```
public int getWriteBufSize()
```
  - getReadBufSize
```
public int getReadBufSize()
```
  - getUseSendfile
```
public boolean getUseSendfile()
```
    Specified by:
    
    getUseSendfile in class AbstractEndpoint<Nio2Channel>
  - 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<Nio2Channel>
  - setSocketOptions
```
protected boolean setSocketOptions(AsynchronousSocketChannel 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<Nio2Channel> 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<Nio2Channel>
    
    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
  - processSocket0
```
protected boolean processSocket0(SocketWrapper<Nio2Channel> socketWrapper,
                     SocketStatus status,
                     boolean dispatch)
```
  - closeSocket
```
public void closeSocket(SocketWrapper<Nio2Channel> socket,
               SocketStatus status)
```
  - getLog
```
protected Log getLog()
```
    Specified by:
    
    getLog in class AbstractEndpoint<Nio2Channel>
  - addTimeout
```
public void addTimeout(SocketWrapper<Nio2Channel> socket)
```
  - removeTimeout
```
public boolean removeTimeout(SocketWrapper<Nio2Channel> socket)
```
  - startInline
```
public static void startInline()
```
  - endInline
```
public static void endInline()
```
  - isInline
```
public static boolean isInline()
```
  - awaitBytes
```
public void awaitBytes(SocketWrapper<Nio2Channel> socket)
```
  - processSendfile
```
public Nio2Endpoint.SendfileState processSendfile(Nio2Endpoint.Nio2SocketWrapper socket)
```

Class Nio2Endpoint

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

Constructor Detail

Nio2Endpoint

Method Detail

setUseCaches

getUseCaches

setPollerThreadPriority

getPollerThreadPriority

setHandler

getHandler

setUseComet

getUseComet

getUseCometTimeout

getUsePolling

setSocketProperties

setUseSendfile

getDeferAccept

setOomParachute

setOomParachuteData

getSSLContext

setSSLContext

getLocalPort

getCiphersUsed

checkParachute

reclaimParachute

releaseCaches

getKeepAliveCount

bind

wrap

startInternal

stopInternal

unbind

shutdownExecutor

getWriteBufSize

getReadBufSize

getUseSendfile

getOomParachute

getOomParachuteData

createAcceptor

setSocketOptions

createSSLEngine

isWorkerAvailable

processSocket

processSocket0

closeSocket

getLog

addTimeout

removeTimeout

startInline

endInline

isInline

awaitBytes

processSendfile