Package io.netty.channel.epoll
Class EpollDatagramChannelConfig
java.lang.Object
io.netty.channel.DefaultChannelConfig
io.netty.channel.epoll.EpollChannelConfig
io.netty.channel.epoll.EpollDatagramChannelConfig
- All Implemented Interfaces:
ChannelConfig
,DatagramChannelConfig
public final class EpollDatagramChannelConfig
extends EpollChannelConfig
implements DatagramChannelConfig
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate boolean
private boolean
private int
Fields inherited from class io.netty.channel.DefaultChannelConfig
channel
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription(package private) boolean
Gets the address of the network interface used for multicast packets.int
Get the maximumDatagramPacket
size.Gets theStandardSocketOptions.IP_MULTICAST_IF
option.<T> T
getOption
(ChannelOption<T> option) Return the value of the givenChannelOption
Map
<ChannelOption<?>, Object> Return all setChannelOption
's.int
Gets theStandardSocketOptions.SO_RCVBUF
option.int
Gets theStandardSocketOptions.SO_SNDBUF
option.int
Gets theStandardSocketOptions.IP_MULTICAST_TTL
option.int
Gets theStandardSocketOptions.IP_TOS
option.boolean
Gets theStandardSocketOptions.SO_BROADCAST
option.boolean
boolean
boolean
boolean
Gets theStandardSocketOptions.IP_MULTICAST_LOOP
option.boolean
Gets theStandardSocketOptions.SO_REUSEADDR
option.boolean
Returnstrue
if the SO_REUSEPORT option is set.boolean
isUdpGro()
Returns ifUDP_GRO
is enabled.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.setBroadcast
(boolean broadcast) Sets theStandardSocketOptions.SO_BROADCAST
option.setConnectTimeoutMillis
(int connectTimeoutMillis) Sets the connect timeout of the channel in milliseconds.setEpollMode
(EpollMode mode) Set theEpollMode
used.setFreeBind
(boolean freeBind) setInterface
(InetAddress interfaceAddress) Sets the address of the network interface used for multicast packets.setIpRecvOrigDestAddr
(boolean ipTransparent) setIpTransparent
(boolean ipTransparent) setLoopbackModeDisabled
(boolean loopbackModeDisabled) Sets theStandardSocketOptions.IP_MULTICAST_LOOP
option.setMaxDatagramPayloadSize
(int maxDatagramSize) Set the maximumDatagramPacket
size.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.setNetworkInterface
(NetworkInterface networkInterface) Sets theStandardSocketOptions.IP_MULTICAST_IF
option.<T> boolean
setOption
(ChannelOption<T> option, T value) Sets a configuration property with the specified name and value.setReceiveBufferSize
(int receiveBufferSize) Sets theStandardSocketOptions.SO_RCVBUF
option.setRecvByteBufAllocator
(RecvByteBufAllocator allocator) Set theRecvByteBufAllocator
which is used for the channel to allocate receive buffers.setReuseAddress
(boolean reuseAddress) Gets theStandardSocketOptions.SO_REUSEADDR
option.setReusePort
(boolean reusePort) Set the SO_REUSEPORT option on the underlying Channel.setSendBufferSize
(int sendBufferSize) Sets theStandardSocketOptions.SO_SNDBUF
option.setTimeToLive
(int ttl) Sets theStandardSocketOptions.IP_MULTICAST_TTL
option.setTrafficClass
(int trafficClass) Sets theStandardSocketOptions.IP_TOS
option.setUdpGro
(boolean gro) Enable / disable UDP_GRO.setWriteBufferHighWaterMark
(int writeBufferHighWaterMark) Deprecated.setWriteBufferLowWaterMark
(int writeBufferLowWaterMark) Deprecated.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, 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
-
Field Details
-
activeOnOpen
private boolean activeOnOpen -
maxDatagramSize
private volatile int maxDatagramSize -
gro
private volatile boolean gro
-
-
Constructor Details
-
EpollDatagramChannelConfig
EpollDatagramChannelConfig(EpollDatagramChannel 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() -
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 interfaceDatagramChannelConfig
- Overrides:
setMessageSizeEstimator
in classEpollChannelConfig
-
setWriteBufferLowWaterMark
@Deprecated public EpollDatagramChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark) Deprecated.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 returntrue
again.- Specified by:
setWriteBufferLowWaterMark
in interfaceChannelConfig
- Overrides:
setWriteBufferLowWaterMark
in classEpollChannelConfig
-
setWriteBufferHighWaterMark
@Deprecated public EpollDatagramChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark) Deprecated.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 returnfalse
.- Specified by:
setWriteBufferHighWaterMark
in interfaceChannelConfig
- Overrides:
setWriteBufferHighWaterMark
in classEpollChannelConfig
-
setWriteBufferWaterMark
public EpollDatagramChannelConfig 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 interfaceDatagramChannelConfig
- Overrides:
setWriteBufferWaterMark
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 interfaceDatagramChannelConfig
- 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 interfaceDatagramChannelConfig
- Overrides:
setAutoRead
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 interfaceDatagramChannelConfig
- Overrides:
setRecvByteBufAllocator
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 interfaceDatagramChannelConfig
- Overrides:
setWriteSpinCount
in classEpollChannelConfig
-
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 interfaceDatagramChannelConfig
- Overrides:
setAllocator
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 interfaceDatagramChannelConfig
- Overrides:
setConnectTimeoutMillis
in classEpollChannelConfig
- Parameters:
connectTimeoutMillis
- the connect timeout in milliseconds.0
to disable.
-
setMaxMessagesPerRead
Deprecated.Description copied from class:DefaultChannelConfig
- Specified by:
setMaxMessagesPerRead
in interfaceChannelConfig
- Specified by:
setMaxMessagesPerRead
in interfaceDatagramChannelConfig
- Overrides:
setMaxMessagesPerRead
in classEpollChannelConfig
-
getSendBufferSize
public int getSendBufferSize()Description copied from interface:DatagramChannelConfig
Gets theStandardSocketOptions.SO_SNDBUF
option.- Specified by:
getSendBufferSize
in interfaceDatagramChannelConfig
-
setSendBufferSize
Description copied from interface:DatagramChannelConfig
Sets theStandardSocketOptions.SO_SNDBUF
option.- Specified by:
setSendBufferSize
in interfaceDatagramChannelConfig
-
getReceiveBufferSize
public int getReceiveBufferSize()Description copied from interface:DatagramChannelConfig
Gets theStandardSocketOptions.SO_RCVBUF
option.- Specified by:
getReceiveBufferSize
in interfaceDatagramChannelConfig
-
setReceiveBufferSize
Description copied from interface:DatagramChannelConfig
Sets theStandardSocketOptions.SO_RCVBUF
option.- Specified by:
setReceiveBufferSize
in interfaceDatagramChannelConfig
-
getTrafficClass
public int getTrafficClass()Description copied from interface:DatagramChannelConfig
Gets theStandardSocketOptions.IP_TOS
option.- Specified by:
getTrafficClass
in interfaceDatagramChannelConfig
-
setTrafficClass
Description copied from interface:DatagramChannelConfig
Sets theStandardSocketOptions.IP_TOS
option.- Specified by:
setTrafficClass
in interfaceDatagramChannelConfig
-
isReuseAddress
public boolean isReuseAddress()Description copied from interface:DatagramChannelConfig
Gets theStandardSocketOptions.SO_REUSEADDR
option.- Specified by:
isReuseAddress
in interfaceDatagramChannelConfig
-
setReuseAddress
Description copied from interface:DatagramChannelConfig
Gets theStandardSocketOptions.SO_REUSEADDR
option.- Specified by:
setReuseAddress
in interfaceDatagramChannelConfig
-
isBroadcast
public boolean isBroadcast()Description copied from interface:DatagramChannelConfig
Gets theStandardSocketOptions.SO_BROADCAST
option.- Specified by:
isBroadcast
in interfaceDatagramChannelConfig
-
setBroadcast
Description copied from interface:DatagramChannelConfig
Sets theStandardSocketOptions.SO_BROADCAST
option.- Specified by:
setBroadcast
in interfaceDatagramChannelConfig
-
isLoopbackModeDisabled
public boolean isLoopbackModeDisabled()Description copied from interface:DatagramChannelConfig
Gets theStandardSocketOptions.IP_MULTICAST_LOOP
option.- Specified by:
isLoopbackModeDisabled
in interfaceDatagramChannelConfig
- Returns:
true
if and only if the loopback mode has been disabled
-
setLoopbackModeDisabled
Description copied from interface:DatagramChannelConfig
Sets theStandardSocketOptions.IP_MULTICAST_LOOP
option.- Specified by:
setLoopbackModeDisabled
in interfaceDatagramChannelConfig
- Parameters:
loopbackModeDisabled
-true
if and only if the loopback mode has been disabled
-
getTimeToLive
public int getTimeToLive()Description copied from interface:DatagramChannelConfig
Gets theStandardSocketOptions.IP_MULTICAST_TTL
option.- Specified by:
getTimeToLive
in interfaceDatagramChannelConfig
-
setTimeToLive
Description copied from interface:DatagramChannelConfig
Sets theStandardSocketOptions.IP_MULTICAST_TTL
option.- Specified by:
setTimeToLive
in interfaceDatagramChannelConfig
-
getInterface
Description copied from interface:DatagramChannelConfig
Gets the address of the network interface used for multicast packets.- Specified by:
getInterface
in interfaceDatagramChannelConfig
-
setInterface
Description copied from interface:DatagramChannelConfig
Sets the address of the network interface used for multicast packets.- Specified by:
setInterface
in interfaceDatagramChannelConfig
-
getNetworkInterface
Description copied from interface:DatagramChannelConfig
Gets theStandardSocketOptions.IP_MULTICAST_IF
option.- Specified by:
getNetworkInterface
in interfaceDatagramChannelConfig
-
setNetworkInterface
Description copied from interface:DatagramChannelConfig
Sets theStandardSocketOptions.IP_MULTICAST_IF
option.- Specified by:
setNetworkInterface
in interfaceDatagramChannelConfig
-
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
-
isReusePort
public boolean isReusePort()Returnstrue
if the SO_REUSEPORT option is set. -
setReusePort
Set the SO_REUSEPORT option on the underlying Channel. This will allow to bind multipleEpollSocketChannel
s to the same port and so accept connections with multiple threads. Be aware this method needs be called beforeAbstractChannel.bind(java.net.SocketAddress)
to have any affect. -
isIpTransparent
public boolean isIpTransparent() -
setIpTransparent
-
isFreeBind
public boolean isFreeBind() -
setFreeBind
-
isIpRecvOrigDestAddr
public boolean isIpRecvOrigDestAddr() -
setIpRecvOrigDestAddr
-
setMaxDatagramPayloadSize
Set the maximumDatagramPacket
size. This will be used to determine ifrecvmmsg
should be used when reading from the underlying socket. Whenrecvmmsg
is used we may be able to read multipleDatagramPacket
s with one syscall and so greatly improve the performance. This number will be used to sliceByteBuf
s returned by the usedRecvByteBufAllocator
. You can use0
to disable the usage of recvmmsg, any other bigger value will enable it. -
getMaxDatagramPayloadSize
public int getMaxDatagramPayloadSize()Get the maximumDatagramPacket
size. -
setUdpGro
Enable / disable UDP_GRO.- Parameters:
gro
-true
ifUDP_GRO
should be enabled,false
otherwise.- Returns:
- this.
-
isUdpGro
public boolean isUdpGro()Returns ifUDP_GRO
is enabled.- Returns:
true
if enabled,false
otherwise.
-
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
-