Package org.apache.tomcat.util.net
Class SocketProperties
java.lang.Object
org.apache.tomcat.util.net.SocketProperties
Properties that can be set in the <Connector> element
in server.xml. All properties are prefixed with "socket."
and are currently only working for the Nio connector
-
Field Summary
Modifier and TypeFieldDescriptionprotected int
The application read buffer size in bytes.protected int
The application write buffer size in bytes Default value is txBufSizeprotected int
NioChannel pool size for the endpoint, this value is how many channels -1 means unlimited cached, 0 means no cache Default value is 500protected int
Buffer pool size in bytes to be cached -1 means unlimited, 0 means no cache Default value is 100MB (1024*1024*100 bytes)protected boolean
Enable/disable direct buffers for the network buffers Default value is disabledprotected boolean
Enable/disable direct buffers for the network buffers for SSL Default value is disabledprotected int
Enable/disable poller event cache, this bounded cache stores PollerEvent objects to reduce GC for the poller Default is 500 -1 is unlimited 0 is disabled >0 the max number of objects to keep in cache.protected Boolean
OOBINLINE option.protected Integer
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
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
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
Enable/disable socket processor cache, this bounded cache stores SocketProcessor objects to reduce GC Default is 500 -1 is unlimited 0 is disabledprotected Integer
Socket receive buffer size in bytes (SO_RCVBUF).protected Boolean
SO_KEEPALIVE option.protected Boolean
SO_LINGER option, paired with thesoLingerTime
value.protected Integer
SO_LINGER option, paired with thesoLingerOn
value.protected Boolean
SO_REUSEADDR option.protected Integer
SO_TIMEOUT option. default is 20000.protected Boolean
TCP_NO_DELAY option.protected long
The minimum frequency of the timeout interval to avoid excess load from the poller during high trafficprotected Integer
Socket send buffer size in bytes (SO_SNDBUF).protected int
Timeout in milliseconds for an unlock to take place. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionint
int
int
int
boolean
int
boolean
int
boolean
int
int
int
int
int
boolean
boolean
int
boolean
int
boolean
long
int
int
void
setAppReadBufSize
(int appReadBufSize) void
setAppWriteBufSize
(int appWriteBufSize) void
setBufferPool
(int bufferPool) void
setBufferPoolSize
(int bufferPoolSize) void
setDirectBuffer
(boolean directBuffer) void
setDirectBufferPool
(int directBufferPool) void
setDirectSslBuffer
(boolean directSslBuffer) void
setEventCache
(int eventCache) void
setOoBInline
(boolean ooBInline) void
setPerformanceBandwidth
(int performanceBandwidth) void
setPerformanceConnectionTime
(int performanceConnectionTime) void
setPerformanceLatency
(int performanceLatency) void
setProcessorCache
(int processorCache) void
setProperties
(ServerSocket socket) void
setProperties
(Socket socket) void
void
void
setRxBufSize
(int rxBufSize) void
setSoKeepAlive
(boolean soKeepAlive) void
setSoLingerOn
(boolean soLingerOn) void
setSoLingerTime
(int soLingerTime) void
setSoReuseAddress
(boolean soReuseAddress) void
setSoTimeout
(int soTimeout) void
setTcpNoDelay
(boolean tcpNoDelay) void
setTimeoutInterval
(long timeoutInterval) void
setTxBufSize
(int txBufSize) void
setUnlockTimeout
(int unlockTimeout)
-
Field Details
-
processorCache
protected int processorCacheEnable/disable socket processor cache, this bounded cache stores SocketProcessor objects to reduce GC Default is 500 -1 is unlimited 0 is disabled -
eventCache
protected int eventCacheEnable/disable poller event cache, this bounded cache stores PollerEvent objects to reduce GC for the poller Default is 500 -1 is unlimited 0 is disabled >0 the max number of objects to keep in cache. -
directBuffer
protected boolean directBufferEnable/disable direct buffers for the network buffers Default value is disabled -
directSslBuffer
protected boolean directSslBufferEnable/disable direct buffers for the network buffers for SSL Default value is disabled -
rxBufSize
Socket receive buffer size in bytes (SO_RCVBUF). JVM default used if not set. -
txBufSize
Socket send buffer size in bytes (SO_SNDBUF). JVM default used if not set. -
appReadBufSize
protected int appReadBufSizeThe application read buffer size in bytes. Default value is rxBufSize -
appWriteBufSize
protected int appWriteBufSizeThe application write buffer size in bytes Default value is txBufSize -
bufferPool
protected int bufferPoolNioChannel pool size for the endpoint, this value is how many channels -1 means unlimited cached, 0 means no cache Default value is 500 -
bufferPoolSize
protected int bufferPoolSizeBuffer pool size in bytes to be cached -1 means unlimited, 0 means no cache Default value is 100MB (1024*1024*100 bytes) -
tcpNoDelay
TCP_NO_DELAY option. JVM default used if not set. -
soKeepAlive
SO_KEEPALIVE option. JVM default used if not set. -
ooBInline
OOBINLINE option. JVM default used if not set. -
soReuseAddress
SO_REUSEADDR option. JVM default used if not set. -
soLingerOn
SO_LINGER option, paired with thesoLingerTime
value. JVM defaults used unless both attributes are set. -
soLingerTime
SO_LINGER option, paired with thesoLingerOn
value. JVM defaults used unless both attributes are set. -
soTimeout
SO_TIMEOUT option. default is 20000. -
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
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. -
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. -
timeoutInterval
protected long timeoutIntervalThe minimum frequency of the timeout interval to avoid excess load from the poller during high traffic -
unlockTimeout
protected int unlockTimeoutTimeout in milliseconds for an unlock to take place.
-
-
Constructor Details
-
SocketProperties
public SocketProperties()
-
-
Method Details
-
setProperties
- Throws:
SocketException
-
setProperties
- Throws:
SocketException
-
setProperties
- Throws:
IOException
-
setProperties
- Throws:
IOException
-
getDirectBuffer
public boolean getDirectBuffer() -
getDirectSslBuffer
public boolean getDirectSslBuffer() -
getOoBInline
public boolean getOoBInline() -
getPerformanceBandwidth
public int getPerformanceBandwidth() -
getPerformanceConnectionTime
public int getPerformanceConnectionTime() -
getPerformanceLatency
public int getPerformanceLatency() -
getRxBufSize
public int getRxBufSize() -
getSoKeepAlive
public boolean getSoKeepAlive() -
getSoLingerOn
public boolean getSoLingerOn() -
getSoLingerTime
public int getSoLingerTime() -
getSoReuseAddress
public boolean getSoReuseAddress() -
getSoTimeout
public int getSoTimeout() -
getTcpNoDelay
public boolean getTcpNoDelay() -
getTxBufSize
public int getTxBufSize() -
getBufferPool
public int getBufferPool() -
getBufferPoolSize
public int getBufferPoolSize() -
getEventCache
public int getEventCache() -
getAppReadBufSize
public int getAppReadBufSize() -
getAppWriteBufSize
public int getAppWriteBufSize() -
getProcessorCache
public int getProcessorCache() -
getTimeoutInterval
public long getTimeoutInterval() -
getDirectBufferPool
public int getDirectBufferPool() -
setPerformanceConnectionTime
public void setPerformanceConnectionTime(int performanceConnectionTime) -
setTxBufSize
public void setTxBufSize(int txBufSize) -
setTcpNoDelay
public void setTcpNoDelay(boolean tcpNoDelay) -
setSoTimeout
public void setSoTimeout(int soTimeout) -
setSoReuseAddress
public void setSoReuseAddress(boolean soReuseAddress) -
setSoLingerTime
public void setSoLingerTime(int soLingerTime) -
setSoKeepAlive
public void setSoKeepAlive(boolean soKeepAlive) -
setRxBufSize
public void setRxBufSize(int rxBufSize) -
setPerformanceLatency
public void setPerformanceLatency(int performanceLatency) -
setPerformanceBandwidth
public void setPerformanceBandwidth(int performanceBandwidth) -
setOoBInline
public void setOoBInline(boolean ooBInline) -
setDirectBuffer
public void setDirectBuffer(boolean directBuffer) -
setDirectSslBuffer
public void setDirectSslBuffer(boolean directSslBuffer) -
setSoLingerOn
public void setSoLingerOn(boolean soLingerOn) -
setBufferPool
public void setBufferPool(int bufferPool) -
setBufferPoolSize
public void setBufferPoolSize(int bufferPoolSize) -
setEventCache
public void setEventCache(int eventCache) -
setAppReadBufSize
public void setAppReadBufSize(int appReadBufSize) -
setAppWriteBufSize
public void setAppWriteBufSize(int appWriteBufSize) -
setProcessorCache
public void setProcessorCache(int processorCache) -
setTimeoutInterval
public void setTimeoutInterval(long timeoutInterval) -
setDirectBufferPool
public void setDirectBufferPool(int directBufferPool) -
getUnlockTimeout
public int getUnlockTimeout() -
setUnlockTimeout
public void setUnlockTimeout(int unlockTimeout)
-