Class IoUringChannelConfig
java.lang.Object
io.netty.channel.DefaultChannelConfig
io.netty.channel.uring.IoUringChannelConfig
- All Implemented Interfaces:
ChannelConfig
- Direct Known Subclasses:
IoUringDatagramChannelConfig, IoUringServerSocketChannelConfig, IoUringStreamChannelConfig
-
Field Summary
Fields inherited from class DefaultChannelConfig
channel -
Constructor Summary
ConstructorsConstructorDescriptionIoUringChannelConfig(AbstractIoUringChannel channel, RecvByteBufAllocator allocator) -
Method Summary
Modifier and TypeMethodDescriptionprotected voidIs called onceDefaultChannelConfig.setAutoRead(boolean)is called withfalseandDefaultChannelConfig.isAutoRead()wastruebefore.<T> TgetOption(ChannelOption<T> option) Return the value of the givenChannelOptionsetAllocator(ByteBufAllocator allocator) Set theByteBufAllocatorwhich is used for the channel to allocate buffers.setAutoClose(boolean autoClose) Sets whether theChannelshould be closed automatically and immediately on write failure.setAutoRead(boolean autoRead) Sets ifChannelHandlerContext.read()will be invoked automatically so that a user application doesn't need to call it at all.setConnectTimeoutMillis(int connectTimeoutMillis) Sets the connect timeout of the channel in milliseconds.setMaxMessagesPerRead(int maxMessagesPerRead) setMaxMessagesPerWrite(int maxMessagesPerWrite) Set the maximum number of message to write per eventloop run.setMessageSizeEstimator(MessageSizeEstimator estimator) Set theMessageSizeEstimatorwhich is used for the channel to detect the size of a message.<T> booleansetOption(ChannelOption<T> option, T value) Sets a configuration property with the specified name and value.setRecvByteBufAllocator(RecvByteBufAllocator allocator) Set theRecvByteBufAllocatorwhich is used for the channel to allocate receive buffers.setWriteBufferHighWaterMark(int writeBufferHighWaterMark) Sets the high water mark of the write buffer.setWriteBufferLowWaterMark(int writeBufferLowWaterMark) Sets the low water mark of the write buffer.setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark) Set theWriteBufferWaterMarkwhich is used for setting the high and low water mark of the write buffer.setWriteSpinCount(int writeSpinCount) Sets the maximum loop count for a write operation untilWritableByteChannel.write(ByteBuffer)returns a non-zero value.Methods inherited from class DefaultChannelConfig
getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMaxMessagesPerWrite, getMessageSizeEstimator, getOptions, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setOptions, validate
-
Constructor Details
-
IoUringChannelConfig
IoUringChannelConfig(AbstractIoUringChannel channel) -
IoUringChannelConfig
IoUringChannelConfig(AbstractIoUringChannel channel, RecvByteBufAllocator allocator)
-
-
Method Details
-
getOption
Description copied from interface:ChannelConfigReturn the value of the givenChannelOption- Specified by:
getOptionin interfaceChannelConfig- Overrides:
getOptionin classDefaultChannelConfig
-
setOption
Description copied from interface:ChannelConfigSets 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:
setOptionin interfaceChannelConfig- Overrides:
setOptionin classDefaultChannelConfig- Returns:
trueif and only if the property has been set
-
setMaxMessagesPerRead
Description copied from class:DefaultChannelConfig- Specified by:
setMaxMessagesPerReadin interfaceChannelConfig- Overrides:
setMaxMessagesPerReadin classDefaultChannelConfig
-
setConnectTimeoutMillis
Description copied from interface:ChannelConfigSets the connect timeout of the channel in milliseconds. If theChanneldoes not support connect operation, this property is not used at all, and therefore will be ignored.- Specified by:
setConnectTimeoutMillisin interfaceChannelConfig- Overrides:
setConnectTimeoutMillisin classDefaultChannelConfig- Parameters:
connectTimeoutMillis- the connect timeout in milliseconds.0to disable.
-
setMaxMessagesPerWrite
Description copied from class:DefaultChannelConfigSet 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:
setMaxMessagesPerWritein classDefaultChannelConfig
-
setWriteSpinCount
Description copied from interface:ChannelConfigSets 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.- Specified by:
setWriteSpinCountin interfaceChannelConfig- Overrides:
setWriteSpinCountin classDefaultChannelConfig
-
setAllocator
Description copied from interface:ChannelConfigSet theByteBufAllocatorwhich is used for the channel to allocate buffers.- Specified by:
setAllocatorin interfaceChannelConfig- Overrides:
setAllocatorin classDefaultChannelConfig
-
setRecvByteBufAllocator
Description copied from interface:ChannelConfigSet theRecvByteBufAllocatorwhich is used for the channel to allocate receive buffers.- Specified by:
setRecvByteBufAllocatorin interfaceChannelConfig- Overrides:
setRecvByteBufAllocatorin classDefaultChannelConfig
-
setAutoRead
Description copied from interface:ChannelConfigSets ifChannelHandlerContext.read()will be invoked automatically so that a user application doesn't need to call it at all. The default value istrue.- Specified by:
setAutoReadin interfaceChannelConfig- Overrides:
setAutoReadin classDefaultChannelConfig
-
setAutoClose
Description copied from interface:ChannelConfigSets whether theChannelshould be closed automatically and immediately on write failure. The default istrue.- Specified by:
setAutoClosein interfaceChannelConfig- Overrides:
setAutoClosein classDefaultChannelConfig
-
setWriteBufferLowWaterMark
Description copied from interface:ChannelConfigSets 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 returntrueagain.- Specified by:
setWriteBufferLowWaterMarkin interfaceChannelConfig- Overrides:
setWriteBufferLowWaterMarkin classDefaultChannelConfig
-
setMessageSizeEstimator
Description copied from interface:ChannelConfigSet theMessageSizeEstimatorwhich is used for the channel to detect the size of a message.- Specified by:
setMessageSizeEstimatorin interfaceChannelConfig- Overrides:
setMessageSizeEstimatorin classDefaultChannelConfig
-
setWriteBufferWaterMark
Description copied from interface:ChannelConfigSet theWriteBufferWaterMarkwhich is used for setting the high and low water mark of the write buffer.- Specified by:
setWriteBufferWaterMarkin interfaceChannelConfig- Overrides:
setWriteBufferWaterMarkin classDefaultChannelConfig
-
setWriteBufferHighWaterMark
Description copied from interface:ChannelConfigSets 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.- Specified by:
setWriteBufferHighWaterMarkin interfaceChannelConfig- Overrides:
setWriteBufferHighWaterMarkin classDefaultChannelConfig
-
autoReadCleared
protected void autoReadCleared()Description copied from class:DefaultChannelConfigIs called onceDefaultChannelConfig.setAutoRead(boolean)is called withfalseandDefaultChannelConfig.isAutoRead()wastruebefore.- Overrides:
autoReadClearedin classDefaultChannelConfig
-