SocketProperties (Apache Tomcat 7.0.28 API Documentation)

Overview

Package

Class

Tree

Deprecated

Index

Help

Apache Tomcat 7.0.28

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.tomcat.util.net
Class SocketProperties

java.lang.Object
  org.apache.tomcat.util.net.SocketProperties

public class SocketProperties
extends Object
extends Object

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

Author:: Filip Hanik

Field Summary
`protected int`	`appReadBufSize` The application read buffer size in bytes.
`protected int`	`appWriteBufSize` The application write buffer size in bytes Default value is txBufSize
`protected int`	`bufferPool` NioChannel pool size for the endpoint, this value is how many channels -1 means unlimited cached, 0 means no cache Default value is 500
`protected int`	`bufferPoolSize` Buffer pool size in bytes to be cached -1 means unlimited, 0 means no cache Default value is 100MB (10241024100 bytes)
`protected boolean`	`directBuffer` Enable/disable direct buffers for the network buffers Default value is enabled
`protected int`	`eventCache` 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 int`	`keyCache` Enable/disable key cache, this bounded cache stores KeyAttachment objects to reduce GC Default is 500 -1 is unlimited 0 is disabled
`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 500 -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. default is 20000.
`protected Integer`	`soTrafficClass` Traffic class option, value between 0 and 255 IPTOS_LOWCOST (0x02) IPTOS_RELIABILITY (0x04) IPTOS_THROUGHPUT (0x08) IPTOS_LOWDELAY (0x10) JVM default used if not set
`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
`SocketProperties()`

Method Summary
`int`	`getAppReadBufSize()`
`int`	`getAppWriteBufSize()`
`int`	`getBufferPool()`
`int`	`getBufferPoolSize()`
`boolean`	`getDirectBuffer()`
`int`	`getDirectBufferPool()`
`int`	`getEventCache()`
`int`	`getKeyCache()`
`boolean`	`getOoBInline()`
`int`	`getPerformanceBandwidth()`
`int`	`getPerformanceConnectionTime()`
`int`	`getPerformanceLatency()`
`int`	`getProcessorCache()`
`int`	`getRxBufSize()`
`boolean`	`getSoKeepAlive()`
`boolean`	`getSoLingerOn()`
`int`	`getSoLingerTime()`
`boolean`	`getSoReuseAddress()`
`int`	`getSoTimeout()`
`int`	`getSoTrafficClass()`
`boolean`	`getTcpNoDelay()`
`long`	`getTimeoutInterval()`
`int`	`getTxBufSize()`
`int`	`getUnlockTimeout()`
`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`	`setEventCache(int eventCache)`
`void`	`setKeyCache(int keyCache)`
`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`	`setRxBufSize(int rxBufSize)`
`void`	`setSoKeepAlive(boolean soKeepAlive)`
`void`	`setSoLingerOn(boolean soLingerOn)`
`void`	`setSoLingerTime(int soLingerTime)`
`void`	`setSoReuseAddress(boolean soReuseAddress)`
`void`	`setSoTimeout(int soTimeout)`
`void`	`setSoTrafficClass(int soTrafficClass)`
`void`	`setTcpNoDelay(boolean tcpNoDelay)`
`void`	`setTimeoutInterval(long timeoutInterval)`
`void`	`setTxBufSize(int txBufSize)`
`void`	`setUnlockTimeout(int unlockTimeout)`

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

Field Detail

keyCache

protected int keyCache

Enable/disable key cache, this bounded cache stores KeyAttachment objects to reduce GC Default is 500 -1 is unlimited 0 is disabled

processorCache

protected int processorCache

Enable/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 eventCache

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.

directBuffer

protected boolean directBuffer

Enable/disable direct buffers for the network buffers Default value is enabled

rxBufSize

protected Integer rxBufSize

Socket receive buffer size in bytes (SO_RCVBUF). JVM default used if not set.

txBufSize

protected Integer txBufSize

Socket send buffer size in bytes (SO_SNDBUF). JVM default used if not set.

appReadBufSize

protected int appReadBufSize

The application read buffer size in bytes. Default value is rxBufSize

appWriteBufSize

protected int appWriteBufSize

The application write buffer size in bytes Default value is txBufSize

bufferPool

protected int bufferPool

NioChannel 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 bufferPoolSize

Buffer pool size in bytes to be cached -1 means unlimited, 0 means no cache Default value is 100MB (1024*1024*100 bytes)

tcpNoDelay

protected Boolean tcpNoDelay

TCP_NO_DELAY option. JVM default used if not set.

soKeepAlive

protected Boolean soKeepAlive

SO_KEEPALIVE option. JVM default used if not set.

ooBInline

protected Boolean ooBInline

OOBINLINE option. JVM default used if not set.

soReuseAddress

protected Boolean soReuseAddress

SO_REUSEADDR option. JVM default used if not set.

soLingerOn

protected Boolean soLingerOn

SO_LINGER option, paired with the soLingerTime value. JVM defaults used unless both attributes are set.

soLingerTime

protected Integer soLingerTime

SO_LINGER option, paired with the soLingerOn value. JVM defaults used unless both attributes are set.

soTimeout

protected Integer soTimeout

SO_TIMEOUT option. default is 20000.

soTrafficClass

protected Integer soTrafficClass

Traffic class option, value between 0 and 255 IPTOS_LOWCOST (0x02) IPTOS_RELIABILITY (0x04) IPTOS_THROUGHPUT (0x08) IPTOS_LOWDELAY (0x10) JVM default used if not set

performanceConnectionTime

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

protected Integer performanceLatency

performanceBandwidth

protected Integer performanceBandwidth

timeoutInterval

protected long timeoutInterval

The minimum frequency of the timeout interval to avoid excess load from the poller during high traffic

unlockTimeout

protected int unlockTimeout

Timeout in milliseconds for an unlock to take place.

Constructor Detail