public class EpollChannelConfig extends DefaultChannelConfig
| Modifier and Type | Method and Description |
|---|---|
protected void |
autoReadCleared ()
Is called once
DefaultChannelConfig.setAutoRead(boolean) is called with false and DefaultChannelConfig.isAutoRead() was
true before. |
EpollMode |
getEpollMode ()
Return the
EpollMode used. |
<T> T |
getOption (ChannelOption<T> option)
Return the value of the given
ChannelOption |
java.util.Map<ChannelOption<?>,java.lang.Object> |
getOptions ()
Return all set
ChannelOption's. |
EpollChannelConfig |
setAllocator (ByteBufAllocator allocator)
Set the
ByteBufAllocator which is used for the channel
to allocate buffers. |
EpollChannelConfig |
setAutoRead (boolean autoRead)
Sets if
ChannelHandlerContext.read() will be invoked automatically so that a user application doesn't
need to call it at all. |
EpollChannelConfig |
setConnectTimeoutMillis (int connectTimeoutMillis)
Sets the connect timeout of the channel in milliseconds.
|
EpollChannelConfig |
setEpollMode (EpollMode mode)
Set the
EpollMode used. |
EpollChannelConfig |
setMaxMessagesPerRead (int maxMessagesPerRead)
Sets the maximum number of messages to read per read loop.
|
EpollChannelConfig |
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.
|
EpollChannelConfig |
setRecvByteBufAllocator (RecvByteBufAllocator allocator)
Set the
ByteBufAllocator which is used for the channel
to allocate receive buffers. |
EpollChannelConfig |
setWriteBufferHighWaterMark (int writeBufferHighWaterMark)
Sets the high water mark of the write buffer.
|
EpollChannelConfig |
setWriteBufferLowWaterMark (int writeBufferLowWaterMark)
Sets the low water mark of the write buffer.
|
EpollChannelConfig |
setWriteSpinCount (int writeSpinCount)
Sets the maximum loop count for a write operation until
WritableByteChannel.write(ByteBuffer) returns a non-zero value. |
getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMessageSizeEstimator, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setAutoClose, setOptions, validate clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic java.util.Map<ChannelOption<?>,java.lang.Object> getOptions()
ChannelConfig ChannelOption's.getOptions in interface ChannelConfig getOptions in class DefaultChannelConfig public <T> T getOption(ChannelOption<T> option)
ChannelConfig ChannelOption getOption in interface ChannelConfig getOption in class DefaultChannelConfig public <T> boolean setOption(ChannelOption<T> option, T value)
ChannelConfig
public boolean setOption(ChannelOption<T> option, T value) {
if (super.setOption(option, value)) {
return true;
}
if (option.equals(additionalOption)) {
....
return true;
}
return false;
}
setOption in interface ChannelConfig setOption in class DefaultChannelConfig true if and only if the property has been setpublic EpollChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)
ChannelConfig Channel does not support connect operation, this property is not
used at all, and therefore will be ignored.setConnectTimeoutMillis in interface ChannelConfig setConnectTimeoutMillis in class DefaultChannelConfig connectTimeoutMillis - the connect timeout in milliseconds.
0 to disable.public EpollChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)
ChannelConfig setMaxMessagesPerRead in interface ChannelConfig setMaxMessagesPerRead in class DefaultChannelConfig public EpollChannelConfig setWriteSpinCount(int writeSpinCount)
ChannelConfig 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.setWriteSpinCount in interface ChannelConfig setWriteSpinCount in class DefaultChannelConfig public EpollChannelConfig setAllocator(ByteBufAllocator allocator)
ChannelConfig ByteBufAllocator which is used for the channel
to allocate buffers.setAllocator in interface ChannelConfig setAllocator in class DefaultChannelConfig public EpollChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)
ChannelConfig ByteBufAllocator which is used for the channel
to allocate receive buffers.setRecvByteBufAllocator in interface ChannelConfig setRecvByteBufAllocator in class DefaultChannelConfig public EpollChannelConfig setAutoRead(boolean autoRead)
ChannelConfig ChannelHandlerContext.read() will be invoked automatically so that a user application doesn't
need to call it at all. The default value is true.setAutoRead in interface ChannelConfig setAutoRead in class DefaultChannelConfig public EpollChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)
ChannelConfig Channel.isWritable()
will start to return false.setWriteBufferHighWaterMark in interface ChannelConfig setWriteBufferHighWaterMark in class DefaultChannelConfig public EpollChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)
ChannelConfig Channel.isWritable() will start to return
true again.setWriteBufferLowWaterMark in interface ChannelConfig setWriteBufferLowWaterMark in class DefaultChannelConfig public EpollChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)
ChannelConfig MessageSizeEstimator which is used for the channel
to detect the size of a message.setMessageSizeEstimator in interface ChannelConfig setMessageSizeEstimator in class DefaultChannelConfig public EpollMode getEpollMode()
EpollMode used. Default is
EpollMode.EDGE_TRIGGERED. If you want to use DefaultChannelConfig.isAutoRead() false or
DefaultChannelConfig.getMaxMessagesPerRead() and have an accurate behaviour you should use
EpollMode.LEVEL_TRIGGERED.public EpollChannelConfig setEpollMode(EpollMode mode)
EpollMode used. Default is
EpollMode.EDGE_TRIGGERED. If you want to use DefaultChannelConfig.isAutoRead() false or
DefaultChannelConfig.getMaxMessagesPerRead() and have an accurate behaviour you should use
EpollMode.LEVEL_TRIGGERED.
Be aware this config setting can only be adjusted before the channel was registered.protected final void autoReadCleared()
DefaultChannelConfig DefaultChannelConfig.setAutoRead(boolean) is called with false and DefaultChannelConfig.isAutoRead() was
true before.autoReadCleared in class DefaultChannelConfig Copyright © 2008–2018 The Netty Project. All rights reserved.