Class EpollDatagramChannel

java.lang.Object

io.netty.util.DefaultAttributeMap

io.netty.channel.AbstractChannel

io.netty.channel.epoll.AbstractEpollChannel

io.netty.channel.epoll.EpollDatagramChannel

All Implemented Interfaces:

Channel, ChannelOutboundInvoker, DatagramChannel, UnixChannel, AttributeMap, Comparable<Channel>

public final class EpollDatagramChannel
extends AbstractEpollChannel
implements DatagramChannel

DatagramChannel implementation that uses linux EPOLL Edge-Triggered Mode for maximal performance.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) final class	EpollDatagramChannel.EpollDatagramChannelUnsafe

Nested classes/interfaces inherited from class AbstractEpollChannel

AbstractEpollChannel.AbstractEpollUnsafe

Nested classes/interfaces inherited from class AbstractChannel

AbstractChannel.AbstractUnsafe

Nested classes/interfaces inherited from interface Channel

Channel.Unsafe

Field Summary

Fields

Modifier and Type	Field	Description
private final EpollDatagramChannelConfig	config
private boolean	connected
private static final String	EXPECTED_TYPES
private static final ChannelMetadata	METADATA

Fields inherited from class AbstractEpollChannel

active, epollInReadyRunnablePending, flags, inputClosedSeenErrorOnRead, socket

Constructor Summary

Constructors

Modifier	Constructor	Description
	EpollDatagramChannel()	Create a new instance which selects the InternetProtocolFamily to use depending on the Operation Systems default which will be chosen.
	EpollDatagramChannel(int fd)	Create a new instance which selects the InternetProtocolFamily to use depending on the Operation Systems default which will be chosen.
private	EpollDatagramChannel(LinuxSocket fd, boolean active)
	EpollDatagramChannel(InternetProtocolFamily family)	Create a new instance using the given InternetProtocolFamily.

Method Summary

Modifier and Type	Method	Description
private static void	addDatagramPacketToOut(DatagramPacket packet, RecyclableArrayList out)
ChannelFuture	block(InetAddress multicastAddress, InetAddress sourceToBlock)	Block the given sourceToBlock address for the given multicastAddress and notifies the ChannelFuture once the operation completes.
ChannelFuture	block(InetAddress multicastAddress, InetAddress sourceToBlock, ChannelPromise promise)	Block the given sourceToBlock address for the given multicastAddress and notifies the ChannelFuture once the operation completes.
ChannelFuture	block(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress sourceToBlock)	Block the given sourceToBlock address for the given multicastAddress on the given networkInterface and notifies the ChannelFuture once the operation completes.
ChannelFuture	block(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress sourceToBlock, ChannelPromise promise)	Block the given sourceToBlock address for the given multicastAddress on the given networkInterface and notifies the ChannelFuture once the operation completes.
private static void	checkUnresolved(AddressedEnvelope<?,?> envelope)
private NativeDatagramPacketArray	cleanDatagramPacketArray()
EpollDatagramChannelConfig	config()	Returns the configuration of this channel.
private boolean	connectedRead(EpollRecvByteAllocatorHandle allocHandle, ByteBuf byteBuf, int maxDatagramPacketSize)
protected void	doBind(SocketAddress localAddress)	Bind the Channel to the SocketAddress
protected void	doClose()	Close the Channel
protected boolean	doConnect(SocketAddress remoteAddress, SocketAddress localAddress)	Connect to the remote peer
protected void	doDisconnect()	Disconnect this Channel from its remote peer
protected void	doWrite(ChannelOutboundBuffer in)	Flush the content of the given buffer to the remote peer.
private boolean	doWriteMessage(Object msg)
protected Object	filterOutboundMessage(Object msg)	Invoked when a new message is added to a ChannelOutboundBuffer of this AbstractChannel, so that the Channel implementation converts the message to another.
boolean	isActive()	Return true if the Channel is active and so connected.
boolean	isConnected()	Return true if the DatagramChannel is connected to the remote peer.
static boolean	isSegmentedDatagramPacketSupported()	Returns true if SegmentedDatagramPacket is supported natively.
ChannelFuture	joinGroup(InetAddress multicastAddress)	Joins a multicast group and notifies the ChannelFuture once the operation completes.
ChannelFuture	joinGroup(InetAddress multicastAddress, ChannelPromise promise)	Joins a multicast group and notifies the ChannelFuture once the operation completes.
ChannelFuture	joinGroup(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source)	Joins the specified multicast group at the specified interface and notifies the ChannelFuture once the operation completes.
ChannelFuture	joinGroup(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source, ChannelPromise promise)	Joins the specified multicast group at the specified interface and notifies the ChannelFuture once the operation completes.
ChannelFuture	joinGroup(InetSocketAddress multicastAddress, NetworkInterface networkInterface)	Joins the specified multicast group at the specified interface and notifies the ChannelFuture once the operation completes.
ChannelFuture	joinGroup(InetSocketAddress multicastAddress, NetworkInterface networkInterface, ChannelPromise promise)	Joins the specified multicast group at the specified interface and notifies the ChannelFuture once the operation completes.
private void	joinGroup0(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source, ChannelPromise promise)
ChannelFuture	leaveGroup(InetAddress multicastAddress)	Leaves a multicast group and notifies the ChannelFuture once the operation completes.
ChannelFuture	leaveGroup(InetAddress multicastAddress, ChannelPromise promise)	Leaves a multicast group and notifies the ChannelFuture once the operation completes.
ChannelFuture	leaveGroup(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source)	Leave the specified multicast group at the specified interface using the specified source and notifies the ChannelFuture once the operation completes.
ChannelFuture	leaveGroup(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source, ChannelPromise promise)	Leave the specified multicast group at the specified interface using the specified source and notifies the ChannelFuture once the operation completes.
ChannelFuture	leaveGroup(InetSocketAddress multicastAddress, NetworkInterface networkInterface)	Leaves a multicast group on a specified local interface and notifies the ChannelFuture once the operation completes.
ChannelFuture	leaveGroup(InetSocketAddress multicastAddress, NetworkInterface networkInterface, ChannelPromise promise)	Leaves a multicast group on a specified local interface and notifies the ChannelFuture once the operation completes.
private void	leaveGroup0(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source, ChannelPromise promise)
InetSocketAddress	localAddress()	Returns the local address where this channel is bound to.
ChannelMetadata	metadata()	Return the ChannelMetadata of the Channel which describe the nature of the Channel.
protected AbstractEpollChannel.AbstractEpollUnsafe	newUnsafe()	Create a new AbstractChannel.AbstractUnsafe instance which will be used for the life-time of the Channel
private static void	processPacket(ChannelPipeline pipeline, EpollRecvByteAllocatorHandle handle, int bytesRead, DatagramPacket packet)
private static void	processPacketList(ChannelPipeline pipeline, EpollRecvByteAllocatorHandle handle, int bytesRead, RecyclableArrayList packetList)
private boolean	recvmsg(EpollRecvByteAllocatorHandle allocHandle, NativeDatagramPacketArray array, ByteBuf byteBuf)
private static void	releaseAndRecycle(ByteBuf byteBuf, RecyclableArrayList packetList)
InetSocketAddress	remoteAddress()	Returns the remote address where this channel is connected to.
private boolean	scatteringRead(EpollRecvByteAllocatorHandle allocHandle, NativeDatagramPacketArray array, ByteBuf byteBuf, int datagramSize, int numDatagram)
private IOException	translateForConnected(Errors.NativeIoException e)

Methods inherited from class AbstractEpollChannel

checkResolvable, clearEpollIn, clearFlag, doBeginRead, doConnect0, doDeregister, doReadBytes, doRegister, doWriteBytes, doWriteOrSendBytes, fd, isCompatible, isFlagSet, isOpen, isSoErrorZero, localAddress0, newDirectBuffer, newDirectBuffer, remoteAddress0, resetCachedAddresses, setFlag, shouldBreakEpollInReady

Methods inherited from class AbstractChannel

alloc, bind, bind, bytesBeforeUnwritable, bytesBeforeWritable, close, close, closeFuture, compareTo, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, doShutdownOutput, equals, eventLoop, flush, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, maxMessagesPerWrite, newChannelPipeline, newFailedFuture, newId, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, toString, unsafe, validateFileRegion, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from class DefaultAttributeMap

attr, hasAttr

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface AttributeMap

attr, hasAttr

Methods inherited from interface Channel

alloc, bytesBeforeUnwritable, bytesBeforeWritable, closeFuture, eventLoop, flush, id, isOpen, isRegistered, isWritable, parent, pipeline, read, unsafe

Methods inherited from interface ChannelOutboundInvoker

bind, bind, close, close, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from interface Comparable

compareTo

Field Details

METADATA

private static final ChannelMetadata METADATA

EXPECTED_TYPES

private static final String EXPECTED_TYPES

config

private final EpollDatagramChannelConfig config

connected

private volatile boolean connected

Constructor Details

EpollDatagramChannel

public EpollDatagramChannel()

Create a new instance which selects the InternetProtocolFamily to use depending on the Operation Systems default which will be chosen.

EpollDatagramChannel

public EpollDatagramChannel(InternetProtocolFamily family)

Create a new instance using the given InternetProtocolFamily. If null is used it will depend on the Operation Systems default which will be chosen.

EpollDatagramChannel

public EpollDatagramChannel(int fd)

Create a new instance which selects the InternetProtocolFamily to use depending on the Operation Systems default which will be chosen.

EpollDatagramChannel

private EpollDatagramChannel(LinuxSocket fd,
 boolean active)

Method Details

isSegmentedDatagramPacketSupported

public static boolean isSegmentedDatagramPacketSupported()

Returns true if SegmentedDatagramPacket is supported natively.

Returns:

true if supported, false otherwise.

remoteAddress

public InetSocketAddress remoteAddress()

Description copied from interface: Channel

Returns the remote address where this channel is connected to. The returned SocketAddress is supposed to be down-cast into more concrete type such as InetSocketAddress to retrieve the detailed information.

Specified by:

remoteAddress in interface Channel

Specified by:

remoteAddress in interface DatagramChannel

Overrides:

remoteAddress in class AbstractChannel

Returns:

the remote address of this channel. null if this channel is not connected. If this channel is not connected but it can receive messages from arbitrary remote addresses (e.g. DatagramChannel, use DefaultAddressedEnvelope.recipient() to determine the origination of the received message as this method will return null.

localAddress

public InetSocketAddress localAddress()

Description copied from interface: Channel

Returns the local address where this channel is bound to. The returned SocketAddress is supposed to be down-cast into more concrete type such as InetSocketAddress to retrieve the detailed information.

Specified by:

localAddress in interface Channel

Specified by:

localAddress in interface DatagramChannel

Overrides:

localAddress in class AbstractChannel

Returns:

the local address of this channel. null if this channel is not bound.

metadata

public ChannelMetadata metadata()

Description copied from interface: Channel

Return the ChannelMetadata of the Channel which describe the nature of the Channel.

Specified by:

metadata in interface Channel

Overrides:

metadata in class AbstractEpollChannel

isActive

public boolean isActive()

Description copied from interface: Channel

Return true if the Channel is active and so connected.

Specified by:

isActive in interface Channel

Overrides:

isActive in class AbstractEpollChannel

isConnected

public boolean isConnected()

Description copied from interface: DatagramChannel

Return true if the DatagramChannel is connected to the remote peer.

Specified by:

isConnected in interface DatagramChannel

joinGroup

public ChannelFuture joinGroup(InetAddress multicastAddress)

Description copied from interface: DatagramChannel

Joins a multicast group and notifies the ChannelFuture once the operation completes.

Specified by:

joinGroup in interface DatagramChannel

joinGroup

public ChannelFuture joinGroup(InetAddress multicastAddress,
 ChannelPromise promise)

Description copied from interface: DatagramChannel

Joins a multicast group and notifies the ChannelFuture once the operation completes. The given ChannelFuture will be notified and also returned.

Specified by:

joinGroup in interface DatagramChannel

joinGroup

public ChannelFuture joinGroup(InetSocketAddress multicastAddress,
 NetworkInterface networkInterface)

Description copied from interface: DatagramChannel

Joins the specified multicast group at the specified interface and notifies the ChannelFuture once the operation completes.

Specified by:

joinGroup in interface DatagramChannel

joinGroup

public ChannelFuture joinGroup(InetSocketAddress multicastAddress,
 NetworkInterface networkInterface,
 ChannelPromise promise)

Description copied from interface: DatagramChannel

Joins the specified multicast group at the specified interface and notifies the ChannelFuture once the operation completes. The given ChannelFuture will be notified and also returned.

Specified by:

joinGroup in interface DatagramChannel

joinGroup

public ChannelFuture joinGroup(InetAddress multicastAddress,
 NetworkInterface networkInterface,
 InetAddress source)

Description copied from interface: DatagramChannel

Joins the specified multicast group at the specified interface and notifies the ChannelFuture once the operation completes.

Specified by:

joinGroup in interface DatagramChannel

joinGroup

public ChannelFuture joinGroup(InetAddress multicastAddress,
 NetworkInterface networkInterface,
 InetAddress source,
 ChannelPromise promise)

Description copied from interface: DatagramChannel

Joins the specified multicast group at the specified interface and notifies the ChannelFuture once the operation completes. The given ChannelFuture will be notified and also returned.

Specified by:

joinGroup in interface DatagramChannel

joinGroup0

private void joinGroup0(InetAddress multicastAddress,
 NetworkInterface networkInterface,
 InetAddress source,
 ChannelPromise promise)

leaveGroup

public ChannelFuture leaveGroup(InetAddress multicastAddress)

Description copied from interface: DatagramChannel

Leaves a multicast group and notifies the ChannelFuture once the operation completes.

Specified by:

leaveGroup in interface DatagramChannel

leaveGroup

public ChannelFuture leaveGroup(InetAddress multicastAddress,
 ChannelPromise promise)

Description copied from interface: DatagramChannel

Leaves a multicast group and notifies the ChannelFuture once the operation completes. The given ChannelFuture will be notified and also returned.

Specified by:

leaveGroup in interface DatagramChannel

leaveGroup

public ChannelFuture leaveGroup(InetSocketAddress multicastAddress,
 NetworkInterface networkInterface)

Description copied from interface: DatagramChannel

Leaves a multicast group on a specified local interface and notifies the ChannelFuture once the operation completes.

Specified by:

leaveGroup in interface DatagramChannel

leaveGroup

public ChannelFuture leaveGroup(InetSocketAddress multicastAddress,
 NetworkInterface networkInterface,
 ChannelPromise promise)

Description copied from interface: DatagramChannel

Leaves a multicast group on a specified local interface and notifies the ChannelFuture once the operation completes. The given ChannelFuture will be notified and also returned.

Specified by:

leaveGroup in interface DatagramChannel

leaveGroup

public ChannelFuture leaveGroup(InetAddress multicastAddress,
 NetworkInterface networkInterface,
 InetAddress source)

Description copied from interface: DatagramChannel

Leave the specified multicast group at the specified interface using the specified source and notifies the ChannelFuture once the operation completes.

Specified by:

leaveGroup in interface DatagramChannel

leaveGroup

public ChannelFuture leaveGroup(InetAddress multicastAddress,
 NetworkInterface networkInterface,
 InetAddress source,
 ChannelPromise promise)

Description copied from interface: DatagramChannel

Leave the specified multicast group at the specified interface using the specified source and notifies the ChannelFuture once the operation completes. The given ChannelFuture will be notified and also returned.

Specified by:

leaveGroup in interface DatagramChannel

leaveGroup0

private void leaveGroup0(InetAddress multicastAddress,
 NetworkInterface networkInterface,
 InetAddress source,
 ChannelPromise promise)

block

public ChannelFuture block(InetAddress multicastAddress,
 NetworkInterface networkInterface,
 InetAddress sourceToBlock)

Description copied from interface: DatagramChannel

Block the given sourceToBlock address for the given multicastAddress on the given networkInterface and notifies the ChannelFuture once the operation completes. The given ChannelFuture will be notified and also returned.

Specified by:

block in interface DatagramChannel

block

public ChannelFuture block(InetAddress multicastAddress,
 NetworkInterface networkInterface,
 InetAddress sourceToBlock,
 ChannelPromise promise)

Description copied from interface: DatagramChannel

Block the given sourceToBlock address for the given multicastAddress on the given networkInterface and notifies the ChannelFuture once the operation completes. The given ChannelFuture will be notified and also returned.

Specified by:

block in interface DatagramChannel

block

public ChannelFuture block(InetAddress multicastAddress,
 InetAddress sourceToBlock)

Description copied from interface: DatagramChannel

Block the given sourceToBlock address for the given multicastAddress and notifies the ChannelFuture once the operation completes. The given ChannelFuture will be notified and also returned.

Specified by:

block in interface DatagramChannel

block

public ChannelFuture block(InetAddress multicastAddress,
 InetAddress sourceToBlock,
 ChannelPromise promise)

Description copied from interface: DatagramChannel

Block the given sourceToBlock address for the given multicastAddress and notifies the ChannelFuture once the operation completes. The given ChannelFuture will be notified and also returned.

Specified by:

block in interface DatagramChannel

newUnsafe

protected AbstractEpollChannel.AbstractEpollUnsafe newUnsafe()

Description copied from class: AbstractChannel

Create a new AbstractChannel.AbstractUnsafe instance which will be used for the life-time of the Channel

Specified by:

newUnsafe in class AbstractEpollChannel

doBind

protected void doBind(SocketAddress localAddress)
               throws Exception

Description copied from class: AbstractChannel

Bind the Channel to the SocketAddress

Overrides:

doBind in class AbstractEpollChannel

Throws:

Exception

doWrite

protected void doWrite(ChannelOutboundBuffer in)
                throws Exception

Description copied from class: AbstractChannel

Flush the content of the given buffer to the remote peer.

Specified by:

doWrite in class AbstractChannel

Throws:

Exception

doWriteMessage

private boolean doWriteMessage(Object msg)
                        throws Exception

Throws:

Exception

checkUnresolved

private static void checkUnresolved(AddressedEnvelope<?,?> envelope)

filterOutboundMessage

protected Object filterOutboundMessage(Object msg)

Description copied from class: AbstractChannel

Invoked when a new message is added to a ChannelOutboundBuffer of this AbstractChannel, so that the Channel implementation converts the message to another. (e.g. heap buffer -> direct buffer)

Overrides:

filterOutboundMessage in class AbstractChannel

config

public EpollDatagramChannelConfig config()

Description copied from interface: Channel

Returns the configuration of this channel.

Specified by:

config in interface Channel

Specified by:

config in interface DatagramChannel

Specified by:

config in class AbstractEpollChannel

doDisconnect

protected void doDisconnect()
                     throws Exception

Description copied from class: AbstractChannel

Disconnect this Channel from its remote peer

Overrides:

doDisconnect in class AbstractEpollChannel

Throws:

Exception

doConnect

protected boolean doConnect(SocketAddress remoteAddress,
 SocketAddress localAddress)
                     throws Exception

Description copied from class: AbstractEpollChannel

Connect to the remote peer

Overrides:

doConnect in class AbstractEpollChannel

Throws:

Exception

doClose

protected void doClose()
                throws Exception

Description copied from class: AbstractChannel

Close the Channel

Overrides:

doClose in class AbstractEpollChannel

Throws:

Exception

connectedRead

private boolean connectedRead(EpollRecvByteAllocatorHandle allocHandle,
 ByteBuf byteBuf,
 int maxDatagramPacketSize)
                       throws Exception

Throws:

Exception

translateForConnected

private IOException translateForConnected(Errors.NativeIoException e)

addDatagramPacketToOut

private static void addDatagramPacketToOut(DatagramPacket packet,
 RecyclableArrayList out)

releaseAndRecycle

private static void releaseAndRecycle(ByteBuf byteBuf,
 RecyclableArrayList packetList)

processPacket

private static void processPacket(ChannelPipeline pipeline,
 EpollRecvByteAllocatorHandle handle,
 int bytesRead,
 DatagramPacket packet)

processPacketList

private static void processPacketList(ChannelPipeline pipeline,
 EpollRecvByteAllocatorHandle handle,
 int bytesRead,
 RecyclableArrayList packetList)

recvmsg

private boolean recvmsg(EpollRecvByteAllocatorHandle allocHandle,
 NativeDatagramPacketArray array,
 ByteBuf byteBuf)
                 throws IOException

Throws:

IOException

scatteringRead

private boolean scatteringRead(EpollRecvByteAllocatorHandle allocHandle,
 NativeDatagramPacketArray array,
 ByteBuf byteBuf,
 int datagramSize,
 int numDatagram)
                        throws IOException

Throws:

IOException

cleanDatagramPacketArray

private NativeDatagramPacketArray cleanDatagramPacketArray()