Tomcat 10.1.19 · org.apache.tomcat.util.net.SocketProperties

Field Summary

Modifier and Type	Field and Description
protected int	appReadBufSize The application read buffer size in bytes.
protected int	appWriteBufSize The application write buffer size in bytes Default value is 8192
protected int	bufferPool NioChannel pool size for the endpoint, this value is how many channels -1 means unlimited cached, 0 means no cache, -2 means bufferPoolSize will be used Default value is -2
protected int	bufferPoolSize Buffer pool size in bytes to be cached -1 means unlimited, 0 means no cache Default value is based on the max memory reported by the JVM, if less than 1GB, then 0, else the value divided by 32.
protected boolean	directBuffer Enable/disable direct buffers for the network buffers Default value is disabled
protected boolean	directSslBuffer Enable/disable direct buffers for the network buffers for SSL Default value is disabled
protected int	eventCache Enable/disable poller event cache, this bounded cache stores PollerEvent objects to reduce GC for the poller Default is 0 -1 is unlimited 0 is disabled >0 the max number of objects to keep in cache.
private ObjectName	oname
protected Boolean	ooBInline OOBINLINE option.
protected Integer	performanceBandwidth Performance preferences according to http://docs.oracle.com/javase/1.5.0/docs/api/java/net/Socket.html#setPerformancePreferences(int,%20int,%20int) All three performance attributes must be set or the JVM defaults will be used.
protected Integer	performanceConnectionTime Performance preferences according to http://docs.oracle.com/javase/1.5.0/docs/api/java/net/Socket.html#setPerformancePreferences(int,%20int,%20int) All three performance attributes must be set or the JVM defaults will be used.
protected Integer	performanceLatency Performance preferences according to http://docs.oracle.com/javase/1.5.0/docs/api/java/net/Socket.html#setPerformancePreferences(int,%20int,%20int) All three performance attributes must be set or the JVM defaults will be used.
protected int	processorCache Enable/disable socket processor cache, this bounded cache stores SocketProcessor objects to reduce GC Default is 0 -1 is unlimited 0 is disabled
protected Integer	rxBufSize Socket receive buffer size in bytes (SO_RCVBUF).
protected Boolean	soKeepAlive SO_KEEPALIVE option.
protected Boolean	soLingerOn SO_LINGER option, paired with the `soLingerTime` value.
protected Integer	soLingerTime SO_LINGER option, paired with the `soLingerOn` value.
protected Boolean	soReuseAddress SO_REUSEADDR option.
protected Integer	soTimeout SO_TIMEOUT option.
protected Boolean	tcpNoDelay TCP_NO_DELAY option.
protected long	timeoutInterval The minimum frequency of the timeout interval to avoid excess load from the poller during high traffic
protected Integer	txBufSize Socket send buffer size in bytes (SO_SNDBUF).
protected int	unlockTimeout Timeout in milliseconds for an unlock to take place.

Constructor Summary

Access	Constructor and Description
public	SocketProperties()

Method Summary

Modifier and Type	Method and Description
public int	Returns: the actual buffer pool size that will be used getActualBufferPool(int When TLS is enabled, additional network buffers are needed and will be added to the application buffer size bufferOverhead) Get the actual buffer pool size to use.
public int	getAppReadBufSize()
public int	getAppWriteBufSize()
public int	getBufferPool()
public int	getBufferPoolSize()
public boolean	getDirectBuffer()
public int	getDirectBufferPool()
public boolean	getDirectSslBuffer()
public int	getEventCache()
pack-priv ObjectName	getObjectName()
public boolean	getOoBInline()
public int	getPerformanceBandwidth()
public int	getPerformanceConnectionTime()
public int	getPerformanceLatency()
public int	getProcessorCache()
public int	getRxBufSize()
public boolean	getSoKeepAlive()
public boolean	getSoLingerOn()
public int	getSoLingerTime()
public boolean	getSoReuseAddress()
public int	getSoTimeout()
public boolean	getTcpNoDelay()
public long	getTimeoutInterval()
public int	getTxBufSize()
public int	getUnlockTimeout()
public void	setAppReadBufSize(int appReadBufSize)
public void	setAppWriteBufSize(int appWriteBufSize)
public void	setBufferPool(int bufferPool)
public void	setBufferPoolSize(int bufferPoolSize)
public void	setDirectBuffer(boolean directBuffer)
public void	setDirectBufferPool(int directBufferPool)
public void	setDirectSslBuffer(boolean directSslBuffer)
public void	setEventCache(int eventCache)
pack-priv void	setObjectName(ObjectName oname)
public void	setOoBInline(boolean ooBInline)
public void	setPerformanceBandwidth(int performanceBandwidth)
public void	setPerformanceConnectionTime(int performanceConnectionTime)
public void	setPerformanceLatency(int performanceLatency)
public void	setProcessorCache(int processorCache)
public void	setProperties(Socket socket)
public void	setProperties(ServerSocket socket)
public void	setProperties(AsynchronousSocketChannel socket)
public void	setProperties(AsynchronousServerSocketChannel socket)
public void	setRxBufSize(int rxBufSize)
public void	setSoKeepAlive(boolean soKeepAlive)
public void	setSoLingerOn(boolean soLingerOn)
public void	setSoLingerTime(int soLingerTime)
public void	setSoReuseAddress(boolean soReuseAddress)
public void	setSoTimeout(int soTimeout)
public void	setTcpNoDelay(boolean tcpNoDelay)
public void	setTimeoutInterval(long timeoutInterval)
public void	setTxBufSize(int txBufSize)
public void	setUnlockTimeout(int unlockTimeout)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

appReadBufSize	back to summary
protected int appReadBufSize The application read buffer size in bytes. Default value is 8192

appWriteBufSize	back to summary
protected int appWriteBufSize The application write buffer size in bytes Default value is 8192

bufferPool	back to summary
protected int bufferPool NioChannel pool size for the endpoint, this value is how many channels -1 means unlimited cached, 0 means no cache, -2 means bufferPoolSize will be used Default value is -2

bufferPoolSize	back to summary
protected int bufferPoolSize Buffer pool size in bytes to be cached -1 means unlimited, 0 means no cache Default value is based on the max memory reported by the JVM, if less than 1GB, then 0, else the value divided by 32. This value will then be used to compute bufferPool if its value is -2

directBuffer	back to summary
protected boolean directBuffer Enable/disable direct buffers for the network buffers Default value is disabled

directSslBuffer	back to summary
protected boolean directSslBuffer Enable/disable direct buffers for the network buffers for SSL Default value is disabled

eventCache	back to summary
protected int eventCache Enable/disable poller event cache, this bounded cache stores PollerEvent objects to reduce GC for the poller Default is 0 -1 is unlimited 0 is disabled >0 the max number of objects to keep in cache.

oname	back to summary
private ObjectName oname

ooBInline	back to summary
protected Boolean ooBInline OOBINLINE option. JVM default used if not set.

performanceBandwidth	back to summary
protected Integer performanceBandwidth Performance preferences according to http://docs.oracle.com/javase/1.5.0/docs/api/java/net/Socket.html#setPerformancePreferences(int,%20int,%20int) All three performance attributes must be set or the JVM defaults will be used.

performanceConnectionTime	back to summary
protected Integer performanceConnectionTime Performance preferences according to http://docs.oracle.com/javase/1.5.0/docs/api/java/net/Socket.html#setPerformancePreferences(int,%20int,%20int) All three performance attributes must be set or the JVM defaults will be used.

performanceLatency	back to summary
protected Integer performanceLatency Performance preferences according to http://docs.oracle.com/javase/1.5.0/docs/api/java/net/Socket.html#setPerformancePreferences(int,%20int,%20int) All three performance attributes must be set or the JVM defaults will be used.

processorCache	back to summary
protected int processorCache Enable/disable socket processor cache, this bounded cache stores SocketProcessor objects to reduce GC Default is 0 -1 is unlimited 0 is disabled

rxBufSize	back to summary
protected Integer rxBufSize Socket receive buffer size in bytes (SO_RCVBUF). JVM default used if not set.

soKeepAlive	back to summary
protected Boolean soKeepAlive SO_KEEPALIVE option. JVM default used if not set.

soLingerOn	back to summary
protected Boolean soLingerOn SO_LINGER option, paired with the `soLingerTime` value. JVM defaults used unless both attributes are set.

soLingerTime	back to summary
protected Integer soLingerTime SO_LINGER option, paired with the `soLingerOn` value. JVM defaults used unless both attributes are set.

soReuseAddress	back to summary
protected Boolean soReuseAddress SO_REUSEADDR option. JVM default used if not set.

soTimeout	back to summary
protected Integer soTimeout SO_TIMEOUT option. default is 20000.

tcpNoDelay	back to summary
protected Boolean tcpNoDelay TCP_NO_DELAY option. JVM default used if not set.

timeoutInterval	back to summary
protected long timeoutInterval The minimum frequency of the timeout interval to avoid excess load from the poller during high traffic

txBufSize	back to summary
protected Integer txBufSize Socket send buffer size in bytes (SO_SNDBUF). JVM default used if not set.

unlockTimeout	back to summary
protected int unlockTimeout Timeout in milliseconds for an unlock to take place.

Constructor Detail

SocketProperties	back to summary
public SocketProperties()

Method Detail

getActualBufferPool	back to summary
public int getActualBufferPool(int bufferOverhead) Get the actual buffer pool size to use. Parameters bufferOverhead:int When TLS is enabled, additional network buffers are needed and will be added to the application buffer size Returns:int the actual buffer pool size that will be used

getActualBufferPool

back to summary

public int getActualBufferPool(int bufferOverhead)

Get the actual buffer pool size to use.

Parameters

bufferOverhead:int: When TLS is enabled, additional network buffers are needed and will be added to the application buffer size

Returns:int

the actual buffer pool size that will be used

getAppReadBufSize	back to summary
public int getAppReadBufSize()

getAppWriteBufSize	back to summary
public int getAppWriteBufSize()

getBufferPool	back to summary
public int getBufferPool()

getBufferPoolSize	back to summary
public int getBufferPoolSize()

getDirectBuffer	back to summary
public boolean getDirectBuffer()

getDirectBufferPool	back to summary
public int getDirectBufferPool()

getDirectSslBuffer	back to summary
public boolean getDirectSslBuffer()

getEventCache	back to summary
public int getEventCache()

getObjectName	back to summary
pack-priv ObjectName getObjectName()

getOoBInline	back to summary
public boolean getOoBInline()

getPerformanceBandwidth	back to summary
public int getPerformanceBandwidth()

getPerformanceConnectionTime	back to summary
public int getPerformanceConnectionTime()

getPerformanceLatency	back to summary
public int getPerformanceLatency()

getProcessorCache	back to summary
public int getProcessorCache()

getRxBufSize	back to summary
public int getRxBufSize()

getSoKeepAlive	back to summary
public boolean getSoKeepAlive()

getSoLingerOn	back to summary
public boolean getSoLingerOn()

getSoLingerTime	back to summary
public int getSoLingerTime()

getSoReuseAddress	back to summary
public boolean getSoReuseAddress()

getSoTimeout	back to summary
public int getSoTimeout()

getTcpNoDelay	back to summary
public boolean getTcpNoDelay()

getTimeoutInterval	back to summary
public long getTimeoutInterval()

getTxBufSize	back to summary
public int getTxBufSize()

getUnlockTimeout	back to summary
public int getUnlockTimeout()

setAppReadBufSize	back to summary
public void setAppReadBufSize(int appReadBufSize)

setAppWriteBufSize	back to summary
public void setAppWriteBufSize(int appWriteBufSize)

setBufferPool	back to summary
public void setBufferPool(int bufferPool)

setBufferPoolSize	back to summary
public void setBufferPoolSize(int bufferPoolSize)

setDirectBuffer	back to summary
public void setDirectBuffer(boolean directBuffer)

setDirectBufferPool	back to summary
public void setDirectBufferPool(int directBufferPool)

setDirectSslBuffer	back to summary
public void setDirectSslBuffer(boolean directSslBuffer)

setEventCache	back to summary
public void setEventCache(int eventCache)

setObjectName	back to summary
pack-priv void setObjectName(ObjectName oname)

setOoBInline	back to summary
public void setOoBInline(boolean ooBInline)

setPerformanceBandwidth	back to summary
public void setPerformanceBandwidth(int performanceBandwidth)

setPerformanceConnectionTime	back to summary
public void setPerformanceConnectionTime(int performanceConnectionTime)

setPerformanceLatency	back to summary
public void setPerformanceLatency(int performanceLatency)

setProcessorCache	back to summary
public void setProcessorCache(int processorCache)

setProperties	back to summary
public void setProperties(Socket socket) throws SocketException

setProperties	back to summary
public void setProperties(ServerSocket socket) throws SocketException

setProperties	back to summary
public void setProperties(AsynchronousSocketChannel socket) throws IOException

setProperties	back to summary
public void setProperties(AsynchronousServerSocketChannel socket) throws IOException

setRxBufSize	back to summary
public void setRxBufSize(int rxBufSize)

setSoKeepAlive	back to summary
public void setSoKeepAlive(boolean soKeepAlive)

setSoLingerOn	back to summary
public void setSoLingerOn(boolean soLingerOn)

setSoLingerTime	back to summary
public void setSoLingerTime(int soLingerTime)

setSoReuseAddress	back to summary
public void setSoReuseAddress(boolean soReuseAddress)

setSoTimeout	back to summary
public void setSoTimeout(int soTimeout)

setTcpNoDelay	back to summary
public void setTcpNoDelay(boolean tcpNoDelay)

setTimeoutInterval	back to summary
public void setTimeoutInterval(long timeoutInterval)

setTxBufSize	back to summary
public void setTxBufSize(int txBufSize)

setUnlockTimeout	back to summary
public void setUnlockTimeout(int unlockTimeout)

public Class SocketProperties

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail