Interface DuplexChannelConfig

All Superinterfaces:

ChannelConfig

All Known Subinterfaces:

OioSocketChannelConfig, SocketChannelConfig

All Known Implementing Classes:

DefaultOioSocketChannelConfig, DefaultSocketChannelConfig, EpollDomainSocketChannelConfig, EpollSocketChannelConfig, KQueueDomainSocketChannelConfig, KQueueSocketChannelConfig

public interface DuplexChannelConfig
extends ChannelConfig

A ChannelConfig for a DuplexChannel.

Available options

In addition to the options provided by ChannelConfig, DuplexChannelConfig allows the following options in the option map:

ChannelOption.ALLOW_HALF_CLOSURE

setAllowHalfClosure(boolean)

Method Summary

Modifier and Type	Method	Description
boolean	isAllowHalfClosure()	Returns true if and only if the channel should not close itself when its remote peer shuts down output to make the connection half-closed.
DuplexChannelConfig	setAllocator(ByteBufAllocator allocator)	Set the ByteBufAllocator which is used for the channel to allocate buffers.
DuplexChannelConfig	setAllowHalfClosure(boolean allowHalfClosure)	Sets whether the channel should not close itself when its remote peer shuts down output to make the connection half-closed.
DuplexChannelConfig	setAutoClose(boolean autoClose)	Sets whether the Channel should be closed automatically and immediately on write failure.
DuplexChannelConfig	setAutoRead(boolean autoRead)	Sets if ChannelHandlerContext.read() will be invoked automatically so that a user application doesn't need to call it at all.
DuplexChannelConfig	setMaxMessagesPerRead(int maxMessagesPerRead)	Deprecated.
DuplexChannelConfig	setMessageSizeEstimator(MessageSizeEstimator estimator)	Set the MessageSizeEstimator which is used for the channel to detect the size of a message.
DuplexChannelConfig	setRecvByteBufAllocator(RecvByteBufAllocator allocator)	Set the RecvByteBufAllocator which is used for the channel to allocate receive buffers.
DuplexChannelConfig	setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)	Set the WriteBufferWaterMark which is used for setting the high and low water mark of the write buffer.
DuplexChannelConfig	setWriteSpinCount(int writeSpinCount)	Sets the maximum loop count for a write operation until WritableByteChannel.write(ByteBuffer) returns a non-zero value.

Methods inherited from interface ChannelConfig

getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMessageSizeEstimator, getOption, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setConnectTimeoutMillis, setOption, setOptions, setWriteBufferHighWaterMark, setWriteBufferLowWaterMark

Modifier and Type	Method	Description
ByteBufAllocator	getAllocator()	Returns ByteBufAllocator which is used for the channel to allocate buffers.
int	getConnectTimeoutMillis()	Returns the connect timeout of the channel in milliseconds.
int	getMaxMessagesPerRead()	Deprecated. Use MaxMessagesRecvByteBufAllocator and MaxMessagesRecvByteBufAllocator.maxMessagesPerRead().
MessageSizeEstimator	getMessageSizeEstimator()	Returns MessageSizeEstimator which is used for the channel to detect the size of a message.
<T> T	getOption(ChannelOption<T> option)	Return the value of the given ChannelOption
Map<ChannelOption<?>, Object>	getOptions()	Return all set ChannelOption's.
<T extends RecvByteBufAllocator> T	getRecvByteBufAllocator()	Returns RecvByteBufAllocator 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 the WriteBufferWaterMark 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 until WritableByteChannel.write(ByteBuffer) returns a non-zero value.
boolean	isAutoClose()	Returns true if and only if the Channel will be closed automatically and immediately on write failure.
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.
ChannelConfig	setConnectTimeoutMillis(int connectTimeoutMillis)	Sets the connect timeout of the channel in milliseconds.
<T> boolean	setOption(ChannelOption<T> option, T value)	Sets a configuration property with the specified name and value.
boolean	setOptions(Map<ChannelOption<?>, ?> options)	Sets the configuration properties from the specified Map.
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.

Method Details

isAllowHalfClosure

boolean isAllowHalfClosure()

Returns true if and only if the channel should not close itself when its remote peer shuts down output to make the connection half-closed. If false, the connection is closed automatically when the remote peer shuts down output.

setAllowHalfClosure

DuplexChannelConfig setAllowHalfClosure(boolean allowHalfClosure)

Sets whether the channel should not close itself when its remote peer shuts down output to make the connection half-closed. If true the connection is not closed when the remote peer shuts down output. Instead, ChannelInboundHandler.userEventTriggered(ChannelHandlerContext, Object) is invoked with a ChannelInputShutdownEvent object. If false, the connection is closed automatically.

setMaxMessagesPerRead

@Deprecated
DuplexChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)

Deprecated.

Specified by:

setMaxMessagesPerRead in interface ChannelConfig

setWriteSpinCount

DuplexChannelConfig setWriteSpinCount(int writeSpinCount)

Description copied from interface: ChannelConfig

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.

Specified by:

setWriteSpinCount in interface ChannelConfig

setAllocator

DuplexChannelConfig setAllocator(ByteBufAllocator allocator)

Description copied from interface: ChannelConfig

Set the ByteBufAllocator which is used for the channel to allocate buffers.

Specified by:

setAllocator in interface ChannelConfig

setRecvByteBufAllocator

DuplexChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)

Description copied from interface: ChannelConfig

Set the RecvByteBufAllocator which is used for the channel to allocate receive buffers.

Specified by:

setRecvByteBufAllocator in interface ChannelConfig

setAutoRead

DuplexChannelConfig setAutoRead(boolean autoRead)

Description copied from interface: ChannelConfig

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.

Specified by:

setAutoRead in interface ChannelConfig

setAutoClose

DuplexChannelConfig setAutoClose(boolean autoClose)

Description copied from interface: ChannelConfig

Sets whether the Channel should be closed automatically and immediately on write failure. The default is true.

Specified by:

setAutoClose in interface ChannelConfig

setMessageSizeEstimator

DuplexChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)

Description copied from interface: ChannelConfig

Set the MessageSizeEstimator which is used for the channel to detect the size of a message.

Specified by:

setMessageSizeEstimator in interface ChannelConfig

setWriteBufferWaterMark

DuplexChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)

Description copied from interface: ChannelConfig

Set the WriteBufferWaterMark which is used for setting the high and low water mark of the write buffer.

Specified by:

setWriteBufferWaterMark in interface ChannelConfig