Netty 5.0.0.Alpha5 · io.netty5.channel.epoll.EpollDatagramChannel

`ChannelOption`	`INET`	`INET6`	{@code UNIX
`IntegerUnixChannelOption`	X	X	X
`RawUnixChannelOption`	X	X	X
`UnixChannelOption#SO_REUSEPORT`	X	X	X
`EpollChannelOption#IP_FREEBIND`	X	X	-
`EpollChannelOption#IP_RECVORIGDSTADDR`	X	X	-
`EpollChannelOption#MAX_DATAGRAM_PAYLOAD_SIZE`	X	X	-
`EpollChannelOption#UDP_GRO`	X	X	-

Modifier and Type	Field and Description
private volatile boolean	activeOnOpen
private volatile boolean	connected
private static final String	EXPECTED_TYPES
private static final String	EXPECTED_TYPES_DOMAIN_SOCKET
private volatile boolean	gro
private volatile boolean	inputShutdown
private static final InternalLogger	logger Hides io.netty5.channel.AbstractChannel.logger.
private volatile int	maxDatagramSize
private static final Object	NULL
private volatile boolean	outputShutdown
private static final Set<ChannelOption<?>>	SUPPORTED_OPTIONS
private static final Set<ChannelOption<?>>	SUPPORTED_OPTIONS_DOMAIN_SOCKET

Access	Constructor and Description
public	EpollDatagramChannel(EventLoop eventLoop) Create a new instance which selects the `ProtocolFamily` to use depending on the Operation Systems default which will be chosen.
public	EpollDatagramChannel(EventLoop eventLoop, ProtocolFamily family) Create a new instance using the given `ProtocolFamily`.
public	EpollDatagramChannel(EventLoop eventLoop, int fd, ProtocolFamily family) Create a new instance which selects the `ProtocolFamily` to use depending on the Operation Systems default which will be chosen.
private	EpollDatagramChannel(EventLoop eventLoop, LinuxSocket fd, boolean active)

Method Summary

Modifier and Type	Method and Description
private static void	addDatagramPacketToOut(AddressedEnvelope<?, ?> packet, RecyclableArrayList out)
public Future<Void>	block(InetAddress the multicast group address. multicastAddress, NetworkInterface the interface to use. networkInterface, InetAddress the source address. sourceToBlock) Implements io.netty5.channel.socket.DatagramChannel.block. Block the given sourceToBlock address for the given multicastAddress on the given networkInterface and notifies the `Future` once the operation completes.
public Future<Void>	block(InetAddress the multicast group address. multicastAddress, InetAddress the source address. sourceToBlock) Implements io.netty5.channel.socket.DatagramChannel.block. Block the given sourceToBlock address for the given multicastAddress and notifies the `Future` once the operation completes.
private NativeDatagramPacketArray	cleanDatagramPacketArray()
private AbstractEpollChannel.ReadState	connectedRead(AbstractChannel<UnixChannel, SocketAddress, SocketAddress>.ReadSink readSink, Buffer buf, int maxDatagramPacketSize)
protected void	doBind(SocketAddress the `SocketAddress` to bound to. localAddress) Overrides io.netty5.channel.epoll.AbstractEpollChannel.doBind. Bind the `Channel` to the `SocketAddress`
protected void	doClose() Overrides io.netty5.channel.epoll.AbstractEpollChannel.doClose. Close the `Channel`
protected boolean	doConnect(SocketAddress the address of the remote peer. remoteAddress, SocketAddress the local address of this channel. localAddress, Buffer the initial data that is written during connect (if `ChannelOption#TCP_FASTOPEN_CONNECT` is supported and configured). If data is written care must be taken to update the `reader offset`. initialData) Overrides io.netty5.channel.epoll.AbstractEpollChannel.doConnect. Connect to the remote peer
protected void	doDisconnect() Overrides io.netty5.channel.epoll.AbstractEpollChannel.doDisconnect. Disconnect this `Channel` from its remote peer
private AbstractEpollChannel.ReadState	doReadBuffer(AbstractChannel<UnixChannel, SocketAddress, SocketAddress>.ReadSink readSink)
private AbstractEpollChannel.ReadState	doReadBufferDomainSocket(AbstractChannel<UnixChannel, SocketAddress, SocketAddress>.ReadSink readSink)
protected void	doShutdown(ChannelShutdownDirection the direction to shut down. direction) Implements abstract io.netty5.channel.AbstractChannel.doShutdown. Shutdown one direction of the `Channel`.
private void	doWriteMessage(AbstractChannel<UnixChannel, SocketAddress, SocketAddress>.WriteSink writeSink)
protected void	doWriteNow(AbstractChannel<UnixChannel, SocketAddress, SocketAddress>.WriteSink the `WriteSink` that must be completed with the write progress. `WriteSink#complete(long, long, int, boolean)` or `WriteSink#complete(long, Throwable, boolean)` must be called exactly once before this method returns non-exceptional. writeSink) Implements abstract io.netty5.channel.AbstractChannel.doWriteNow. Called in a loop when writes should be performed until this method returns `false` or there are no more messages to write.
protected AbstractEpollChannel.ReadState	epollInReady(AbstractChannel<UnixChannel, SocketAddress, SocketAddress>.ReadSink readSink) Implements abstract io.netty5.channel.epoll.AbstractEpollChannel.epollInReady. Called once EPOLLIN event is ready to be processed
protected Object	filterOutboundMessage(Object the message to filter / convert. msg) Overrides io.netty5.channel.AbstractChannel.filterOutboundMessage. Invoked when a new message is added to to the outbound queue of this `AbstractChannel`, so that the `Channel` implementation converts the message to another.
private Object	filterOutboundMessage0(Object msg, Class<? extends SocketAddress> recipientClass, String expectedTypes)
pack-priv boolean	getActiveOnOpen()
protected <T> T	getExtendedOption(ChannelOption<T> the `ChannelOption`. option) Overrides io.netty5.channel.epoll.AbstractEpollChannel.getExtendedOption. Override to add support for more `ChannelOption`s.
private int	getMaxDatagramPayloadSize() Get the maximum `io.netty5.channel.socket.DatagramPacket` size.
private NetworkInterface	getNetworkInterface()
private int	getReceiveBufferSize()
private int	getSendBufferSize()
private int	getTimeToLive()
private int	getTrafficClass()
public boolean	isActive() Overrides io.netty5.channel.epoll.AbstractEpollChannel.isActive. Implements io.netty5.channel.Channel.isActive. Return `true` if the `Channel` is active and so connected.
private boolean	isBroadcast()
public boolean	isConnected() Implements io.netty5.channel.socket.DatagramChannel.isConnected. Return `true` if the `DatagramChannel` is connected to the remote peer.
protected boolean	isExtendedOptionSupported(ChannelOption<?> the `ChannelOption`. option) Overrides io.netty5.channel.epoll.AbstractEpollChannel.isExtendedOptionSupported. Override to add support for more `ChannelOption`s.
private boolean	isFreeBind() Returns `true` if IP_FREEBIND is enabled, `false` otherwise.
private boolean	isIpRecvOrigDestAddr() Returns `true` if IP_RECVORIGDSTADDR is enabled, `false` otherwise.
private boolean	isIpTransparent() Returns `true` if IP_TRANSPARENT is enabled, `false` otherwise.
private boolean	isLoopbackModeDisabled()
private static boolean	isOptionSupported(SocketProtocolFamily family, ChannelOption<?> option)
private boolean	isReuseAddress()
private boolean	isReusePort() Returns `true` if the SO_REUSEPORT option is set.
public static boolean	Returns: `true` if supported, `false` otherwise. isSegmentedDatagramPacketSupported() Returns `true` if `SegmentedDatagramPacket` is supported natively.
public boolean	isShutdown(ChannelShutdownDirection direction) Implements io.netty5.channel.Channel.isShutdown. Returns `true` if the `ChannelShutdownDirection` of the `Channel` was shutdown before.
private boolean	Returns: `true` if enabled, `false` otherwise. isUdpGro() Returns if `UDP_GRO` is enabled.
public Future<Void>	joinGroup(InetAddress the multicast group address. multicastAddress) Implements io.netty5.channel.socket.DatagramChannel.joinGroup. Joins a multicast group and notifies the `Future` once the operation completes.
public Future<Void>	joinGroup(InetAddress the multicast group address. multicastAddress, NetworkInterface the interface to use. networkInterface, InetAddress the source address (might be `null`). source) Implements io.netty5.channel.socket.DatagramChannel.joinGroup. Joins the specified multicast group at the specified interface and notifies the `Future` once the operation completes.
private void	joinGroup0(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source, Promise<Void> promise)
public Future<Void>	leaveGroup(InetAddress the multicast group address. multicastAddress) Implements io.netty5.channel.socket.DatagramChannel.leaveGroup. Leaves a multicast group and notifies the `Future` once the operation completes.
public Future<Void>	leaveGroup(InetAddress the multicast group address. multicastAddress, NetworkInterface the interface to use. networkInterface, InetAddress the source address (might be `null`). source) Implements io.netty5.channel.socket.DatagramChannel.leaveGroup. Leave the specified multicast group at the specified interface using the specified source and notifies the `Future` once the operation completes.
private void	leaveGroup0(final InetAddress multicastAddress, final NetworkInterface networkInterface, final InetAddress source, final Promise<Void> promise)
private NetworkInterface	networkInterface()
private static void	processPacketList(AbstractChannel<UnixChannel, SocketAddress, SocketAddress>.ReadSink readSink, int attemptedBytesRead, RecyclableArrayList packetList)
private AbstractEpollChannel.ReadState	recvmsg(AbstractChannel<UnixChannel, SocketAddress, SocketAddress>.ReadSink readSink, NativeDatagramPacketArray array, Buffer buf)
private static void	releaseAndRecycle(Object buffer, RecyclableArrayList packetList)
private AbstractEpollChannel.ReadState	scatteringRead(AbstractChannel<UnixChannel, SocketAddress, SocketAddress>.ReadSink readSink, NativeDatagramPacketArray array, Buffer buf, int datagramSize, int numDatagram)
private void	setActiveOnOpen(boolean activeOnOpen)
private void	setBroadcast(boolean broadcast)
protected <T> void	setExtendedOption(ChannelOption<T> the `ChannelOption`. option, T value) Overrides io.netty5.channel.epoll.AbstractEpollChannel.setExtendedOption. Override to add support for more `ChannelOption`s.
private void	setFreeBind(boolean freeBind) If `true` is used IP_FREEBIND is enabled, `false` for disable it.
private void	setIpRecvOrigDestAddr(boolean ipTransparent) If `true` is used IP_RECVORIGDSTADDR is enabled, `false` for disable it.
private void	setIpTransparent(boolean ipTransparent) If `true` is used IP_TRANSPARENT is enabled, `false` for disable it.
private void	setLoopbackModeDisabled(boolean loopbackModeDisabled)
private void	setMaxDatagramPayloadSize(int maxDatagramSize) Set the maximum `io.netty5.channel.socket.DatagramPacket` size.
private void	setNetworkInterface(NetworkInterface networkInterface)
private void	setReceiveBufferSize(int receiveBufferSize)
private void	setReuseAddress(boolean reuseAddress)
private void	setReusePort(boolean reusePort) Set the SO_REUSEPORT option on the underlying Channel.
private void	setSendBufferSize(int sendBufferSize)
private void	setTimeToLive(int ttl)
private void	setTrafficClass(int trafficClass)
private void	setUdpGro(boolean `true` if `UDP_GRO` should be enabled, `false` otherwise. gro) Enable / disable UDP_GRO.
private static Set<ChannelOption<?>>	supportedOptions() Hides io.netty5.channel.AbstractChannel.supportedOptions.
private static Set<ChannelOption<?>>	supportedOptionsDomainSocket()
private IOException	translateForConnected(Errors.NativeIoException e)

public final Class EpollDatagramChannel

Available options

Field Summary

Constructor Summary

Method Summary