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
-
Fields inherited from class io.netty.channel.DefaultChannelConfig
channel
-
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.net.InetAddress
getInterface()
Gets the address of the network interface used for multicast packets.int
getMaxDatagramPayloadSize()
Get the maximumDatagramPacket
size.java.net.NetworkInterface
getNetworkInterface()
Gets theStandardSocketOptions.IP_MULTICAST_IF
option.<T> T
getOption(ChannelOption<T> option)
Return the value of the givenChannelOption
java.util.Map<ChannelOption<?>,java.lang.Object>
getOptions()
Return all setChannelOption
's.int
getReceiveBufferSize()
Gets theStandardSocketOptions.SO_RCVBUF
option.int
getSendBufferSize()
Gets theStandardSocketOptions.SO_SNDBUF
option.int
getTimeToLive()
Gets theStandardSocketOptions.IP_MULTICAST_TTL
option.int
getTrafficClass()
Gets theStandardSocketOptions.IP_TOS
option.boolean
isBroadcast()
Gets theStandardSocketOptions.SO_BROADCAST
option.boolean
isFreeBind()
boolean
isIpRecvOrigDestAddr()
boolean
isIpTransparent()
boolean
isLoopbackModeDisabled()
Gets theStandardSocketOptions.IP_MULTICAST_LOOP
option.boolean
isReuseAddress()
Gets theStandardSocketOptions.SO_REUSEADDR
option.boolean
isReusePort()
Returnstrue
if the SO_REUSEPORT option is set.boolean
isUdpGro()
Returns ifUDP_GRO
is enabled.EpollDatagramChannelConfig
setAllocator(ByteBufAllocator allocator)
Set theByteBufAllocator
which is used for the channel to allocate buffers.EpollDatagramChannelConfig
setAutoClose(boolean autoClose)
Sets whether theChannel
should be closed automatically and immediately on write failure.EpollDatagramChannelConfig
setAutoRead(boolean autoRead)
Sets ifChannelHandlerContext.read()
will be invoked automatically so that a user application doesn't need to call it at all.EpollDatagramChannelConfig
setBroadcast(boolean broadcast)
Sets theStandardSocketOptions.SO_BROADCAST
option.EpollDatagramChannelConfig
setConnectTimeoutMillis(int connectTimeoutMillis)
Sets the connect timeout of the channel in milliseconds.EpollDatagramChannelConfig
setEpollMode(EpollMode mode)
Set theEpollMode
used.EpollDatagramChannelConfig
setFreeBind(boolean freeBind)
EpollDatagramChannelConfig
setInterface(java.net.InetAddress interfaceAddress)
Sets the address of the network interface used for multicast packets.EpollDatagramChannelConfig
setIpRecvOrigDestAddr(boolean ipTransparent)
EpollDatagramChannelConfig
setIpTransparent(boolean ipTransparent)
DatagramChannelConfig
setLoopbackModeDisabled(boolean loopbackModeDisabled)
Sets theStandardSocketOptions.IP_MULTICAST_LOOP
option.EpollDatagramChannelConfig
setMaxDatagramPayloadSize(int maxDatagramSize)
Set the maximumDatagramPacket
size.EpollDatagramChannelConfig
setMaxMessagesPerRead(int maxMessagesPerRead)
Deprecated.EpollDatagramChannelConfig
setMaxMessagesPerWrite(int maxMessagesPerWrite)
Set the maximum number of message to write per eventloop run.EpollDatagramChannelConfig
setMessageSizeEstimator(MessageSizeEstimator estimator)
Set theMessageSizeEstimator
which is used for the channel to detect the size of a message.EpollDatagramChannelConfig
setNetworkInterface(java.net.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.EpollDatagramChannelConfig
setReceiveBufferSize(int receiveBufferSize)
Sets theStandardSocketOptions.SO_RCVBUF
option.EpollDatagramChannelConfig
setRecvByteBufAllocator(RecvByteBufAllocator allocator)
Set theRecvByteBufAllocator
which is used for the channel to allocate receive buffers.EpollDatagramChannelConfig
setReuseAddress(boolean reuseAddress)
Gets theStandardSocketOptions.SO_REUSEADDR
option.EpollDatagramChannelConfig
setReusePort(boolean reusePort)
Set the SO_REUSEPORT option on the underlying Channel.EpollDatagramChannelConfig
setSendBufferSize(int sendBufferSize)
Sets theStandardSocketOptions.SO_SNDBUF
option.EpollDatagramChannelConfig
setTimeToLive(int ttl)
Sets theStandardSocketOptions.IP_MULTICAST_TTL
option.EpollDatagramChannelConfig
setTrafficClass(int trafficClass)
Sets theStandardSocketOptions.IP_TOS
option.EpollDatagramChannelConfig
setUdpGro(boolean gro)
Enable / disable UDP_GRO.EpollDatagramChannelConfig
setWriteBufferHighWaterMark(int writeBufferHighWaterMark)
Deprecated.EpollDatagramChannelConfig
setWriteBufferLowWaterMark(int writeBufferLowWaterMark)
Deprecated.EpollDatagramChannelConfig
setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)
Set theWriteBufferWaterMark
which is used for setting the high and low water mark of the write buffer.EpollDatagramChannelConfig
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
-
-
-
-
Method Detail
-
getOptions
public java.util.Map<ChannelOption<?>,java.lang.Object> getOptions()
Description copied from interface:ChannelConfig
Return all setChannelOption
's.- Specified by:
getOptions
in interfaceChannelConfig
- Overrides:
getOptions
in classEpollChannelConfig
-
getOption
public <T> T getOption(ChannelOption<T> option)
Description copied from interface:ChannelConfig
Return the value of the givenChannelOption
- Specified by:
getOption
in interfaceChannelConfig
- Overrides:
getOption
in classEpollChannelConfig
-
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 interfaceChannelConfig
- Overrides:
setOption
in classEpollChannelConfig
- Returns:
true
if and only if the property has been set
-
setMessageSizeEstimator
public EpollDatagramChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)
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
public EpollDatagramChannelConfig setAutoClose(boolean autoClose)
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
public EpollDatagramChannelConfig setAutoRead(boolean autoRead)
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
public EpollDatagramChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)
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
public EpollDatagramChannelConfig setWriteSpinCount(int writeSpinCount)
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
public EpollDatagramChannelConfig setAllocator(ByteBufAllocator allocator)
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
public EpollDatagramChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)
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 public EpollDatagramChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)
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
public EpollDatagramChannelConfig setSendBufferSize(int sendBufferSize)
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
public EpollDatagramChannelConfig setReceiveBufferSize(int receiveBufferSize)
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
public EpollDatagramChannelConfig setTrafficClass(int trafficClass)
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
public EpollDatagramChannelConfig setReuseAddress(boolean reuseAddress)
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
public EpollDatagramChannelConfig setBroadcast(boolean broadcast)
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
public DatagramChannelConfig setLoopbackModeDisabled(boolean loopbackModeDisabled)
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
public EpollDatagramChannelConfig setTimeToLive(int ttl)
Description copied from interface:DatagramChannelConfig
Sets theStandardSocketOptions.IP_MULTICAST_TTL
option.- Specified by:
setTimeToLive
in interfaceDatagramChannelConfig
-
getInterface
public java.net.InetAddress getInterface()
Description copied from interface:DatagramChannelConfig
Gets the address of the network interface used for multicast packets.- Specified by:
getInterface
in interfaceDatagramChannelConfig
-
setInterface
public EpollDatagramChannelConfig setInterface(java.net.InetAddress interfaceAddress)
Description copied from interface:DatagramChannelConfig
Sets the address of the network interface used for multicast packets.- Specified by:
setInterface
in interfaceDatagramChannelConfig
-
getNetworkInterface
public java.net.NetworkInterface getNetworkInterface()
Description copied from interface:DatagramChannelConfig
Gets theStandardSocketOptions.IP_MULTICAST_IF
option.- Specified by:
getNetworkInterface
in interfaceDatagramChannelConfig
-
setNetworkInterface
public EpollDatagramChannelConfig setNetworkInterface(java.net.NetworkInterface networkInterface)
Description copied from interface:DatagramChannelConfig
Sets theStandardSocketOptions.IP_MULTICAST_IF
option.- Specified by:
setNetworkInterface
in interfaceDatagramChannelConfig
-
setEpollMode
public EpollDatagramChannelConfig setEpollMode(EpollMode mode)
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
public EpollDatagramChannelConfig setReusePort(boolean reusePort)
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 beforeChannel.bind(java.net.SocketAddress)
to have any affect.
-
isIpTransparent
public boolean isIpTransparent()
-
setIpTransparent
public EpollDatagramChannelConfig setIpTransparent(boolean ipTransparent)
-
isFreeBind
public boolean isFreeBind()
-
setFreeBind
public EpollDatagramChannelConfig setFreeBind(boolean freeBind)
-
isIpRecvOrigDestAddr
public boolean isIpRecvOrigDestAddr()
-
setIpRecvOrigDestAddr
public EpollDatagramChannelConfig setIpRecvOrigDestAddr(boolean ipTransparent)
-
setMaxDatagramPayloadSize
public EpollDatagramChannelConfig setMaxDatagramPayloadSize(int maxDatagramSize)
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
public EpollDatagramChannelConfig setUdpGro(boolean gro)
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
public EpollDatagramChannelConfig 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 classDefaultChannelConfig
-
-