Interface ChannelConfig
-
- All Known Subinterfaces:
DatagramChannelConfig
,DomainDatagramChannelConfig
,DomainSocketChannelConfig
,DuplexChannelConfig
,OioDatagramChannelConfig
,OioServerSocketChannelConfig
,OioSocketChannelConfig
,RxtxChannelConfig
,SctpChannelConfig
,SctpServerChannelConfig
,ServerSocketChannelConfig
,SocketChannelConfig
,UdtChannelConfig
,UdtServerChannelConfig
- All Known Implementing Classes:
DefaultChannelConfig
,DefaultDatagramChannelConfig
,DefaultOioServerSocketChannelConfig
,DefaultOioSocketChannelConfig
,DefaultSctpChannelConfig
,DefaultSctpServerChannelConfig
,DefaultServerSocketChannelConfig
,DefaultSocketChannelConfig
,DefaultUdtChannelConfig
,DefaultUdtServerChannelConfig
,EpollChannelConfig
,EpollDatagramChannelConfig
,EpollDomainDatagramChannelConfig
,EpollDomainSocketChannelConfig
,EpollServerChannelConfig
,EpollServerSocketChannelConfig
,EpollSocketChannelConfig
,KQueueChannelConfig
,KQueueDatagramChannelConfig
,KQueueDomainDatagramChannelConfig
,KQueueDomainSocketChannelConfig
,KQueueServerChannelConfig
,KQueueServerSocketChannelConfig
,KQueueSocketChannelConfig
public interface ChannelConfig
A set of configuration properties of aChannel
.Please down-cast to more specific configuration type such as
SocketChannelConfig
or usesetOptions(Map)
to set the transport-specific properties:Channel
ch = ...;SocketChannelConfig
cfg = (SocketChannelConfig
) ch.getConfig(); cfg.setTcpNoDelay(false);Option map
An option map property is a dynamic write-only property which allows the configuration of aChannel
without down-casting its associatedChannelConfig
. To update an option map, please callsetOptions(Map)
.All
ChannelConfig
has the following options:More options are available in the sub-types of
ChannelConfig
. For example, you can configure the parameters which are specific to a TCP/IP socket as explained inSocketChannelConfig
.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description ByteBufAllocator
getAllocator()
ReturnsByteBufAllocator
which is used for the channel to allocate buffers.int
getConnectTimeoutMillis()
Returns the connect timeout of the channel in milliseconds.int
getMaxMessagesPerRead()
Deprecated.MessageSizeEstimator
getMessageSizeEstimator()
ReturnsMessageSizeEstimator
which is used for the channel to detect the size of a message.<T> T
getOption(ChannelOption<T> option)
Return the value of the givenChannelOption
java.util.Map<ChannelOption<?>,java.lang.Object>
getOptions()
Return all setChannelOption
's.<T extends RecvByteBufAllocator>
TgetRecvByteBufAllocator()
ReturnsRecvByteBufAllocator
which is used for the channel to allocate receive buffers.int
getWriteBufferHighWaterMark()
Returns the high water mark of the write buffer.int
getWriteBufferLowWaterMark()
Returns the low water mark of the write buffer.WriteBufferWaterMark
getWriteBufferWaterMark()
Returns theWriteBufferWaterMark
which is used for setting the high and low water mark of the write buffer.int
getWriteSpinCount()
Returns the maximum loop count for a write operation untilWritableByteChannel.write(ByteBuffer)
returns a non-zero value.boolean
isAutoClose()
Returnstrue
if and only if theChannel
will be closed automatically and immediately on write failure.boolean
isAutoRead()
Returnstrue
if and only ifChannelHandlerContext.read()
will be invoked automatically so that a user application doesn't need to call it at all.ChannelConfig
setAllocator(ByteBufAllocator allocator)
Set theByteBufAllocator
which is used for the channel to allocate buffers.ChannelConfig
setAutoClose(boolean autoClose)
Sets whether theChannel
should be closed automatically and immediately on write failure.ChannelConfig
setAutoRead(boolean autoRead)
Sets ifChannelHandlerContext.read()
will be invoked automatically so that a user application doesn't need to call it at all.ChannelConfig
setConnectTimeoutMillis(int connectTimeoutMillis)
Sets the connect timeout of the channel in milliseconds.ChannelConfig
setMaxMessagesPerRead(int maxMessagesPerRead)
Deprecated.ChannelConfig
setMessageSizeEstimator(MessageSizeEstimator estimator)
Set theMessageSizeEstimator
which is used for the channel to detect the size of a message.<T> boolean
setOption(ChannelOption<T> option, T value)
Sets a configuration property with the specified name and value.boolean
setOptions(java.util.Map<ChannelOption<?>,?> options)
Sets the configuration properties from the specifiedMap
.ChannelConfig
setRecvByteBufAllocator(RecvByteBufAllocator allocator)
Set theRecvByteBufAllocator
which is used for the channel to allocate receive buffers.ChannelConfig
setWriteBufferHighWaterMark(int writeBufferHighWaterMark)
Sets the high water mark of the write buffer.ChannelConfig
setWriteBufferLowWaterMark(int writeBufferLowWaterMark)
Sets the low water mark of the write buffer.ChannelConfig
setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)
Set theWriteBufferWaterMark
which is used for setting the high and low water mark of the write buffer.ChannelConfig
setWriteSpinCount(int writeSpinCount)
Sets the maximum loop count for a write operation untilWritableByteChannel.write(ByteBuffer)
returns a non-zero value.
-
-
-
Method Detail
-
getOptions
java.util.Map<ChannelOption<?>,java.lang.Object> getOptions()
Return all setChannelOption
's.
-
setOptions
boolean setOptions(java.util.Map<ChannelOption<?>,?> options)
Sets the configuration properties from the specifiedMap
.
-
getOption
<T> T getOption(ChannelOption<T> option)
Return the value of the givenChannelOption
-
setOption
<T> boolean setOption(ChannelOption<T> option, T value)
Sets a configuration property with the specified name and value. To override this method properly, you must call the super class:public boolean setOption(ChannelOption<T> option, T value) { if (super.setOption(option, value)) { return true; } if (option.equals(additionalOption)) { .... return true; } return false; }
- Returns:
true
if and only if the property has been set
-
getConnectTimeoutMillis
int getConnectTimeoutMillis()
Returns the connect timeout of the channel in milliseconds. If theChannel
does not support connect operation, this property is not used at all, and therefore will be ignored.- Returns:
- the connect timeout in milliseconds.
0
if disabled.
-
setConnectTimeoutMillis
ChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)
Sets the connect timeout of the channel in milliseconds. If theChannel
does not support connect operation, this property is not used at all, and therefore will be ignored.- Parameters:
connectTimeoutMillis
- the connect timeout in milliseconds.0
to disable.
-
getMaxMessagesPerRead
@Deprecated int getMaxMessagesPerRead()
Deprecated.UseMaxMessagesRecvByteBufAllocator
andMaxMessagesRecvByteBufAllocator.maxMessagesPerRead()
.Returns the maximum number of messages to read per read loop. a
channelRead()
event. If this value is greater than 1, an event loop might attempt to read multiple times to procure multiple messages.
-
setMaxMessagesPerRead
@Deprecated ChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)
Deprecated.UseMaxMessagesRecvByteBufAllocator
andMaxMessagesRecvByteBufAllocator.maxMessagesPerRead(int)
.Sets the maximum number of messages to read per read loop. If this value is greater than 1, an event loop might attempt to read multiple times to procure multiple messages.
-
getWriteSpinCount
int getWriteSpinCount()
Returns the maximum loop count for a write operation untilWritableByteChannel.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 is16
.
-
setWriteSpinCount
ChannelConfig setWriteSpinCount(int writeSpinCount)
Sets the maximum loop count for a write operation untilWritableByteChannel.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 is16
.- Throws:
java.lang.IllegalArgumentException
- if the specified value is0
or less than0
-
getAllocator
ByteBufAllocator getAllocator()
ReturnsByteBufAllocator
which is used for the channel to allocate buffers.
-
setAllocator
ChannelConfig setAllocator(ByteBufAllocator allocator)
Set theByteBufAllocator
which is used for the channel to allocate buffers.
-
getRecvByteBufAllocator
<T extends RecvByteBufAllocator> T getRecvByteBufAllocator()
ReturnsRecvByteBufAllocator
which is used for the channel to allocate receive buffers.
-
setRecvByteBufAllocator
ChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)
Set theRecvByteBufAllocator
which is used for the channel to allocate receive buffers.
-
isAutoRead
boolean isAutoRead()
Returnstrue
if and only ifChannelHandlerContext.read()
will be invoked automatically so that a user application doesn't need to call it at all. The default value istrue
.
-
setAutoRead
ChannelConfig setAutoRead(boolean autoRead)
Sets ifChannelHandlerContext.read()
will be invoked automatically so that a user application doesn't need to call it at all. The default value istrue
.
-
isAutoClose
boolean isAutoClose()
Returnstrue
if and only if theChannel
will be closed automatically and immediately on write failure. The default istrue
.
-
setAutoClose
ChannelConfig setAutoClose(boolean autoClose)
Sets whether theChannel
should be closed automatically and immediately on write failure. The default istrue
.
-
getWriteBufferHighWaterMark
int getWriteBufferHighWaterMark()
Returns the high water mark of the write buffer. If the number of bytes queued in the write buffer exceeds this value,Channel.isWritable()
will start to returnfalse
.
-
setWriteBufferHighWaterMark
ChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)
Sets the high water mark of the write buffer. If the number of bytes queued in the write buffer exceeds this value,
Channel.isWritable()
will start to returnfalse
.
-
getWriteBufferLowWaterMark
int getWriteBufferLowWaterMark()
Returns the low water mark of the write buffer. Once the number of bytes queued in the write buffer exceeded the high water mark and then dropped down below this value,Channel.isWritable()
will start to returntrue
again.
-
setWriteBufferLowWaterMark
ChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)
Sets the low water mark of the write buffer. Once the number of bytes queued in the write buffer exceeded the high water mark and then dropped down below this value,
Channel.isWritable()
will start to returntrue
again.
-
getMessageSizeEstimator
MessageSizeEstimator getMessageSizeEstimator()
ReturnsMessageSizeEstimator
which is used for the channel to detect the size of a message.
-
setMessageSizeEstimator
ChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)
Set theMessageSizeEstimator
which is used for the channel to detect the size of a message.
-
getWriteBufferWaterMark
WriteBufferWaterMark getWriteBufferWaterMark()
Returns theWriteBufferWaterMark
which is used for setting the high and low water mark of the write buffer.
-
setWriteBufferWaterMark
ChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)
Set theWriteBufferWaterMark
which is used for setting the high and low water mark of the write buffer.
-
-