Package io.netty.channel.epoll
Class EpollDomainDatagramChannelConfig
java.lang.Object
io.netty.channel.DefaultChannelConfig
io.netty.channel.epoll.EpollChannelConfig
io.netty.channel.epoll.EpollDomainDatagramChannelConfig
- All Implemented Interfaces:
ChannelConfig
,DomainDatagramChannelConfig
public final class EpollDomainDatagramChannelConfig
extends EpollChannelConfig
implements DomainDatagramChannelConfig
-
Field Summary
FieldsFields inherited from class io.netty.channel.DefaultChannelConfig
channel
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription(package private) boolean
<T> T
getOption
(ChannelOption<T> option) Return the value of the givenChannelOption
Map
<ChannelOption<?>, Object> Return all setChannelOption
's.int
Gets theStandardSocketOptions.SO_SNDBUF
option.private void
setActiveOnOpen
(boolean activeOnOpen) setAllocator
(ByteBufAllocator allocator) Set theByteBufAllocator
which is used for the channel to allocate buffers.setAutoClose
(boolean autoClose) Sets whether theChannel
should 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.setEpollMode
(EpollMode mode) Set theEpollMode
used.setMaxMessagesPerRead
(int maxMessagesPerRead) Deprecated.setMaxMessagesPerWrite
(int maxMessagesPerWrite) Set the maximum number of message to write per eventloop run.setMessageSizeEstimator
(MessageSizeEstimator estimator) Set theMessageSizeEstimator
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.setRecvByteBufAllocator
(RecvByteBufAllocator allocator) Set theRecvByteBufAllocator
which is used for the channel to allocate receive buffers.setSendBufferSize
(int sendBufferSize) Sets theStandardSocketOptions.SO_SNDBUF
option.setWriteBufferWaterMark
(WriteBufferWaterMark writeBufferWaterMark) Set theWriteBufferWaterMark
which 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 io.netty.channel.epoll.EpollChannelConfig
autoReadCleared, getEpollMode, getMaxBytesPerGatheringWrite, setMaxBytesPerGatheringWrite, setWriteBufferHighWaterMark, setWriteBufferLowWaterMark, socket
Methods inherited from class io.netty.channel.DefaultChannelConfig
getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMaxMessagesPerWrite, getMessageSizeEstimator, 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
Methods inherited from interface io.netty.channel.ChannelConfig
getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMessageSizeEstimator, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setOptions, setWriteBufferHighWaterMark, setWriteBufferLowWaterMark
-
Field Details
-
activeOnOpen
private boolean activeOnOpen
-
-
Constructor Details
-
EpollDomainDatagramChannelConfig
EpollDomainDatagramChannelConfig(EpollDomainDatagramChannel channel)
-
-
Method Details
-
getOptions
Description copied from interface:ChannelConfig
Return all setChannelOption
's.- Specified by:
getOptions
in interfaceChannelConfig
- Overrides:
getOptions
in classEpollChannelConfig
-
getOption
Description copied from interface:ChannelConfig
Return the value of the givenChannelOption
- Specified by:
getOption
in interfaceChannelConfig
- Overrides:
getOption
in classEpollChannelConfig
-
setOption
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 interfaceChannelConfig
- Overrides:
setOption
in classEpollChannelConfig
- Returns:
true
if and only if the property has been set
-
setActiveOnOpen
private void setActiveOnOpen(boolean activeOnOpen) -
getActiveOnOpen
boolean getActiveOnOpen() -
setAllocator
Description copied from interface:ChannelConfig
Set theByteBufAllocator
which is used for the channel to allocate buffers.- Specified by:
setAllocator
in interfaceChannelConfig
- Specified by:
setAllocator
in interfaceDomainDatagramChannelConfig
- Overrides:
setAllocator
in classEpollChannelConfig
-
setAutoClose
Description copied from interface:ChannelConfig
Sets whether theChannel
should be closed automatically and immediately on write failure. The default istrue
.- Specified by:
setAutoClose
in interfaceChannelConfig
- Specified by:
setAutoClose
in interfaceDomainDatagramChannelConfig
- Overrides:
setAutoClose
in classDefaultChannelConfig
-
setAutoRead
Description copied from interface:ChannelConfig
Sets 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:
setAutoRead
in interfaceChannelConfig
- Specified by:
setAutoRead
in interfaceDomainDatagramChannelConfig
- Overrides:
setAutoRead
in classEpollChannelConfig
-
setConnectTimeoutMillis
Description copied from interface:ChannelConfig
Sets the connect timeout of the channel in milliseconds. If theChannel
does not support connect operation, this property is not used at all, and therefore will be ignored.- Specified by:
setConnectTimeoutMillis
in interfaceChannelConfig
- Specified by:
setConnectTimeoutMillis
in interfaceDomainDatagramChannelConfig
- Overrides:
setConnectTimeoutMillis
in classEpollChannelConfig
- Parameters:
connectTimeoutMillis
- the connect timeout in milliseconds.0
to disable.
-
setEpollMode
Description copied from class:EpollChannelConfig
Set theEpollMode
used. Default isEpollMode.EDGE_TRIGGERED
. If you want to useDefaultChannelConfig.isAutoRead()
false
orDefaultChannelConfig.getMaxMessagesPerRead()
and have an accurate behaviour you should useEpollMode.LEVEL_TRIGGERED
. Be aware this config setting can only be adjusted before the channel was registered.- Overrides:
setEpollMode
in classEpollChannelConfig
-
setMaxMessagesPerRead
Deprecated.Description copied from class:DefaultChannelConfig
- Specified by:
setMaxMessagesPerRead
in interfaceChannelConfig
- Specified by:
setMaxMessagesPerRead
in interfaceDomainDatagramChannelConfig
- Overrides:
setMaxMessagesPerRead
in classEpollChannelConfig
-
setMaxMessagesPerWrite
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 classDefaultChannelConfig
-
setMessageSizeEstimator
Description copied from interface:ChannelConfig
Set theMessageSizeEstimator
which is used for the channel to detect the size of a message.- Specified by:
setMessageSizeEstimator
in interfaceChannelConfig
- Specified by:
setMessageSizeEstimator
in interfaceDomainDatagramChannelConfig
- Overrides:
setMessageSizeEstimator
in classEpollChannelConfig
-
setRecvByteBufAllocator
Description copied from interface:ChannelConfig
Set theRecvByteBufAllocator
which is used for the channel to allocate receive buffers.- Specified by:
setRecvByteBufAllocator
in interfaceChannelConfig
- Specified by:
setRecvByteBufAllocator
in interfaceDomainDatagramChannelConfig
- Overrides:
setRecvByteBufAllocator
in classEpollChannelConfig
-
setSendBufferSize
Description copied from interface:DomainDatagramChannelConfig
Sets theStandardSocketOptions.SO_SNDBUF
option.- Specified by:
setSendBufferSize
in interfaceDomainDatagramChannelConfig
-
getSendBufferSize
public int getSendBufferSize()Description copied from interface:DomainDatagramChannelConfig
Gets theStandardSocketOptions.SO_SNDBUF
option.- Specified by:
getSendBufferSize
in interfaceDomainDatagramChannelConfig
-
setWriteBufferWaterMark
public EpollDomainDatagramChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark) Description copied from interface:ChannelConfig
Set theWriteBufferWaterMark
which is used for setting the high and low water mark of the write buffer.- Specified by:
setWriteBufferWaterMark
in interfaceChannelConfig
- Specified by:
setWriteBufferWaterMark
in interfaceDomainDatagramChannelConfig
- Overrides:
setWriteBufferWaterMark
in classEpollChannelConfig
-
setWriteSpinCount
Description copied from interface:ChannelConfig
Sets 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:
setWriteSpinCount
in interfaceChannelConfig
- Specified by:
setWriteSpinCount
in interfaceDomainDatagramChannelConfig
- Overrides:
setWriteSpinCount
in classEpollChannelConfig
-