public final Class EpollDatagramChannelConfig

Implements io.netty.channel.socket.DatagramChannelConfig.getInterface.

Doc from io.netty.channel.socket.DatagramChannelConfig.getInterface.

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

Annotations

@Override

Get the maximum io.netty.channel.socket.DatagramPacket size.

Implements io.netty.channel.socket.DatagramChannelConfig.getNetworkInterface.

Doc from io.netty.channel.socket.DatagramChannelConfig.getNetworkInterface.

Gets the StandardSocketOptions#IP_MULTICAST_IF option.

Annotations

@Override

Overrides io.netty.channel.epoll.EpollChannelConfig.getOption.

Implements io.netty.channel.ChannelConfig.getOption.

Doc from io.netty.channel.ChannelConfig.getOption.

Return the value of the given ChannelOption

Annotations

@SuppressWarnings:unchecked, deprecation

@Override

Overrides io.netty.channel.epoll.EpollChannelConfig.getOptions.

Implements io.netty.channel.ChannelConfig.getOptions.

Doc from io.netty.channel.ChannelConfig.getOptions.

Return all set ChannelOption's.

Annotations

@Override

@SuppressWarnings:deprecation

Implements io.netty.channel.socket.DatagramChannelConfig.getReceiveBufferSize.

Doc from io.netty.channel.socket.DatagramChannelConfig.getReceiveBufferSize.

Gets the StandardSocketOptions#SO_RCVBUF option.

Annotations

@Override

Implements io.netty.channel.socket.DatagramChannelConfig.getSendBufferSize.

Doc from io.netty.channel.socket.DatagramChannelConfig.getSendBufferSize.

Gets the StandardSocketOptions#SO_SNDBUF option.

Annotations

@Override

Implements io.netty.channel.socket.DatagramChannelConfig.getTimeToLive.

Doc from io.netty.channel.socket.DatagramChannelConfig.getTimeToLive.

Gets the StandardSocketOptions#IP_MULTICAST_TTL option.

Annotations

@Override

Implements io.netty.channel.socket.DatagramChannelConfig.getTrafficClass.

Doc from io.netty.channel.socket.DatagramChannelConfig.getTrafficClass.

Gets the StandardSocketOptions#IP_TOS option.

Annotations

@Override

Implements io.netty.channel.socket.DatagramChannelConfig.isBroadcast.

Doc from io.netty.channel.socket.DatagramChannelConfig.isBroadcast.

Gets the StandardSocketOptions#SO_BROADCAST option.

Annotations

@Override

Returns true if IP_FREEBIND is enabled, false otherwise.

Returns true if IP_RECVORIGDSTADDR is enabled, false otherwise.

Returns true if IP_TRANSPARENT is enabled, false otherwise.

Implements io.netty.channel.socket.DatagramChannelConfig.isLoopbackModeDisabled.

Doc from io.netty.channel.socket.DatagramChannelConfig.isLoopbackModeDisabled.

Gets the StandardSocketOptions#IP_MULTICAST_LOOP option.

Returns:boolean

true if and only if the loopback mode has been disabled

Annotations

@Override

Implements io.netty.channel.socket.DatagramChannelConfig.isReuseAddress.

Doc from io.netty.channel.socket.DatagramChannelConfig.isReuseAddress.

Gets the StandardSocketOptions#SO_REUSEADDR option.

Annotations

@Override

Returns true if the SO_REUSEPORT option is set.

Returns if UDP_GRO is enabled.

Returns:boolean

true if enabled, false otherwise.

Overrides io.netty.channel.epoll.EpollChannelConfig.setAllocator.

Implements io.netty.channel.socket.DatagramChannelConfig.setAllocator, io.netty.channel.ChannelConfig.setAllocator.

Doc from io.netty.channel.ChannelConfig.setAllocator.

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

Annotations

@Override

Overrides io.netty.channel.DefaultChannelConfig.setAutoClose.

Implements io.netty.channel.socket.DatagramChannelConfig.setAutoClose, io.netty.channel.ChannelConfig.setAutoClose.

Doc from io.netty.channel.ChannelConfig.setAutoClose.

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

Annotations

@Override

Overrides io.netty.channel.epoll.EpollChannelConfig.setAutoRead.

Implements io.netty.channel.socket.DatagramChannelConfig.setAutoRead, io.netty.channel.ChannelConfig.setAutoRead.

Doc from io.netty.channel.ChannelConfig.setAutoRead.

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.

Annotations

@Override

Implements io.netty.channel.socket.DatagramChannelConfig.setBroadcast.

Doc from io.netty.channel.socket.DatagramChannelConfig.setBroadcast.

Sets the StandardSocketOptions#SO_BROADCAST option.

Annotations

@Override

Overrides io.netty.channel.epoll.EpollChannelConfig.setConnectTimeoutMillis.

Implements io.netty.channel.socket.DatagramChannelConfig.setConnectTimeoutMillis, io.netty.channel.ChannelConfig.setConnectTimeoutMillis.

Doc from io.netty.channel.ChannelConfig.setConnectTimeoutMillis.

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.

Parameters

connectTimeoutMillis:int

the connect timeout in milliseconds. 0 to disable.

Annotations

@Override

Overrides io.netty.channel.epoll.EpollChannelConfig.setEpollMode.

Doc from io.netty.channel.epoll.EpollChannelConfig.setEpollMode.

Set the EpollMode used. Default is EpollMode#EDGE_TRIGGERED. If you want to use isAutoRead() false or 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.

Annotations

@Override

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

Implements io.netty.channel.socket.DatagramChannelConfig.setInterface.

Doc from io.netty.channel.socket.DatagramChannelConfig.setInterface.

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

Annotations

@Override

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

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

Implements io.netty.channel.socket.DatagramChannelConfig.setLoopbackModeDisabled.

Doc from io.netty.channel.socket.DatagramChannelConfig.setLoopbackModeDisabled.

Sets the StandardSocketOptions#IP_MULTICAST_LOOP option.

Parameters

loopbackModeDisabled:boolean

true if and only if the loopback mode has been disabled

Annotations

@Override

Set the maximum io.netty.channel.socket.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 io.netty.channel.socket.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.

Overrides io.netty.channel.epoll.EpollChannelConfig.setMaxMessagesPerRead.

Implements io.netty.channel.socket.DatagramChannelConfig.setMaxMessagesPerRead, io.netty.channel.ChannelConfig.setMaxMessagesPerRead.

Doc from io.netty.channel.DefaultChannelConfig.setMaxMessagesPerRead.

Annotations

@Override

@Deprecated

Overrides io.netty.channel.DefaultChannelConfig.setMaxMessagesPerWrite.

Doc from io.netty.channel.DefaultChannelConfig.setMaxMessagesPerWrite.

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.

Annotations

@Override

Overrides io.netty.channel.epoll.EpollChannelConfig.setMessageSizeEstimator.

Implements io.netty.channel.socket.DatagramChannelConfig.setMessageSizeEstimator, io.netty.channel.ChannelConfig.setMessageSizeEstimator.

Doc from io.netty.channel.ChannelConfig.setMessageSizeEstimator.

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

Annotations

@Override

Implements io.netty.channel.socket.DatagramChannelConfig.setNetworkInterface.

Doc from io.netty.channel.socket.DatagramChannelConfig.setNetworkInterface.

Sets the StandardSocketOptions#IP_MULTICAST_IF option.

Annotations

@Override

Overrides io.netty.channel.epoll.EpollChannelConfig.setOption.

Implements io.netty.channel.ChannelConfig.setOption.

Doc from io.netty.channel.ChannelConfig.setOption.

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;
}

Returns:boolean

true if and only if the property has been set

Annotations

@Override

@SuppressWarnings:deprecation

Implements io.netty.channel.socket.DatagramChannelConfig.setReceiveBufferSize.

Doc from io.netty.channel.socket.DatagramChannelConfig.setReceiveBufferSize.

Sets the StandardSocketOptions#SO_RCVBUF option.

Annotations

@Override

Overrides io.netty.channel.epoll.EpollChannelConfig.setRecvByteBufAllocator.

Implements io.netty.channel.socket.DatagramChannelConfig.setRecvByteBufAllocator, io.netty.channel.ChannelConfig.setRecvByteBufAllocator.

Doc from io.netty.channel.ChannelConfig.setRecvByteBufAllocator.

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

Annotations

@Override

Implements io.netty.channel.socket.DatagramChannelConfig.setReuseAddress.

Doc from io.netty.channel.socket.DatagramChannelConfig.setReuseAddress.

Gets the StandardSocketOptions#SO_REUSEADDR option.

Annotations

@Override

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 EpollDatagramChannel#bind(java.net.SocketAddress) to have any affect.

Implements io.netty.channel.socket.DatagramChannelConfig.setSendBufferSize.

Doc from io.netty.channel.socket.DatagramChannelConfig.setSendBufferSize.

Sets the StandardSocketOptions#SO_SNDBUF option.

Annotations

@Override

Implements io.netty.channel.socket.DatagramChannelConfig.setTimeToLive.

Doc from io.netty.channel.socket.DatagramChannelConfig.setTimeToLive.

Sets the StandardSocketOptions#IP_MULTICAST_TTL option.

Annotations

@Override

Implements io.netty.channel.socket.DatagramChannelConfig.setTrafficClass.

Doc from io.netty.channel.socket.DatagramChannelConfig.setTrafficClass.

Sets the StandardSocketOptions#IP_TOS option.

Annotations

@Override

Enable / disable UDP_GRO.

Parameters

gro:boolean

true if UDP_GRO should be enabled, false otherwise.

Returns:EpollDatagramChannelConfig

this.

Overrides io.netty.channel.epoll.EpollChannelConfig.setWriteBufferHighWaterMark.

Implements io.netty.channel.ChannelConfig.setWriteBufferHighWaterMark.

Doc from io.netty.channel.ChannelConfig.setWriteBufferHighWaterMark.

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.

Annotations

@Override

@Deprecated

Overrides io.netty.channel.epoll.EpollChannelConfig.setWriteBufferLowWaterMark.

Implements io.netty.channel.ChannelConfig.setWriteBufferLowWaterMark.

Doc from io.netty.channel.ChannelConfig.setWriteBufferLowWaterMark.

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.

Annotations

@Override

@Deprecated

Overrides io.netty.channel.epoll.EpollChannelConfig.setWriteBufferWaterMark.

Implements io.netty.channel.socket.DatagramChannelConfig.setWriteBufferWaterMark, io.netty.channel.ChannelConfig.setWriteBufferWaterMark.

Doc from io.netty.channel.ChannelConfig.setWriteBufferWaterMark.

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

Annotations

@Override

Overrides io.netty.channel.epoll.EpollChannelConfig.setWriteSpinCount.

Implements io.netty.channel.socket.DatagramChannelConfig.setWriteSpinCount, io.netty.channel.ChannelConfig.setWriteSpinCount.

Doc from io.netty.channel.ChannelConfig.setWriteSpinCount.

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.

Annotations

@Override