Netty/Transport 4.1.107.Final · io.netty.channel.ChannelConfig

A set of configuration properties of a Channel.

Please down-cast to more specific configuration type such as SocketChannelConfig or use setOptions(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 a Channel without down-casting its associated ChannelConfig. To update an option map, please call setOptions(Map).

All ChannelConfig has the following options:

Name	Associated setter method
`ChannelOption#CONNECT_TIMEOUT_MILLIS`	`setConnectTimeoutMillis(int)`
`ChannelOption#WRITE_SPIN_COUNT`	`setWriteSpinCount(int)`
`ChannelOption#WRITE_BUFFER_WATER_MARK`	`setWriteBufferWaterMark(WriteBufferWaterMark)`
`ChannelOption#ALLOCATOR`	`setAllocator(ByteBufAllocator)`
`ChannelOption#AUTO_READ`	`setAutoRead(boolean)`

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 in SocketChannelConfig.

Method Summary

Modifier and Type	Method and Description
public ByteBufAllocator	getAllocator() Returns `ByteBufAllocator` which is used for the channel to allocate buffers.
public int	Returns: the connect timeout in milliseconds. `0` if disabled. getConnectTimeoutMillis() Returns the connect timeout of the channel in milliseconds.
public int	getMaxMessagesPerRead() Deprecated Use `MaxMessagesRecvByteBufAllocator` and `MaxMessagesRecvByteBufAllocator#maxMessagesPerRead()`.
public MessageSizeEstimator	getMessageSizeEstimator() Returns `MessageSizeEstimator` which is used for the channel to detect the size of a message.
public <T> T	getOption(ChannelOption<T> option) Return the value of the given `ChannelOption`
public Map<ChannelOption<?>, Object>	getOptions() Return all set `ChannelOption`'s.
public <T extends RecvByteBufAllocator> T	getRecvByteBufAllocator() Returns `RecvByteBufAllocator` which is used for the channel to allocate receive buffers.
public int	getWriteBufferHighWaterMark() Returns the high water mark of the write buffer.
public int	getWriteBufferLowWaterMark() Returns the low water mark of the write buffer.
public WriteBufferWaterMark	getWriteBufferWaterMark() Returns the `WriteBufferWaterMark` which is used for setting the high and low water mark of the write buffer.
public int	getWriteSpinCount() Returns the maximum loop count for a write operation until `WritableByteChannel#write(ByteBuffer)` returns a non-zero value.
public boolean	isAutoClose() Returns `true` if and only if the `Channel` will be closed automatically and immediately on write failure.
public boolean	isAutoRead() Returns `true` if and only if `ChannelHandlerContext#read()` will be invoked automatically so that a user application doesn't need to call it at all.
public ChannelConfig	setAllocator(ByteBufAllocator allocator) Set the `ByteBufAllocator` which is used for the channel to allocate buffers.
public ChannelConfig	setAutoClose(boolean autoClose) Sets whether the `Channel` should be closed automatically and immediately on write failure.
public ChannelConfig	setAutoRead(boolean autoRead) Sets if `ChannelHandlerContext#read()` will be invoked automatically so that a user application doesn't need to call it at all.
public ChannelConfig	setConnectTimeoutMillis(int the connect timeout in milliseconds. `0` to disable. connectTimeoutMillis) Sets the connect timeout of the channel in milliseconds.
public ChannelConfig	setMaxMessagesPerRead(int maxMessagesPerRead) Deprecated Use `MaxMessagesRecvByteBufAllocator` and `MaxMessagesRecvByteBufAllocator#maxMessagesPerRead(int)`.
public ChannelConfig	setMessageSizeEstimator(MessageSizeEstimator estimator) Set the `MessageSizeEstimator` which is used for the channel to detect the size of a message.
public <T> boolean	Returns: `true` if and only if the property has been set setOption(ChannelOption<T> option, T value) Sets a configuration property with the specified name and value.
public boolean	setOptions(Map<ChannelOption<?>, ?> options) Sets the configuration properties from the specified `Map`.
public ChannelConfig	setRecvByteBufAllocator(RecvByteBufAllocator allocator) Set the `RecvByteBufAllocator` which is used for the channel to allocate receive buffers.
public ChannelConfig	setWriteBufferHighWaterMark(int writeBufferHighWaterMark) Sets the high water mark of the write buffer.
public ChannelConfig	setWriteBufferLowWaterMark(int writeBufferLowWaterMark) Sets the low water mark of the write buffer.
public ChannelConfig	setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark) Set the `WriteBufferWaterMark` which is used for setting the high and low water mark of the write buffer.
public ChannelConfig	setWriteSpinCount(int writeSpinCount) Sets the maximum loop count for a write operation until `WritableByteChannel#write(ByteBuffer)` returns a non-zero value.

Method Detail

getAllocator	back to summary
public ByteBufAllocator getAllocator() Returns `ByteBufAllocator` which is used for the channel to allocate buffers.

getConnectTimeoutMillis back to summary

getConnectTimeoutMillis	back to summary
public int getConnectTimeoutMillis() Returns the connect timeout of the channel in milliseconds. If the `Channel` does not support connect operation, this property is not used at all, and therefore will be ignored. Returns:int the connect timeout in milliseconds. `0` if disabled.

public int getConnectTimeoutMillis()

Returns the connect timeout of the channel in milliseconds. If the Channel does not support connect operation, this property is not used at all, and therefore will be ignored.

Returns:int: the connect timeout in milliseconds. 0 if disabled.

getMaxMessagesPerRead	back to summary
public int getMaxMessagesPerRead() Deprecated Use `MaxMessagesRecvByteBufAllocator` and `MaxMessagesRecvByteBufAllocator#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. Annotations @Deprecated

getMessageSizeEstimator	back to summary
public MessageSizeEstimator getMessageSizeEstimator() Returns `MessageSizeEstimator` which is used for the channel to detect the size of a message.

getOption	back to summary
public <T> T getOption(ChannelOption<T> option) Return the value of the given `ChannelOption`

getOptions	back to summary
public Map<ChannelOption<?>, Object> getOptions() Return all set `ChannelOption`'s.

getRecvByteBufAllocator	back to summary
public <T extends RecvByteBufAllocator> T getRecvByteBufAllocator() Returns `RecvByteBufAllocator` which is used for the channel to allocate receive buffers.

getWriteBufferHighWaterMark	back to summary
public 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 return `false`.

getWriteBufferLowWaterMark	back to summary
public 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 return `true` again.

getWriteBufferWaterMark	back to summary
public WriteBufferWaterMark getWriteBufferWaterMark() Returns the `WriteBufferWaterMark` which is used for setting the high and low water mark of the write buffer.

getWriteSpinCount	back to summary
public int getWriteSpinCount() Returns the maximum loop count for a write operation until `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`.

isAutoClose	back to summary
public boolean isAutoClose() Returns `true` if and only if the `Channel` will be closed automatically and immediately on write failure. The default is `true`.

isAutoRead	back to summary
public boolean isAutoRead() Returns `true` if and only if `ChannelHandlerContext#read()` will be invoked automatically so that a user application doesn't need to call it at all. The default value is `true`.

setAllocator	back to summary
public ChannelConfig setAllocator(ByteBufAllocator allocator) Set the `ByteBufAllocator` which is used for the channel to allocate buffers.

setAutoClose	back to summary
public ChannelConfig setAutoClose(boolean autoClose) Sets whether the `Channel` should be closed automatically and immediately on write failure. The default is `true`.

setAutoRead	back to summary
public ChannelConfig setAutoRead(boolean autoRead) Sets if `ChannelHandlerContext#read()` will be invoked automatically so that a user application doesn't need to call it at all. The default value is `true`.

setConnectTimeoutMillis back to summary

setConnectTimeoutMillis	back to summary
public ChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis) Sets the connect timeout of the channel in milliseconds. If the `Channel` does not support connect operation, this property is not used at all, and therefore will be ignored. Parameters connectTimeoutMillis:int the connect timeout in milliseconds. `0` to disable.

public ChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)

Sets the connect timeout of the channel in milliseconds. If the Channel does not support connect operation, this property is not used at all, and therefore will be ignored.

Parameters

connectTimeoutMillis:int: the connect timeout in milliseconds. 0 to disable.

setMaxMessagesPerRead	back to summary
public ChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead) Deprecated Use `MaxMessagesRecvByteBufAllocator` and `MaxMessagesRecvByteBufAllocator#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. Annotations @Deprecated

setMessageSizeEstimator	back to summary
public ChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator) Set the `MessageSizeEstimator` which is used for the channel to detect the size of a message.

setOption back to summary

setOption	back to summary
public <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:boolean `true` if and only if the property has been set

public <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:boolean: true if and only if the property has been set

setOptions	back to summary
public boolean setOptions(Map<ChannelOption<?>, ?> options) Sets the configuration properties from the specified `Map`.

setRecvByteBufAllocator	back to summary
public ChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator) Set the `RecvByteBufAllocator` which is used for the channel to allocate receive buffers.

setWriteBufferHighWaterMark	back to summary
public 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 return `false`.

setWriteBufferLowWaterMark	back to summary
public 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 return `true` again.

setWriteBufferWaterMark	back to summary
public ChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark) Set the `WriteBufferWaterMark` which is used for setting the high and low water mark of the write buffer.

setWriteSpinCount back to summary

setWriteSpinCount	back to summary
public ChannelConfig setWriteSpinCount(int writeSpinCount) Sets the maximum loop count for a write operation until `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`. Exceptions IllegalArgumentException: if the specified value is `0` or less than `0`

public ChannelConfig setWriteSpinCount(int writeSpinCount)

Sets the maximum loop count for a write operation until 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.

Exceptions

IllegalArgumentException:: if the specified value is 0 or less than 0

public Interface ChannelConfig

Option map

Method Summary

Method Detail