Package org.apache.tomcat.util.net
Class AprEndpoint
- java.lang.Object
-
- org.apache.tomcat.util.net.AbstractEndpoint<Long,Long>
-
- org.apache.tomcat.util.net.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
Nested Classes Modifier and Type Class Description static classAprEndpoint.AprSocketWrapperDeprecated.classAprEndpoint.PollerDeprecated.classAprEndpoint.SendfileDeprecated.static classAprEndpoint.SendfileDataDeprecated.SendfileData class.static classAprEndpoint.SocketInfoDeprecated.static classAprEndpoint.SocketListDeprecated.protected classAprEndpoint.SocketProcessorDeprecated.This class is the equivalent of the Worker, but will simply use in an external Executor thread pool.static classAprEndpoint.SocketTimeoutsDeprecated.protected classAprEndpoint.SocketWithOptionsProcessorDeprecated.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 protected booleandeferAcceptDeprecated.Defer accept.protected AprEndpoint.PollerpollerDeprecated.The socket poller.protected intpollTimeDeprecated.Poll interval, in microseconds.protected longrootPoolDeprecated.Root APR memory pool.protected AprEndpoint.SendfilesendfileDeprecated.The static file sender.protected intsendfileSizeDeprecated.Size of the sendfile (= concurrent files which can be served).protected longserverSockDeprecated.Server socket "pointer".protected longserverSockPoolDeprecated.APR memory pool for the server socket.protected longsslContextDeprecated.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
Constructors Constructor Description AprEndpoint()Deprecated.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected longallocatePoller(int size, long pool, int timeout)Deprecated.Allocate a new poller of the specified size.voidbind()Deprecated.Initialize the endpoint.protected SocketProcessorBase<Long>createSocketProcessor(SocketWrapperBase<Long> socketWrapper, SocketEvent event)Deprecated.protected voidcreateSSLContext(SSLHostConfig sslHostConfig)Deprecated.Create the SSLContextfor the the given SSLHostConfig.protected voiddestroySocket(Long socket)Deprecated.Close the socket.protected voiddoCloseServerSocket()Deprecated.Actually close the server socket but don't perform any other clean-up.booleangetDeferAccept()Deprecated.StringgetId()Deprecated.The default behavior is to identify connectors uniquely with address and port.booleangetIpv6v6only()Deprecated.intgetKeepAliveCount()Deprecated.Obtain the number of kept alive sockets.InetSocketAddressgetLocalAddress()Deprecated.Obtain the network address the server socket is bound to.protected LoggetLog()Deprecated.AprEndpoint.PollergetPoller()Deprecated.intgetPollTime()Deprecated.AprEndpoint.SendfilegetSendfile()Deprecated.intgetSendfileCount()Deprecated.Obtain the number of sendfile sockets.intgetSendfileSize()Deprecated.longgetSslContext(String sniHostName)Deprecated.This callback is made during the TLS handshake when the client uses the SNI extension to request a specific TLS host.StringgetUnixDomainSocketPath()Deprecated.StringgetUnixDomainSocketPathPermissions()Deprecated.booleanisAlpnSupported()Deprecated.Identifies if the endpoint supports ALPN.protected booleanprocessSocket(long socket, SocketEvent event)Deprecated.Process the given socket.protected LongserverSocketAccept()Deprecated.voidsetDeferAccept(boolean deferAccept)Deprecated.voidsetIpv6v6only(boolean ipv6v6only)Deprecated.voidsetMaxConnections(int maxConnections)Deprecated.This endpoint does not support-1for unlimited connections, nor does it support setting this attribute while the endpoint is running.voidsetPollTime(int pollTime)Deprecated.voidsetSendfileSize(int sendfileSize)Deprecated.protected booleansetSocketOptions(Long socket)Deprecated.Process given socket.protected booleansetSocketOptions(SocketWrapperBase<Long> socketWrapper)Deprecated.Process the specified connection.voidsetUnixDomainSocketPath(String unixDomainSocketPath)Deprecated.voidsetUnixDomainSocketPathPermissions(String unixDomainSocketPathPermissions)Deprecated.voidsetUseSendfile(boolean useSendfile)Deprecated.voidstartInternal()Deprecated.Start the APR endpoint, creating acceptor, poller and sendfile threads.voidstopInternal()Deprecated.Stop the endpoint.voidunbind()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, getAcceptCount, getAcceptorThreadPriority, getAddress, getAttribute, getBindOnInit, getBindState, getConnectionCount, getConnectionLinger, getConnections, getConnectionTimeout, getCurrentThreadCount, getCurrentThreadsBusy, getDaemon, getDefaultSSLHostConfigName, getDomain, getExecutor, getExecutorTerminationTimeoutMillis, getHandler, getKeepAliveTimeout, getLocalPort, getMaxConnections, getMaxKeepAliveRequests, getMaxThreads, getMinSpareThreads, getName, getPort, getPortOffset, getPortWithOffset, getProperty, getSocketProperties, getSSLHostConfig, getTcpNoDelay, getThreadPriority, getUseAsyncIO, getUseSendfile, getUtilityExecutor, hasNegotiableProtocols, init, initializeConnectionLatch, isPaused, isRunning, isSSLEnabled, pause, processSocket, releaseSSLContext, reloadSslHostConfig, reloadSslHostConfigs, removeSslHostConfig, resume, setAcceptCount, setAcceptorThreadPriority, setAddress, setAttribute, setBindOnInit, setConnectionLinger, setConnectionTimeout, setDaemon, setDefaultSSLHostConfigName, setDomain, setExecutor, setExecutorTerminationTimeoutMillis, setHandler, setKeepAliveTimeout, setMaxKeepAliveRequests, setMaxThreads, setMinSpareThreads, setName, setPort, setPortOffset, setProperty, setSSLEnabled, setTcpNoDelay, setThreadPriority, setUseAsyncIO, setUtilityExecutor, shutdownExecutor, start, startAcceptorThread, stop, toTimeout, unlockAccept
-
-
-
-
Field Detail
-
rootPool
protected long rootPool
Deprecated.Root APR memory pool.
-
serverSock
protected volatile long serverSock
Deprecated.Server socket "pointer".
-
serverSockPool
protected long serverSockPool
Deprecated.APR memory pool for the server socket.
-
sslContext
protected long sslContext
Deprecated.SSL context.
-
deferAccept
protected boolean deferAccept
Deprecated.Defer accept.
-
sendfileSize
protected int sendfileSize
Deprecated.Size of the sendfile (= concurrent files which can be served).
-
pollTime
protected int pollTime
Deprecated.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
protected AprEndpoint.Poller poller
Deprecated.The socket poller.
-
sendfile
protected AprEndpoint.Sendfile sendfile
Deprecated.The static file sender.
-
-
Method Detail
-
setDeferAccept
public void setDeferAccept(boolean deferAccept)
Deprecated.
-
getDeferAccept
public boolean getDeferAccept()
Deprecated.- Overrides:
getDeferAcceptin 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:
setUseSendfilein classAbstractEndpoint<Long,Long>
-
getPoller
public AprEndpoint.Poller getPoller()
Deprecated.
-
getSendfile
public AprEndpoint.Sendfile getSendfile()
Deprecated.
-
getLocalAddress
public InetSocketAddress getLocalAddress() throws IOException
Deprecated.Description copied from class:AbstractEndpointObtain 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:
getLocalAddressin 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-1for unlimited connections, nor does it support setting this attribute while the endpoint is running.- Overrides:
setMaxConnectionsin classAbstractEndpoint<Long,Long>
-
getUnixDomainSocketPath
public String getUnixDomainSocketPath()
Deprecated.
-
setUnixDomainSocketPath
public void setUnixDomainSocketPath(String unixDomainSocketPath)
Deprecated.
-
getUnixDomainSocketPathPermissions
public String getUnixDomainSocketPathPermissions()
Deprecated.
-
setUnixDomainSocketPathPermissions
public void setUnixDomainSocketPathPermissions(String unixDomainSocketPathPermissions)
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
public String getId()
Deprecated.Description copied from class:AbstractEndpointThe 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:
getIdin classAbstractEndpoint<Long,Long>- Returns:
- the id
-
bind
public void bind() throws ExceptionDeprecated.Initialize the endpoint.- Specified by:
bindin classAbstractEndpoint<Long,Long>- Throws:
Exception
-
createSSLContext
protected void createSSLContext(SSLHostConfig sslHostConfig) throws Exception
Deprecated.Description copied from class:AbstractEndpointCreate the SSLContextfor the the given SSLHostConfig.- Specified by:
createSSLContextin 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
public long getSslContext(String sniHostName)
Deprecated.Description copied from interface:SSLContext.SNICallBackThis callback is made during the TLS handshake when the client uses the SNI extension to request a specific TLS host.- Specified by:
getSslContextin 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
-
isAlpnSupported
public boolean isAlpnSupported()
Deprecated.Description copied from class:AbstractEndpointIdentifies if the endpoint supports ALPN. Note that a return value oftrueimplies thatAbstractEndpoint.isSSLEnabled()will also returntrue.- Specified by:
isAlpnSupportedin classAbstractEndpoint<Long,Long>- Returns:
trueif the endpoint supports ALPN in its current configuration, otherwisefalse.
-
startInternal
public void startInternal() throws ExceptionDeprecated.Start the APR endpoint, creating acceptor, poller and sendfile threads.- Specified by:
startInternalin classAbstractEndpoint<Long,Long>- Throws:
Exception
-
stopInternal
public void stopInternal()
Deprecated.Stop the endpoint. This will cause all processing threads to stop.- Specified by:
stopInternalin classAbstractEndpoint<Long,Long>
-
unbind
public void unbind() throws ExceptionDeprecated.Deallocate APR memory pools, and close server socket.- Specified by:
unbindin classAbstractEndpoint<Long,Long>- Throws:
Exception
-
doCloseServerSocket
protected void doCloseServerSocket()
Deprecated.Description copied from class:AbstractEndpointActually close the server socket but don't perform any other clean-up.- Specified by:
doCloseServerSocketin classAbstractEndpoint<Long,Long>
-
setSocketOptions
protected boolean setSocketOptions(SocketWrapperBase<Long> socketWrapper)
Deprecated.Process the specified connection.- Parameters:
socketWrapper- The socket wrapper- Returns:
trueif the socket was correctly configured and processing may continue,falseif 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
protected boolean setSocketOptions(Long socket)
Deprecated.Process given socket. This is called when the socket has been accepted.- Specified by:
setSocketOptionsin classAbstractEndpoint<Long,Long>- Parameters:
socket- The socket- Returns:
trueif the socket was correctly configured and processing may continue,falseif the socket needs to be close immediately
-
serverSocketAccept
protected Long serverSocketAccept() throws Exception
Deprecated.- Specified by:
serverSocketAcceptin classAbstractEndpoint<Long,Long>- Throws:
Exception
-
processSocket
protected boolean processSocket(long socket, SocketEvent event)Deprecated.Process the given socket. Typically keep alive or upgraded protocol.- Parameters:
socket- The socket to processevent- The event to process- Returns:
trueif the processing completed normally otherwisefalsewhich indicates an error occurred and that the socket should be closed
-
createSocketProcessor
protected SocketProcessorBase<Long> createSocketProcessor(SocketWrapperBase<Long> socketWrapper, SocketEvent event)
Deprecated.- Specified by:
createSocketProcessorin classAbstractEndpoint<Long,Long>
-
destroySocket
protected void destroySocket(Long socket)
Deprecated.Description copied from class:AbstractEndpointClose 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:
destroySocketin classAbstractEndpoint<Long,Long>- Parameters:
socket- The newly accepted socket
-
getLog
protected Log getLog()
Deprecated.- Specified by:
getLogin classAbstractEndpoint<Long,Long>
-
-