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

Modifier and Type	Method and Description
InetAddress	getInterface() Gets the address of the network interface used for multicast packets.
int	getMaxDatagramPayloadSize() Get the maximum DatagramPacket size.
NetworkInterface	getNetworkInterface() Gets the StandardSocketOptions.IP_MULTICAST_IF option.
<T> T	getOption(ChannelOption<T> option) Return the value of the given ChannelOption
Map<ChannelOption<?>,Object>	getOptions() Return all set ChannelOption's.
int	getReceiveBufferSize() Gets the StandardSocketOptions.SO_RCVBUF option.
int	getSendBufferSize() Gets the StandardSocketOptions.SO_SNDBUF option.
int	getTimeToLive() Gets the StandardSocketOptions.IP_MULTICAST_TTL option.
int	getTrafficClass() Gets the StandardSocketOptions.IP_TOS option.
boolean	isBroadcast() Gets the StandardSocketOptions.SO_BROADCAST option.
boolean	isFreeBind() Returns true if IP_FREEBIND is enabled, false otherwise.
boolean	isIpRecvOrigDestAddr() Returns true if IP_RECVORIGDSTADDR is enabled, false otherwise.
boolean	isIpTransparent() Returns true if IP_TRANSPARENT is enabled, false otherwise.
boolean	isLoopbackModeDisabled() Gets the StandardSocketOptions.IP_MULTICAST_LOOP option.
boolean	isReuseAddress() Gets the StandardSocketOptions.SO_REUSEADDR option.
boolean	isReusePort() Returns true if the SO_REUSEPORT option is set.
boolean	isUdpGro() Returns if UDP_GRO is enabled.
EpollDatagramChannelConfig	setAllocator(ByteBufAllocator allocator) Set the ByteBufAllocator which is used for the channel to allocate buffers.
EpollDatagramChannelConfig	setAutoClose(boolean autoClose) Sets whether the Channel should be closed automatically and immediately on write failure.
EpollDatagramChannelConfig	setAutoRead(boolean autoRead) Sets if ChannelHandlerContext.read() will be invoked automatically so that a user application doesn't need to call it at all.
EpollDatagramChannelConfig	setBroadcast(boolean broadcast) Sets the StandardSocketOptions.SO_BROADCAST option.
EpollDatagramChannelConfig	setConnectTimeoutMillis(int connectTimeoutMillis) Sets the connect timeout of the channel in milliseconds.
EpollDatagramChannelConfig	setEpollMode(EpollMode mode) Set the EpollMode used.
EpollDatagramChannelConfig	setFreeBind(boolean freeBind) If true is used IP_FREEBIND is enabled, false for disable it.
EpollDatagramChannelConfig	setInterface(InetAddress interfaceAddress) Sets the address of the network interface used for multicast packets.
EpollDatagramChannelConfig	setIpRecvOrigDestAddr(boolean ipTransparent) If true is used IP_RECVORIGDSTADDR is enabled, false for disable it.
EpollDatagramChannelConfig	setIpTransparent(boolean ipTransparent) If true is used IP_TRANSPARENT is enabled, false for disable it.
DatagramChannelConfig	setLoopbackModeDisabled(boolean loopbackModeDisabled) Sets the StandardSocketOptions.IP_MULTICAST_LOOP option.
EpollDatagramChannelConfig	setMaxDatagramPayloadSize(int maxDatagramSize) Set the maximum DatagramPacket 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 the MessageSizeEstimator which is used for the channel to detect the size of a message.
EpollDatagramChannelConfig	setNetworkInterface(NetworkInterface networkInterface) Sets the StandardSocketOptions.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 the StandardSocketOptions.SO_RCVBUF option.
EpollDatagramChannelConfig	setRecvByteBufAllocator(RecvByteBufAllocator allocator) Set the RecvByteBufAllocator which is used for the channel to allocate receive buffers.
EpollDatagramChannelConfig	setReuseAddress(boolean reuseAddress) Gets the StandardSocketOptions.SO_REUSEADDR option.
EpollDatagramChannelConfig	setReusePort(boolean reusePort) Set the SO_REUSEPORT option on the underlying Channel.
EpollDatagramChannelConfig	setSendBufferSize(int sendBufferSize) Sets the StandardSocketOptions.SO_SNDBUF option.
EpollDatagramChannelConfig	setTimeToLive(int ttl) Sets the StandardSocketOptions.IP_MULTICAST_TTL option.
EpollDatagramChannelConfig	setTrafficClass(int trafficClass) Sets the StandardSocketOptions.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 the WriteBufferWaterMark 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 until WritableByteChannel.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 Map<ChannelOption<?>,Object> getOptions()

Description copied from interface: ChannelConfig

Return all set ChannelOption's.

Specified by:

getOptions in interface ChannelConfig

Overrides:

getOptions in class EpollChannelConfig

getOption

public <T> T getOption(ChannelOption<T> option)

Description copied from interface: ChannelConfig

Return the value of the given ChannelOption

Specified by:

getOption in interface ChannelConfig

Overrides:

getOption in class EpollChannelConfig

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 interface ChannelConfig

Overrides:

setOption in class EpollChannelConfig

Returns:

true if and only if the property has been set

setMessageSizeEstimator

public EpollDatagramChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)

Description copied from interface: ChannelConfig

Set the MessageSizeEstimator which is used for the channel to detect the size of a message.

Specified by:

setMessageSizeEstimator in interface ChannelConfig

Specified by:

setMessageSizeEstimator in interface DatagramChannelConfig

Overrides:

setMessageSizeEstimator in class EpollChannelConfig

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 return true again.

Specified by:

setWriteBufferLowWaterMark in interface ChannelConfig

Overrides:

setWriteBufferLowWaterMark in class EpollChannelConfig

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 return false.

Specified by:

setWriteBufferHighWaterMark in interface ChannelConfig

Overrides:

setWriteBufferHighWaterMark in class EpollChannelConfig

setWriteBufferWaterMark

public EpollDatagramChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)

Description copied from interface: ChannelConfig

Set the WriteBufferWaterMark which is used for setting the high and low water mark of the write buffer.

Specified by:

setWriteBufferWaterMark in interface ChannelConfig

Specified by:

setWriteBufferWaterMark in interface DatagramChannelConfig

Overrides:

setWriteBufferWaterMark in class EpollChannelConfig

setAutoClose

public EpollDatagramChannelConfig setAutoClose(boolean autoClose)

Description copied from interface: ChannelConfig

Sets whether the Channel should be closed automatically and immediately on write failure. The default is true.

Specified by:

setAutoClose in interface ChannelConfig

Specified by:

setAutoClose in interface DatagramChannelConfig

Overrides:

setAutoClose in class DefaultChannelConfig

setAutoRead

public EpollDatagramChannelConfig setAutoRead(boolean autoRead)

Description copied from interface: ChannelConfig

Sets if ChannelHandlerContext.read() will be invoked automatically so that a user application doesn't need to call it at all. The default value is true.

Specified by:

setAutoRead in interface ChannelConfig

Specified by:

setAutoRead in interface DatagramChannelConfig

Overrides:

setAutoRead in class EpollChannelConfig

setRecvByteBufAllocator

public EpollDatagramChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)

Description copied from interface: ChannelConfig

Set the RecvByteBufAllocator which is used for the channel to allocate receive buffers.

Specified by:

setRecvByteBufAllocator in interface ChannelConfig

Specified by:

setRecvByteBufAllocator in interface DatagramChannelConfig

Overrides:

setRecvByteBufAllocator in class EpollChannelConfig

setWriteSpinCount

public EpollDatagramChannelConfig setWriteSpinCount(int writeSpinCount)

Description copied from interface: ChannelConfig

Sets the maximum loop count for a write operation until 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.

Specified by:

setWriteSpinCount in interface ChannelConfig

Specified by:

setWriteSpinCount in interface DatagramChannelConfig

Overrides:

setWriteSpinCount in class EpollChannelConfig

setAllocator

public EpollDatagramChannelConfig setAllocator(ByteBufAllocator allocator)

Description copied from interface: ChannelConfig

Set the ByteBufAllocator which is used for the channel to allocate buffers.

Specified by:

setAllocator in interface ChannelConfig

Specified by:

setAllocator in interface DatagramChannelConfig

Overrides:

setAllocator in class EpollChannelConfig

setConnectTimeoutMillis

public EpollDatagramChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)

Description copied from interface: ChannelConfig

Sets the connect timeout of the channel in milliseconds. If the Channel does not support connect operation, this property is not used at all, and therefore will be ignored.

Specified by:

setConnectTimeoutMillis in interface ChannelConfig

Specified by:

setConnectTimeoutMillis in interface DatagramChannelConfig

Overrides:

setConnectTimeoutMillis in class EpollChannelConfig

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 interface ChannelConfig

Specified by:

setMaxMessagesPerRead in interface DatagramChannelConfig

Overrides:

setMaxMessagesPerRead in class EpollChannelConfig

getSendBufferSize

public int getSendBufferSize()

Description copied from interface: DatagramChannelConfig

Gets the StandardSocketOptions.SO_SNDBUF option.

Specified by:

getSendBufferSize in interface DatagramChannelConfig

setSendBufferSize

public EpollDatagramChannelConfig setSendBufferSize(int sendBufferSize)

Description copied from interface: DatagramChannelConfig

Sets the StandardSocketOptions.SO_SNDBUF option.

Specified by:

setSendBufferSize in interface DatagramChannelConfig

getReceiveBufferSize

public int getReceiveBufferSize()

Description copied from interface: DatagramChannelConfig

Gets the StandardSocketOptions.SO_RCVBUF option.

Specified by:

getReceiveBufferSize in interface DatagramChannelConfig

setReceiveBufferSize

public EpollDatagramChannelConfig setReceiveBufferSize(int receiveBufferSize)

Description copied from interface: DatagramChannelConfig

Sets the StandardSocketOptions.SO_RCVBUF option.

Specified by:

setReceiveBufferSize in interface DatagramChannelConfig

getTrafficClass

public int getTrafficClass()

Description copied from interface: DatagramChannelConfig

Gets the StandardSocketOptions.IP_TOS option.

Specified by:

getTrafficClass in interface DatagramChannelConfig

setTrafficClass

public EpollDatagramChannelConfig setTrafficClass(int trafficClass)

Description copied from interface: DatagramChannelConfig

Sets the StandardSocketOptions.IP_TOS option.

Specified by:

setTrafficClass in interface DatagramChannelConfig

isReuseAddress

public boolean isReuseAddress()

Description copied from interface: DatagramChannelConfig

Gets the StandardSocketOptions.SO_REUSEADDR option.

Specified by:

isReuseAddress in interface DatagramChannelConfig

setReuseAddress

public EpollDatagramChannelConfig setReuseAddress(boolean reuseAddress)

Description copied from interface: DatagramChannelConfig

Gets the StandardSocketOptions.SO_REUSEADDR option.

Specified by:

setReuseAddress in interface DatagramChannelConfig

isBroadcast

public boolean isBroadcast()

Description copied from interface: DatagramChannelConfig

Gets the StandardSocketOptions.SO_BROADCAST option.

Specified by:

isBroadcast in interface DatagramChannelConfig

setBroadcast

public EpollDatagramChannelConfig setBroadcast(boolean broadcast)

Description copied from interface: DatagramChannelConfig

Sets the StandardSocketOptions.SO_BROADCAST option.

Specified by:

setBroadcast in interface DatagramChannelConfig

isLoopbackModeDisabled

public boolean isLoopbackModeDisabled()

Description copied from interface: DatagramChannelConfig

Gets the StandardSocketOptions.IP_MULTICAST_LOOP option.

Specified by:

isLoopbackModeDisabled in interface DatagramChannelConfig

Returns:

true if and only if the loopback mode has been disabled

setLoopbackModeDisabled

public DatagramChannelConfig setLoopbackModeDisabled(boolean loopbackModeDisabled)

Description copied from interface: DatagramChannelConfig

Sets the StandardSocketOptions.IP_MULTICAST_LOOP option.

Specified by:

setLoopbackModeDisabled in interface DatagramChannelConfig

Parameters:

loopbackModeDisabled - true if and only if the loopback mode has been disabled

getTimeToLive

public int getTimeToLive()

Description copied from interface: DatagramChannelConfig

Gets the StandardSocketOptions.IP_MULTICAST_TTL option.

Specified by:

getTimeToLive in interface DatagramChannelConfig

setTimeToLive

public EpollDatagramChannelConfig setTimeToLive(int ttl)

Description copied from interface: DatagramChannelConfig

Sets the StandardSocketOptions.IP_MULTICAST_TTL option.

Specified by:

setTimeToLive in interface DatagramChannelConfig

getInterface

public InetAddress getInterface()

Description copied from interface: DatagramChannelConfig

Gets the address of the network interface used for multicast packets.

Specified by:

getInterface in interface DatagramChannelConfig

setInterface

public EpollDatagramChannelConfig setInterface(InetAddress interfaceAddress)

Description copied from interface: DatagramChannelConfig

Sets the address of the network interface used for multicast packets.

Specified by:

setInterface in interface DatagramChannelConfig

getNetworkInterface

public NetworkInterface getNetworkInterface()

Description copied from interface: DatagramChannelConfig

Gets the StandardSocketOptions.IP_MULTICAST_IF option.

Specified by:

getNetworkInterface in interface DatagramChannelConfig

setNetworkInterface

public EpollDatagramChannelConfig setNetworkInterface(NetworkInterface networkInterface)

Description copied from interface: DatagramChannelConfig

Sets the StandardSocketOptions.IP_MULTICAST_IF option.

Specified by:

setNetworkInterface in interface DatagramChannelConfig

setEpollMode

public EpollDatagramChannelConfig setEpollMode(EpollMode mode)

Description copied from class: EpollChannelConfig

Set the 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.

Overrides:

setEpollMode in class EpollChannelConfig

isReusePort

public boolean isReusePort()

Returns true 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 multiple EpollSocketChannels to the same port and so accept connections with multiple threads. Be aware this method needs be called before AbstractChannel.bind(java.net.SocketAddress) to have any affect.

isIpTransparent

public boolean isIpTransparent()

Returns true if IP_TRANSPARENT is enabled, false otherwise.

setIpTransparent

public EpollDatagramChannelConfig setIpTransparent(boolean ipTransparent)

If true is used IP_TRANSPARENT is enabled, false for disable it. Default is disabled.

isFreeBind

public boolean isFreeBind()

Returns true if IP_FREEBIND is enabled, false otherwise.

setFreeBind

public EpollDatagramChannelConfig setFreeBind(boolean freeBind)

If true is used IP_FREEBIND is enabled, false for disable it. Default is disabled.

isIpRecvOrigDestAddr

public boolean isIpRecvOrigDestAddr()

Returns true if IP_RECVORIGDSTADDR is enabled, false otherwise.

setIpRecvOrigDestAddr

public EpollDatagramChannelConfig setIpRecvOrigDestAddr(boolean ipTransparent)

If true is used IP_RECVORIGDSTADDR is enabled, false for disable it. Default is disabled.

setMaxDatagramPayloadSize

public EpollDatagramChannelConfig setMaxDatagramPayloadSize(int maxDatagramSize)

Set the maximum DatagramPacket size. This will be used to determine if recvmmsg should be used when reading from the underlying socket. When recvmmsg is used we may be able to read multiple DatagramPackets with one syscall and so greatly improve the performance. This number will be used to slice ByteBufs returned by the used RecvByteBufAllocator. You can use 0 to disable the usage of recvmmsg, any other bigger value will enable it.

getMaxDatagramPayloadSize

public int getMaxDatagramPayloadSize()

Get the maximum DatagramPacket size.

setUdpGro

public EpollDatagramChannelConfig setUdpGro(boolean gro)

Enable / disable UDP_GRO.

Parameters:

gro - true if UDP_GRO should be enabled, false otherwise.

Returns:

this.

isUdpGro

public boolean isUdpGro()

Returns if UDP_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 class DefaultChannelConfig