EpollDatagramChannelConfig (Netty/Transport/Classes/Epoll 4.1.128.Final API)

java.lang.Object
- io.netty.channel.DefaultChannelConfig
- - io.netty.channel.epoll.EpollChannelConfig
  - - io.netty.channel.epoll.EpollDatagramChannelConfig

All Implemented Interfaces:: io.netty.channel.ChannelConfig, io.netty.channel.socket.DatagramChannelConfig

public final class EpollDatagramChannelConfig
extends EpollChannelConfig
implements io.netty.channel.socket.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 and Description
`InetAddress`	`getInterface()`
`int`	`getMaxDatagramPayloadSize()` Get the maximum `DatagramPacket` size.
`NetworkInterface`	`getNetworkInterface()`
`<T> T`	`getOption(io.netty.channel.ChannelOption<T> option)`
`Map<io.netty.channel.ChannelOption<?>,Object>`	`getOptions()`
`int`	`getReceiveBufferSize()`
`int`	`getSendBufferSize()`
`int`	`getTimeToLive()`
`int`	`getTrafficClass()`
`boolean`	`isBroadcast()`
`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()`
`boolean`	`isReuseAddress()`
`boolean`	`isReusePort()` Returns `true` if the SO_REUSEPORT option is set.
`boolean`	`isUdpGro()` Returns if `UDP_GRO` is enabled.
`EpollDatagramChannelConfig`	`setAllocator(io.netty.buffer.ByteBufAllocator allocator)`
`EpollDatagramChannelConfig`	`setAutoClose(boolean autoClose)`
`EpollDatagramChannelConfig`	`setAutoRead(boolean autoRead)`
`EpollDatagramChannelConfig`	`setBroadcast(boolean broadcast)`
`EpollDatagramChannelConfig`	`setConnectTimeoutMillis(int connectTimeoutMillis)`
`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)`
`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.
`io.netty.channel.socket.DatagramChannelConfig`	`setLoopbackModeDisabled(boolean loopbackModeDisabled)`
`EpollDatagramChannelConfig`	`setMaxDatagramPayloadSize(int maxDatagramSize)` Set the maximum `DatagramPacket` size.
`EpollDatagramChannelConfig`	`setMaxMessagesPerRead(int maxMessagesPerRead)` Deprecated.
`EpollDatagramChannelConfig`	`setMaxMessagesPerWrite(int maxMessagesPerWrite)`
`EpollDatagramChannelConfig`	`setMessageSizeEstimator(io.netty.channel.MessageSizeEstimator estimator)`
`EpollDatagramChannelConfig`	`setNetworkInterface(NetworkInterface networkInterface)`
`<T> boolean`	`setOption(io.netty.channel.ChannelOption<T> option, T value)`
`EpollDatagramChannelConfig`	`setReceiveBufferSize(int receiveBufferSize)`
`EpollDatagramChannelConfig`	`setRecvByteBufAllocator(io.netty.channel.RecvByteBufAllocator allocator)`
`EpollDatagramChannelConfig`	`setReuseAddress(boolean reuseAddress)`
`EpollDatagramChannelConfig`	`setReusePort(boolean reusePort)` Set the SO_REUSEPORT option on the underlying Channel.
`EpollDatagramChannelConfig`	`setSendBufferSize(int sendBufferSize)`
`EpollDatagramChannelConfig`	`setTimeToLive(int ttl)`
`EpollDatagramChannelConfig`	`setTrafficClass(int trafficClass)`
`EpollDatagramChannelConfig`	`setUdpGro(boolean gro)` Enable / disable UDP_GRO.
`EpollDatagramChannelConfig`	`setWriteBufferHighWaterMark(int writeBufferHighWaterMark)` Deprecated.
`EpollDatagramChannelConfig`	`setWriteBufferLowWaterMark(int writeBufferLowWaterMark)` Deprecated.
`EpollDatagramChannelConfig`	`setWriteBufferWaterMark(io.netty.channel.WriteBufferWaterMark writeBufferWaterMark)`
`EpollDatagramChannelConfig`	`setWriteSpinCount(int writeSpinCount)`

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<io.netty.channel.ChannelOption<?>,Object> getOptions()
```
    Specified by:
    
    getOptions in interface io.netty.channel.ChannelConfig
    
    Overrides:
    
    getOptions in class EpollChannelConfig
  - getOption
```
public <T> T getOption(io.netty.channel.ChannelOption<T> option)
```
    Specified by:
    
    getOption in interface io.netty.channel.ChannelConfig
    
    Overrides:
    
    getOption in class EpollChannelConfig
  - setOption
```
public <T> boolean setOption(io.netty.channel.ChannelOption<T> option,
                             T value)
```
    Specified by:
    
    setOption in interface io.netty.channel.ChannelConfig
    
    Overrides:
    
    setOption in class EpollChannelConfig
  - setMessageSizeEstimator
```
public EpollDatagramChannelConfig setMessageSizeEstimator(io.netty.channel.MessageSizeEstimator estimator)
```
    Specified by:
    
    setMessageSizeEstimator in interface io.netty.channel.ChannelConfig
    
    Specified by:
    
    setMessageSizeEstimator in interface io.netty.channel.socket.DatagramChannelConfig
    
    Overrides:
    
    setMessageSizeEstimator in class EpollChannelConfig
  - setWriteBufferLowWaterMark
```
@Deprecated
public EpollDatagramChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)
```
    Deprecated.
    
    Specified by:
    
    setWriteBufferLowWaterMark in interface io.netty.channel.ChannelConfig
    
    Overrides:
    
    setWriteBufferLowWaterMark in class EpollChannelConfig
  - setWriteBufferHighWaterMark
```
@Deprecated
public EpollDatagramChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)
```
    Deprecated.
    
    Specified by:
    
    setWriteBufferHighWaterMark in interface io.netty.channel.ChannelConfig
    
    Overrides:
    
    setWriteBufferHighWaterMark in class EpollChannelConfig
  - setWriteBufferWaterMark
```
public EpollDatagramChannelConfig setWriteBufferWaterMark(io.netty.channel.WriteBufferWaterMark writeBufferWaterMark)
```
    Specified by:
    
    setWriteBufferWaterMark in interface io.netty.channel.ChannelConfig
    
    Specified by:
    
    setWriteBufferWaterMark in interface io.netty.channel.socket.DatagramChannelConfig
    
    Overrides:
    
    setWriteBufferWaterMark in class EpollChannelConfig
  - setAutoClose
```
public EpollDatagramChannelConfig setAutoClose(boolean autoClose)
```
    Specified by:
    
    setAutoClose in interface io.netty.channel.ChannelConfig
    
    Specified by:
    
    setAutoClose in interface io.netty.channel.socket.DatagramChannelConfig
    
    Overrides:
    
    setAutoClose in class io.netty.channel.DefaultChannelConfig
  - setAutoRead
```
public EpollDatagramChannelConfig setAutoRead(boolean autoRead)
```
    Specified by:
    
    setAutoRead in interface io.netty.channel.ChannelConfig
    
    Specified by:
    
    setAutoRead in interface io.netty.channel.socket.DatagramChannelConfig
    
    Overrides:
    
    setAutoRead in class EpollChannelConfig
  - setRecvByteBufAllocator
```
public EpollDatagramChannelConfig setRecvByteBufAllocator(io.netty.channel.RecvByteBufAllocator allocator)
```
    Specified by:
    
    setRecvByteBufAllocator in interface io.netty.channel.ChannelConfig
    
    Specified by:
    
    setRecvByteBufAllocator in interface io.netty.channel.socket.DatagramChannelConfig
    
    Overrides:
    
    setRecvByteBufAllocator in class EpollChannelConfig
  - setWriteSpinCount
```
public EpollDatagramChannelConfig setWriteSpinCount(int writeSpinCount)
```
    Specified by:
    
    setWriteSpinCount in interface io.netty.channel.ChannelConfig
    
    Specified by:
    
    setWriteSpinCount in interface io.netty.channel.socket.DatagramChannelConfig
    
    Overrides:
    
    setWriteSpinCount in class EpollChannelConfig
  - setAllocator
```
public EpollDatagramChannelConfig setAllocator(io.netty.buffer.ByteBufAllocator allocator)
```
    Specified by:
    
    setAllocator in interface io.netty.channel.ChannelConfig
    
    Specified by:
    
    setAllocator in interface io.netty.channel.socket.DatagramChannelConfig
    
    Overrides:
    
    setAllocator in class EpollChannelConfig
  - setConnectTimeoutMillis
```
public EpollDatagramChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)
```
    Specified by:
    
    setConnectTimeoutMillis in interface io.netty.channel.ChannelConfig
    
    Specified by:
    
    setConnectTimeoutMillis in interface io.netty.channel.socket.DatagramChannelConfig
    
    Overrides:
    
    setConnectTimeoutMillis in class EpollChannelConfig
  - setMaxMessagesPerRead
```
@Deprecated
public EpollDatagramChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)
```
    Deprecated.
    
    Specified by:
    
    setMaxMessagesPerRead in interface io.netty.channel.ChannelConfig
    
    Specified by:
    
    setMaxMessagesPerRead in interface io.netty.channel.socket.DatagramChannelConfig
    
    Overrides:
    
    setMaxMessagesPerRead in class EpollChannelConfig
  - getSendBufferSize
```
public int getSendBufferSize()
```
    Specified by:
    
    getSendBufferSize in interface io.netty.channel.socket.DatagramChannelConfig
  - setSendBufferSize
```
public EpollDatagramChannelConfig setSendBufferSize(int sendBufferSize)
```
    Specified by:
    
    setSendBufferSize in interface io.netty.channel.socket.DatagramChannelConfig
  - getReceiveBufferSize
```
public int getReceiveBufferSize()
```
    Specified by:
    
    getReceiveBufferSize in interface io.netty.channel.socket.DatagramChannelConfig
  - setReceiveBufferSize
```
public EpollDatagramChannelConfig setReceiveBufferSize(int receiveBufferSize)
```
    Specified by:
    
    setReceiveBufferSize in interface io.netty.channel.socket.DatagramChannelConfig
  - getTrafficClass
```
public int getTrafficClass()
```
    Specified by:
    
    getTrafficClass in interface io.netty.channel.socket.DatagramChannelConfig
  - setTrafficClass
```
public EpollDatagramChannelConfig setTrafficClass(int trafficClass)
```
    Specified by:
    
    setTrafficClass in interface io.netty.channel.socket.DatagramChannelConfig
  - isReuseAddress
```
public boolean isReuseAddress()
```
    Specified by:
    
    isReuseAddress in interface io.netty.channel.socket.DatagramChannelConfig
  - setReuseAddress
```
public EpollDatagramChannelConfig setReuseAddress(boolean reuseAddress)
```
    Specified by:
    
    setReuseAddress in interface io.netty.channel.socket.DatagramChannelConfig
  - isBroadcast
```
public boolean isBroadcast()
```
    Specified by:
    
    isBroadcast in interface io.netty.channel.socket.DatagramChannelConfig
  - setBroadcast
```
public EpollDatagramChannelConfig setBroadcast(boolean broadcast)
```
    Specified by:
    
    setBroadcast in interface io.netty.channel.socket.DatagramChannelConfig
  - isLoopbackModeDisabled
```
public boolean isLoopbackModeDisabled()
```
    Specified by:
    
    isLoopbackModeDisabled in interface io.netty.channel.socket.DatagramChannelConfig
  - setLoopbackModeDisabled
```
public io.netty.channel.socket.DatagramChannelConfig setLoopbackModeDisabled(boolean loopbackModeDisabled)
```
    Specified by:
    
    setLoopbackModeDisabled in interface io.netty.channel.socket.DatagramChannelConfig
  - getTimeToLive
```
public int getTimeToLive()
```
    Specified by:
    
    getTimeToLive in interface io.netty.channel.socket.DatagramChannelConfig
  - setTimeToLive
```
public EpollDatagramChannelConfig setTimeToLive(int ttl)
```
    Specified by:
    
    setTimeToLive in interface io.netty.channel.socket.DatagramChannelConfig
  - getInterface
```
public InetAddress getInterface()
```
    Specified by:
    
    getInterface in interface io.netty.channel.socket.DatagramChannelConfig
  - setInterface
```
public EpollDatagramChannelConfig setInterface(InetAddress interfaceAddress)
```
    Specified by:
    
    setInterface in interface io.netty.channel.socket.DatagramChannelConfig
  - getNetworkInterface
```
public NetworkInterface getNetworkInterface()
```
    Specified by:
    
    getNetworkInterface in interface io.netty.channel.socket.DatagramChannelConfig
  - setNetworkInterface
```
public EpollDatagramChannelConfig setNetworkInterface(NetworkInterface networkInterface)
```
    Specified by:
    
    setNetworkInterface in interface io.netty.channel.socket.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)
```
    Overrides:
    
    setMaxMessagesPerWrite in class io.netty.channel.DefaultChannelConfig

Class EpollDatagramChannelConfig

Field Summary

Fields inherited from class io.netty.channel.DefaultChannelConfig

Method Summary

Methods inherited from class io.netty.channel.epoll.EpollChannelConfig

Methods inherited from class io.netty.channel.DefaultChannelConfig

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.channel.ChannelConfig

Method Detail

getOptions

getOption

setOption

setMessageSizeEstimator

setWriteBufferLowWaterMark

setWriteBufferHighWaterMark

setWriteBufferWaterMark

setAutoClose

setAutoRead

setRecvByteBufAllocator

setWriteSpinCount

setAllocator

setConnectTimeoutMillis

setMaxMessagesPerRead

getSendBufferSize

setSendBufferSize

getReceiveBufferSize

setReceiveBufferSize

getTrafficClass

setTrafficClass

isReuseAddress

setReuseAddress

isBroadcast

setBroadcast

isLoopbackModeDisabled

setLoopbackModeDisabled

getTimeToLive

setTimeToLive

getInterface

setInterface

getNetworkInterface

setNetworkInterface

setEpollMode

isReusePort

setReusePort

isIpTransparent

setIpTransparent

isFreeBind

setFreeBind

isIpRecvOrigDestAddr

setIpRecvOrigDestAddr

setMaxDatagramPayloadSize

getMaxDatagramPayloadSize

setUdpGro

isUdpGro

setMaxMessagesPerWrite