public interface NioSocketChannelConfig extends SocketChannelConfig
SocketChannelConfig
for a NIO TCP/IP SocketChannel
.
ChannelConfig
and
SocketChannelConfig
, NioSocketChannelConfig
allows the
following options in the option map:
Name | Associated setter method |
---|---|
"writeBufferHighWaterMark" | setWriteBufferHighWaterMark(int) |
"writeBufferLowWaterMark" | setWriteBufferLowWaterMark(int) |
"writeSpinCount" | setWriteSpinCount(int) |
"receiveBufferSizePredictor" | setReceiveBufferSizePredictor(ReceiveBufferSizePredictor) |
"receiveBufferSizePredictorFactory" | setReceiveBufferSizePredictorFactory(ReceiveBufferSizePredictorFactory) |
Modifier and Type | Method and Description |
---|---|
ReceiveBufferSizePredictor |
getReceiveBufferSizePredictor()
Returns the
ReceiveBufferSizePredictor which predicts the
number of readable bytes in the socket receive buffer. |
ReceiveBufferSizePredictorFactory |
getReceiveBufferSizePredictorFactory()
Returns the
ReceiveBufferSizePredictorFactory which creates a new
ReceiveBufferSizePredictor when a new channel is created and
no ReceiveBufferSizePredictor was set. |
int |
getWriteBufferHighWaterMark()
Returns the high water mark of the write buffer.
|
int |
getWriteBufferLowWaterMark()
Returns the low water mark of the write buffer.
|
int |
getWriteSpinCount()
Returns the maximum loop count for a write operation until
WritableByteChannel.write(ByteBuffer) returns a non-zero value. |
void |
setReceiveBufferSizePredictor(ReceiveBufferSizePredictor predictor)
Sets the
ReceiveBufferSizePredictor which predicts the
number of readable bytes in the socket receive buffer. |
void |
setReceiveBufferSizePredictorFactory(ReceiveBufferSizePredictorFactory predictorFactory)
Sets the
ReceiveBufferSizePredictor which creates a new
ReceiveBufferSizePredictor when a new channel is created and
no ReceiveBufferSizePredictor was set. |
void |
setWriteBufferHighWaterMark(int writeBufferHighWaterMark)
Sets the high water mark of the write buffer.
|
void |
setWriteBufferLowWaterMark(int writeBufferLowWaterMark)
Sets the low water mark of the write buffer.
|
void |
setWriteSpinCount(int writeSpinCount)
Sets the maximum loop count for a write operation until
WritableByteChannel.write(ByteBuffer) returns a non-zero value. |
getReceiveBufferSize, getSendBufferSize, getSoLinger, getTrafficClass, isKeepAlive, isReuseAddress, isTcpNoDelay, setKeepAlive, setPerformancePreferences, setReceiveBufferSize, setReuseAddress, setSendBufferSize, setSoLinger, setTcpNoDelay, setTrafficClass
getBufferFactory, getConnectTimeoutMillis, getPipelineFactory, setBufferFactory, setConnectTimeoutMillis, setOption, setOptions, setPipelineFactory
int getWriteBufferHighWaterMark()
Channel.isWritable()
will start to return false
.void setWriteBufferHighWaterMark(int writeBufferHighWaterMark)
Channel.isWritable()
will start to return false
.int getWriteBufferLowWaterMark()
Channel.isWritable()
will return
true
again.void setWriteBufferLowWaterMark(int writeBufferLowWaterMark)
Channel.isWritable()
will return
true
again.int getWriteSpinCount()
WritableByteChannel.write(ByteBuffer)
returns a non-zero value.
It is similar to what a spin lock is used for in concurrency programming.
It improves memory utilization and write throughput depending on
the platform that JVM runs on. The default value is 16
.void setWriteSpinCount(int writeSpinCount)
WritableByteChannel.write(ByteBuffer)
returns a non-zero value.
It is similar to what a spin lock is used for in concurrency programming.
It improves memory utilization and write throughput depending on
the platform that JVM runs on. The default value is 16
.IllegalArgumentException
- if the specified value is 0
or less than 0
ReceiveBufferSizePredictor getReceiveBufferSizePredictor()
ReceiveBufferSizePredictor
which predicts the
number of readable bytes in the socket receive buffer. The default
predictor is AdaptiveReceiveBufferSizePredictor
(64, 1024, 65536).void setReceiveBufferSizePredictor(ReceiveBufferSizePredictor predictor)
ReceiveBufferSizePredictor
which predicts the
number of readable bytes in the socket receive buffer. The default
predictor is AdaptiveReceiveBufferSizePredictor
(64, 1024, 65536).ReceiveBufferSizePredictorFactory getReceiveBufferSizePredictorFactory()
ReceiveBufferSizePredictorFactory
which creates a new
ReceiveBufferSizePredictor
when a new channel is created and
no ReceiveBufferSizePredictor
was set. If no predictor was set
for the channel, setReceiveBufferSizePredictor(ReceiveBufferSizePredictor)
will be called with the new predictor. The default factory is
AdaptiveReceiveBufferSizePredictorFactory
(64, 1024, 65536).void setReceiveBufferSizePredictorFactory(ReceiveBufferSizePredictorFactory predictorFactory)
ReceiveBufferSizePredictor
which creates a new
ReceiveBufferSizePredictor
when a new channel is created and
no ReceiveBufferSizePredictor
was set. If no predictor was set
for the channel, setReceiveBufferSizePredictor(ReceiveBufferSizePredictor)
will be called with the new predictor. The default factory is
AdaptiveReceiveBufferSizePredictorFactory
(64, 1024, 65536).Copyright © 2008-2012 JBoss, a division of Red Hat, Inc.. All Rights Reserved.