Package org.apache.tomcat.util.net
Class AprEndpoint
- All Implemented Interfaces:
SSLContext.SNICallBack
@Deprecated
public class AprEndpoint
extends AbstractEndpoint<Long,Long>
implements SSLContext.SNICallBack
Deprecated.
The APR/Native Connector will be removed in Tomcat 10.1.x
onwards.
APR tailored thread pool, providing the following services:
- Socket acceptor thread
- Socket poller thread
- Sendfile thread
- Worker threads pool
- Author:
- Mladen Turk, Remy Maucherat
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Deprecated.class
Deprecated.class
Deprecated.static class
Deprecated.SendfileData class.static class
Deprecated.static class
Deprecated.protected class
Deprecated.This class is the equivalent of the Worker, but will simply use in an external Executor thread pool.static class
Deprecated.protected class
Deprecated.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
Modifier and TypeFieldDescriptionprotected boolean
Deprecated.Defer accept.protected AprEndpoint.Poller
Deprecated.The socket poller.protected int
Deprecated.Poll interval, in microseconds.protected long
Deprecated.Root APR memory pool.protected AprEndpoint.Sendfile
Deprecated.The static file sender.protected int
Deprecated.Size of the sendfile (= concurrent files which can be served).protected long
Deprecated.Server socket "pointer".protected long
Deprecated.APR memory pool for the server socket.protected long
Deprecated.Default SSL context.Fields inherited from class org.apache.tomcat.util.net.AbstractEndpoint
acceptor, acceptorThreadCount, acceptorThreadPriority, attributes, connections, internalExecutor, negotiableProtocols, paused, processorCache, running, sm, socketProperties, sslHostConfigs, threadPriority
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected long
allocatePoller
(int size, long pool, int timeout) Deprecated.Allocate a new poller of the specified size.void
bind()
Deprecated.Initialize the endpoint.protected SocketProcessorBase<Long>
createSocketProcessor
(SocketWrapperBase<Long> socketWrapper, SocketEvent event) Deprecated.protected void
createSSLContext
(SSLHostConfig sslHostConfig) Deprecated.Create the SSLContext for the given SSLHostConfig.protected void
destroySocket
(Long socket) Deprecated.Close the socket.protected void
Deprecated.Actually close the server socket but don't perform any other clean-up.boolean
Deprecated.getId()
Deprecated.The default behavior is to identify connectors uniquely with address and port.boolean
Deprecated.int
Deprecated.Obtain the number of kept alive sockets.Deprecated.Obtain the network address the server socket is bound to.protected Log
getLog()
Deprecated.protected Log
Deprecated.Deprecated.int
Deprecated.Deprecated.int
Deprecated.Obtain the number of sendfile sockets.int
Deprecated.long
getSslContext
(String sniHostName) Deprecated.This callback is made during the TLS handshake when the client uses the SNI extension to request a specific TLS host.Deprecated.Deprecated.boolean
Deprecated.Identifies if the endpoint supports ALPN.protected boolean
processSocket
(long socket, SocketEvent event) Deprecated.Process the given socket.protected Long
Deprecated.protected void
setDefaultSslHostConfig
(SSLHostConfig sslHostConfig) Deprecated.void
setDeferAccept
(boolean deferAccept) Deprecated.void
setIpv6v6only
(boolean ipv6v6only) Deprecated.void
setMaxConnections
(int maxConnections) Deprecated.This endpoint does not support-1
for unlimited connections, nor does it support setting this attribute while the endpoint is running.void
setPollTime
(int pollTime) Deprecated.void
setSendfileSize
(int sendfileSize) Deprecated.protected boolean
setSocketOptions
(Long socket) Deprecated.Process given socket.protected boolean
setSocketOptions
(SocketWrapperBase<Long> socketWrapper) Deprecated.Process the specified connection.void
setUnixDomainSocketPath
(String unixDomainSocketPath) Deprecated.void
setUnixDomainSocketPathPermissions
(String unixDomainSocketPathPermissions) Deprecated.void
setUseSendfile
(boolean useSendfile) Deprecated.void
Deprecated.Start the APR endpoint, creating acceptor, poller and sendfile threads.void
Deprecated.Stop the endpoint.void
unbind()
Deprecated.Deallocate APR memory pools, and close server socket.Methods inherited from class org.apache.tomcat.util.net.AbstractEndpoint
addNegotiatedProtocol, addSslHostConfig, addSslHostConfig, awaitConnectionsClose, closeServerSocketGraceful, closeSocket, countDownConnection, countUpOrAwaitConnection, createExecutor, destroy, destroySsl, findSslHostConfigs, generateCertificateDebug, getAcceptCount, getAcceptorThreadCount, getAcceptorThreadPriority, getAddress, getAttribute, getBindOnInit, getBindState, getConnectionCount, getConnectionLinger, getConnections, getConnectionTimeout, getCurrentThreadCount, getCurrentThreadsBusy, getDaemon, getDefaultSSLHostConfigName, getDomain, getExecutor, getExecutorTerminationTimeoutMillis, getHandler, getKeepAliveTimeout, getLocalPort, getMaxConnections, getMaxKeepAliveRequests, getMaxQueueSize, getMaxThreads, getMinSpareThreads, getName, getPort, getPortOffset, getPortWithOffset, getProperty, getSocketProperties, getSSLHostConfig, getTcpNoDelay, getThreadPriority, getThreadsMaxIdleTime, getUseAsyncIO, getUseSendfile, getUseVirtualThreads, getUtilityExecutor, hasNegotiableProtocols, init, initializeConnectionLatch, isPaused, isRunning, isSSLEnabled, logCertificate, pause, processSocket, releaseSSLContext, reloadSslHostConfig, reloadSslHostConfigs, removeSslHostConfig, resume, setAcceptCount, setAcceptorThreadCount, setAcceptorThreadPriority, setAddress, setAttribute, setBindOnInit, setConnectionLinger, setConnectionTimeout, setDaemon, setDefaultSSLHostConfigName, setDomain, setExecutor, setExecutorTerminationTimeoutMillis, setHandler, setKeepAliveTimeout, setMaxKeepAliveRequests, setMaxQueueSize, setMaxThreads, setMinSpareThreads, setName, setPort, setPortOffset, setProperty, setSSLEnabled, setTcpNoDelay, setThreadPriority, setThreadsMaxIdleTime, setUseAsyncIO, setUseVirtualThreads, setUtilityExecutor, shutdownExecutor, start, startAcceptorThread, stop, toTimeout, unlockAccept
-
Field Details
-
rootPool
protected long rootPoolDeprecated.Root APR memory pool. -
serverSock
protected volatile long serverSockDeprecated.Server socket "pointer". -
serverSockPool
protected long serverSockPoolDeprecated.APR memory pool for the server socket. -
sslContext
protected volatile long sslContextDeprecated.Default SSL context. SNI callback may select a different SSL context. -
deferAccept
protected boolean deferAcceptDeprecated.Defer accept. -
sendfileSize
protected int sendfileSizeDeprecated.Size of the sendfile (= concurrent files which can be served). -
pollTime
protected int pollTimeDeprecated.Poll interval, in microseconds. The smaller the value, the more CPU the poller will use, but the more responsive to activity it will be. -
poller
Deprecated.The socket poller. -
sendfile
Deprecated.The static file sender.
-
-
Constructor Details
-
AprEndpoint
public AprEndpoint()Deprecated.
-
-
Method Details
-
setDeferAccept
public void setDeferAccept(boolean deferAccept) Deprecated. -
getDeferAccept
public boolean getDeferAccept()Deprecated.- Specified by:
getDeferAccept
in classAbstractEndpoint<Long,
Long>
-
setIpv6v6only
public void setIpv6v6only(boolean ipv6v6only) Deprecated. -
getIpv6v6only
public boolean getIpv6v6only()Deprecated. -
setSendfileSize
public void setSendfileSize(int sendfileSize) Deprecated. -
getSendfileSize
public int getSendfileSize()Deprecated. -
getPollTime
public int getPollTime()Deprecated. -
setPollTime
public void setPollTime(int pollTime) Deprecated. -
setUseSendfile
public void setUseSendfile(boolean useSendfile) Deprecated.- Overrides:
setUseSendfile
in classAbstractEndpoint<Long,
Long>
-
getPoller
Deprecated. -
getSendfile
Deprecated. -
getLocalAddress
Deprecated.Description copied from class:AbstractEndpoint
Obtain the network address the server socket is bound to. This primarily exists to enable the correct address to be used when unlocking the server socket since it removes the guess-work involved if no address is specifically set.- Specified by:
getLocalAddress
in classAbstractEndpoint<Long,
Long> - Returns:
- The network address that the server socket is listening on or null if the server socket is not currently bound.
- Throws:
IOException
- If there is a problem determining the currently bound socket
-
setMaxConnections
public void setMaxConnections(int maxConnections) Deprecated.This endpoint does not support-1
for unlimited connections, nor does it support setting this attribute while the endpoint is running.- Overrides:
setMaxConnections
in classAbstractEndpoint<Long,
Long>
-
getUnixDomainSocketPath
Deprecated. -
setUnixDomainSocketPath
Deprecated. -
getUnixDomainSocketPathPermissions
Deprecated. -
setUnixDomainSocketPathPermissions
Deprecated. -
getKeepAliveCount
public int getKeepAliveCount()Deprecated.Obtain the number of kept alive sockets.- Returns:
- The number of open sockets currently managed by the Poller
-
getSendfileCount
public int getSendfileCount()Deprecated.Obtain the number of sendfile sockets.- Returns:
- The number of sockets currently managed by the Sendfile poller.
-
getId
Deprecated.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 classAbstractEndpoint<Long,
Long> - Returns:
- the id
-
bind
Deprecated.Initialize the endpoint.- Specified by:
bind
in classAbstractEndpoint<Long,
Long> - Throws:
Exception
-
createSSLContext
Deprecated.Description copied from class:AbstractEndpoint
Create the SSLContext for the given SSLHostConfig.- Specified by:
createSSLContext
in classAbstractEndpoint<Long,
Long> - Parameters:
sslHostConfig
- The SSLHostConfig for which the SSLContext should be created- Throws:
Exception
- If the SSLContext cannot be created for the given SSLHostConfig
-
getSslContext
Deprecated.Description copied from interface:SSLContext.SNICallBack
This callback is made during the TLS handshake when the client uses the SNI extension to request a specific TLS host.- Specified by:
getSslContext
in interfaceSSLContext.SNICallBack
- Parameters:
sniHostName
- The host name requested by the client - must be in lower case- Returns:
- The Java representation of the pointer to the OpenSSL SSLContext to use for the given host or zero if no SSLContext could be identified
-
setDefaultSslHostConfig
Deprecated.- Specified by:
setDefaultSslHostConfig
in classAbstractEndpoint<Long,
Long>
-
isAlpnSupported
public boolean isAlpnSupported()Deprecated.Description copied from class:AbstractEndpoint
Identifies if the endpoint supports ALPN. Note that a return value oftrue
implies thatAbstractEndpoint.isSSLEnabled()
will also returntrue
.- Specified by:
isAlpnSupported
in classAbstractEndpoint<Long,
Long> - Returns:
true
if the endpoint supports ALPN in its current configuration, otherwisefalse
.
-
startInternal
Deprecated.Start the APR endpoint, creating acceptor, poller and sendfile threads.- Specified by:
startInternal
in classAbstractEndpoint<Long,
Long> - Throws:
Exception
-
stopInternal
public void stopInternal()Deprecated.Stop the endpoint. This will cause all processing threads to stop.- Specified by:
stopInternal
in classAbstractEndpoint<Long,
Long>
-
unbind
Deprecated.Deallocate APR memory pools, and close server socket.- Specified by:
unbind
in classAbstractEndpoint<Long,
Long> - Throws:
Exception
-
doCloseServerSocket
protected void doCloseServerSocket()Deprecated.Description copied from class:AbstractEndpoint
Actually close the server socket but don't perform any other clean-up.- Specified by:
doCloseServerSocket
in classAbstractEndpoint<Long,
Long>
-
setSocketOptions
Deprecated.Process the specified connection.- Parameters:
socketWrapper
- The socket wrapper- Returns:
true
if the socket was correctly configured and processing may continue,false
if the socket needs to be close immediately
-
allocatePoller
protected long allocatePoller(int size, long pool, int timeout) Deprecated.Allocate a new poller of the specified size.- Parameters:
size
- The sizepool
- The pool from which the poller will be allocatedtimeout
- The timeout- Returns:
- the poller pointer
-
setSocketOptions
Deprecated.Process given socket. This is called when the socket has been accepted.- Specified by:
setSocketOptions
in classAbstractEndpoint<Long,
Long> - Parameters:
socket
- The socket- Returns:
true
if the socket was correctly configured and processing may continue,false
if the socket needs to be close immediately
-
serverSocketAccept
Deprecated.- Specified by:
serverSocketAccept
in classAbstractEndpoint<Long,
Long> - Throws:
Exception
-
processSocket
Deprecated.Process the given socket. Typically keep alive or upgraded protocol.- Parameters:
socket
- The socket to processevent
- The event to process- Returns:
true
if the processing completed normally otherwisefalse
which indicates an error occurred and that the socket should be closed
-
createSocketProcessor
protected SocketProcessorBase<Long> createSocketProcessor(SocketWrapperBase<Long> socketWrapper, SocketEvent event) Deprecated.- Specified by:
createSocketProcessor
in classAbstractEndpoint<Long,
Long>
-
destroySocket
Deprecated.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 classAbstractEndpoint<Long,
Long> - Parameters:
socket
- The newly accepted socket
-
getLog
Deprecated.- Specified by:
getLog
in classAbstractEndpoint<Long,
Long>
-
getLogCertificate
Deprecated.- Overrides:
getLogCertificate
in classAbstractEndpoint<Long,
Long>
-