Package io.netty.channel.uring

Class IoUringChannelConfig

java.lang.Object

io.netty.channel.DefaultChannelConfig

io.netty.channel.uring.IoUringChannelConfig

All Implemented Interfaces:

ChannelConfig

Direct Known Subclasses:

IoUringDatagramChannelConfig, IoUringServerSocketChannelConfig, IoUringStreamChannelConfig

abstract class IoUringChannelConfig
extends DefaultChannelConfig

Field Summary

Fields inherited from class io.netty.channel.DefaultChannelConfig

channel

Constructor Summary

Constructors

Constructor	Description
IoUringChannelConfig(AbstractIoUringChannel channel)
IoUringChannelConfig(AbstractIoUringChannel channel, RecvByteBufAllocator allocator)

Method Summary

Modifier and Type	Method	Description
protected void	autoReadCleared()	Is called once DefaultChannelConfig.setAutoRead(boolean) is called with false and DefaultChannelConfig.isAutoRead() was true before.
<T> T	getOption(ChannelOption<T> option)	Return the value of the given ChannelOption
IoUringChannelConfig	setAllocator(ByteBufAllocator allocator)	Set the ByteBufAllocator which is used for the channel to allocate buffers.
IoUringChannelConfig	setAutoClose(boolean autoClose)	Sets whether the Channel should be closed automatically and immediately on write failure.
IoUringChannelConfig	setAutoRead(boolean autoRead)	Sets if ChannelHandlerContext.read() will be invoked automatically so that a user application doesn't need to call it at all.
IoUringChannelConfig	setConnectTimeoutMillis(int connectTimeoutMillis)	Sets the connect timeout of the channel in milliseconds.
IoUringChannelConfig	setMaxMessagesPerRead(int maxMessagesPerRead)
IoUringChannelConfig	setMaxMessagesPerWrite(int maxMessagesPerWrite)	Set the maximum number of message to write per eventloop run.
IoUringChannelConfig	setMessageSizeEstimator(MessageSizeEstimator estimator)	Set the MessageSizeEstimator 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.
IoUringChannelConfig	setRecvByteBufAllocator(RecvByteBufAllocator allocator)	Set the RecvByteBufAllocator which is used for the channel to allocate receive buffers.
IoUringChannelConfig	setWriteBufferHighWaterMark(int writeBufferHighWaterMark)	Sets the high water mark of the write buffer.
IoUringChannelConfig	setWriteBufferLowWaterMark(int writeBufferLowWaterMark)	Sets the low water mark of the write buffer.
IoUringChannelConfig	setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)	Set the WriteBufferWaterMark which is used for setting the high and low water mark of the write buffer.
IoUringChannelConfig	setWriteSpinCount(int writeSpinCount)	Sets the maximum loop count for a write operation until WritableByteChannel.write(ByteBuffer) returns a non-zero value.

Methods inherited from class io.netty.channel.DefaultChannelConfig

getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMaxMessagesPerWrite, getMessageSizeEstimator, getOptions, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setOptions, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IoUringChannelConfig

IoUringChannelConfig(AbstractIoUringChannel channel)

IoUringChannelConfig

IoUringChannelConfig(AbstractIoUringChannel channel,
                     RecvByteBufAllocator allocator)

Method Detail

getOption

public <T> T getOption(ChannelOption<T> option)

Description copied from interface: ChannelConfig

Return the value of the given ChannelOption

Specified by:

getOption in interface ChannelConfig

Overrides:

getOption in class DefaultChannelConfig

setOption

public <T> boolean setOption(ChannelOption<T> option,
                             T value)

Description copied from interface: ChannelConfig

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;
 }
 

Specified by:

setOption in interface ChannelConfig

Overrides:

setOption in class DefaultChannelConfig

Returns:

true if and only if the property has been set

setMaxMessagesPerRead

public IoUringChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)

Description copied from class: DefaultChannelConfig

Specified by:

setMaxMessagesPerRead in interface ChannelConfig

Overrides:

setMaxMessagesPerRead in class DefaultChannelConfig

setConnectTimeoutMillis

public IoUringChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)

Description copied from interface: ChannelConfig

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.

Specified by:

setConnectTimeoutMillis in interface ChannelConfig

Overrides:

setConnectTimeoutMillis in class DefaultChannelConfig

Parameters:

connectTimeoutMillis - the connect timeout in milliseconds. 0 to disable.

setMaxMessagesPerWrite

public IoUringChannelConfig setMaxMessagesPerWrite(int maxMessagesPerWrite)

Description copied from class: DefaultChannelConfig

Set the maximum number of message to write per eventloop run. Once this limit is reached we will continue to process other events before trying to write the remaining messages.

Overrides:

setMaxMessagesPerWrite in class DefaultChannelConfig

setWriteSpinCount

public IoUringChannelConfig 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

Overrides:

setWriteSpinCount in class DefaultChannelConfig

setAllocator

public IoUringChannelConfig 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

Overrides:

setAllocator in class DefaultChannelConfig

setRecvByteBufAllocator

public IoUringChannelConfig 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

Overrides:

setRecvByteBufAllocator in class DefaultChannelConfig

setAutoRead

public IoUringChannelConfig 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

Overrides:

setAutoRead in class DefaultChannelConfig

setAutoClose

public IoUringChannelConfig 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

Overrides:

setAutoClose in class DefaultChannelConfig

setWriteBufferLowWaterMark

public IoUringChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)

Description copied from interface: ChannelConfig

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.

Specified by:

setWriteBufferLowWaterMark in interface ChannelConfig

Overrides:

setWriteBufferLowWaterMark in class DefaultChannelConfig

setMessageSizeEstimator

public IoUringChannelConfig 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

Overrides:

setMessageSizeEstimator in class DefaultChannelConfig

setWriteBufferWaterMark

public IoUringChannelConfig 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

Overrides:

setWriteBufferWaterMark in class DefaultChannelConfig

setWriteBufferHighWaterMark

public IoUringChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)

Description copied from interface: ChannelConfig

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.

Specified by:

setWriteBufferHighWaterMark in interface ChannelConfig

Overrides:

setWriteBufferHighWaterMark in class DefaultChannelConfig

autoReadCleared

protected void autoReadCleared()

Description copied from class: DefaultChannelConfig

Is called once DefaultChannelConfig.setAutoRead(boolean) is called with false and DefaultChannelConfig.isAutoRead() was true before.

Overrides:

autoReadCleared in class DefaultChannelConfig