Package io.netty.channel.epoll
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
,java.lang.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) class
EpollDatagramChannel.EpollDatagramChannelUnsafe
-
Nested classes/interfaces inherited from class io.netty.channel.epoll.AbstractEpollChannel
AbstractEpollChannel.AbstractEpollUnsafe
-
Nested classes/interfaces inherited from class io.netty.channel.AbstractChannel
AbstractChannel.AbstractUnsafe
-
Nested classes/interfaces inherited from interface io.netty.channel.Channel
Channel.Unsafe
-
-
Field Summary
Fields Modifier and Type Field Description private EpollDatagramChannelConfig
config
private boolean
connected
private static java.lang.String
EXPECTED_TYPES
private static ChannelMetadata
METADATA
-
Fields inherited from class io.netty.channel.epoll.AbstractEpollChannel
active, epollInReadyRunnablePending, flags, inputClosedSeenErrorOnRead, socket
-
-
Constructor Summary
Constructors Modifier Constructor Description EpollDatagramChannel()
Create a new instance which selects theInternetProtocolFamily
to use depending on the Operation Systems default which will be chosen.EpollDatagramChannel(int fd)
Create a new instance which selects theInternetProtocolFamily
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 givenInternetProtocolFamily
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description private static void
addDatagramPacketToOut(DatagramPacket packet, RecyclableArrayList out)
ChannelFuture
block(java.net.InetAddress multicastAddress, java.net.InetAddress sourceToBlock)
Block the given sourceToBlock address for the given multicastAddress and notifies theChannelFuture
once the operation completes.ChannelFuture
block(java.net.InetAddress multicastAddress, java.net.InetAddress sourceToBlock, ChannelPromise promise)
Block the given sourceToBlock address for the given multicastAddress and notifies theChannelFuture
once the operation completes.ChannelFuture
block(java.net.InetAddress multicastAddress, java.net.NetworkInterface networkInterface, java.net.InetAddress sourceToBlock)
Block the given sourceToBlock address for the given multicastAddress on the given networkInterface and notifies theChannelFuture
once the operation completes.ChannelFuture
block(java.net.InetAddress multicastAddress, java.net.NetworkInterface networkInterface, java.net.InetAddress sourceToBlock, ChannelPromise promise)
Block the given sourceToBlock address for the given multicastAddress on the given networkInterface and notifies theChannelFuture
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(java.net.SocketAddress localAddress)
Bind theChannel
to theSocketAddress
protected void
doClose()
Close theChannel
protected boolean
doConnect(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress)
Connect to the remote peerprotected void
doDisconnect()
Disconnect thisChannel
from its remote peerprotected void
doWrite(ChannelOutboundBuffer in)
Flush the content of the given buffer to the remote peer.private boolean
doWriteMessage(java.lang.Object msg)
protected java.lang.Object
filterOutboundMessage(java.lang.Object msg)
Invoked when a new message is added to aChannelOutboundBuffer
of thisAbstractChannel
, so that theChannel
implementation converts the message to another.boolean
isActive()
Returntrue
if theChannel
is active and so connected.boolean
isConnected()
Returntrue
if theDatagramChannel
is connected to the remote peer.static boolean
isSegmentedDatagramPacketSupported()
Returnstrue
ifSegmentedDatagramPacket
is supported natively.ChannelFuture
joinGroup(java.net.InetAddress multicastAddress)
Joins a multicast group and notifies theChannelFuture
once the operation completes.ChannelFuture
joinGroup(java.net.InetAddress multicastAddress, ChannelPromise promise)
Joins a multicast group and notifies theChannelFuture
once the operation completes.ChannelFuture
joinGroup(java.net.InetAddress multicastAddress, java.net.NetworkInterface networkInterface, java.net.InetAddress source)
Joins the specified multicast group at the specified interface and notifies theChannelFuture
once the operation completes.ChannelFuture
joinGroup(java.net.InetAddress multicastAddress, java.net.NetworkInterface networkInterface, java.net.InetAddress source, ChannelPromise promise)
Joins the specified multicast group at the specified interface and notifies theChannelFuture
once the operation completes.ChannelFuture
joinGroup(java.net.InetSocketAddress multicastAddress, java.net.NetworkInterface networkInterface)
Joins the specified multicast group at the specified interface and notifies theChannelFuture
once the operation completes.ChannelFuture
joinGroup(java.net.InetSocketAddress multicastAddress, java.net.NetworkInterface networkInterface, ChannelPromise promise)
Joins the specified multicast group at the specified interface and notifies theChannelFuture
once the operation completes.private void
joinGroup0(java.net.InetAddress multicastAddress, java.net.NetworkInterface networkInterface, java.net.InetAddress source, ChannelPromise promise)
ChannelFuture
leaveGroup(java.net.InetAddress multicastAddress)
Leaves a multicast group and notifies theChannelFuture
once the operation completes.ChannelFuture
leaveGroup(java.net.InetAddress multicastAddress, ChannelPromise promise)
Leaves a multicast group and notifies theChannelFuture
once the operation completes.ChannelFuture
leaveGroup(java.net.InetAddress multicastAddress, java.net.NetworkInterface networkInterface, java.net.InetAddress source)
Leave the specified multicast group at the specified interface using the specified source and notifies theChannelFuture
once the operation completes.ChannelFuture
leaveGroup(java.net.InetAddress multicastAddress, java.net.NetworkInterface networkInterface, java.net.InetAddress source, ChannelPromise promise)
Leave the specified multicast group at the specified interface using the specified source and notifies theChannelFuture
once the operation completes.ChannelFuture
leaveGroup(java.net.InetSocketAddress multicastAddress, java.net.NetworkInterface networkInterface)
Leaves a multicast group on a specified local interface and notifies theChannelFuture
once the operation completes.ChannelFuture
leaveGroup(java.net.InetSocketAddress multicastAddress, java.net.NetworkInterface networkInterface, ChannelPromise promise)
Leaves a multicast group on a specified local interface and notifies theChannelFuture
once the operation completes.private void
leaveGroup0(java.net.InetAddress multicastAddress, java.net.NetworkInterface networkInterface, java.net.InetAddress source, ChannelPromise promise)
java.net.InetSocketAddress
localAddress()
Returns the local address where this channel is bound to.ChannelMetadata
metadata()
protected AbstractEpollChannel.AbstractEpollUnsafe
newUnsafe()
Create a newAbstractChannel.AbstractUnsafe
instance which will be used for the life-time of theChannel
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)
java.net.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 java.io.IOException
translateForConnected(Errors.NativeIoException e)
-
Methods inherited from class io.netty.channel.epoll.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 io.netty.channel.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 io.netty.util.DefaultAttributeMap
attr, hasAttr
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface io.netty.util.AttributeMap
attr, hasAttr
-
Methods inherited from interface io.netty.channel.Channel
alloc, bytesBeforeUnwritable, bytesBeforeWritable, closeFuture, eventLoop, flush, id, isOpen, isRegistered, isWritable, parent, pipeline, read, unsafe
-
Methods inherited from interface io.netty.channel.ChannelOutboundInvoker
bind, bind, close, close, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, voidPromise, write, write, writeAndFlush, writeAndFlush
-
-
-
-
Field Detail
-
METADATA
private static final ChannelMetadata METADATA
-
EXPECTED_TYPES
private static final java.lang.String EXPECTED_TYPES
-
config
private final EpollDatagramChannelConfig config
-
connected
private volatile boolean connected
-
-
Constructor Detail
-
EpollDatagramChannel
public EpollDatagramChannel()
Create a new instance which selects theInternetProtocolFamily
to use depending on the Operation Systems default which will be chosen.
-
EpollDatagramChannel
public EpollDatagramChannel(InternetProtocolFamily family)
Create a new instance using the givenInternetProtocolFamily
. Ifnull
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 theInternetProtocolFamily
to use depending on the Operation Systems default which will be chosen.
-
EpollDatagramChannel
private EpollDatagramChannel(LinuxSocket fd, boolean active)
-
-
Method Detail
-
isSegmentedDatagramPacketSupported
public static boolean isSegmentedDatagramPacketSupported()
Returnstrue
ifSegmentedDatagramPacket
is supported natively.- Returns:
true
if supported,false
otherwise.
-
remoteAddress
public java.net.InetSocketAddress remoteAddress()
Description copied from interface:Channel
Returns the remote address where this channel is connected to. The returnedSocketAddress
is supposed to be down-cast into more concrete type such asInetSocketAddress
to retrieve the detailed information.- Specified by:
remoteAddress
in interfaceChannel
- Specified by:
remoteAddress
in interfaceDatagramChannel
- Overrides:
remoteAddress
in classAbstractChannel
- 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
, useDefaultAddressedEnvelope.recipient()
to determine the origination of the received message as this method will returnnull
.
-
localAddress
public java.net.InetSocketAddress localAddress()
Description copied from interface:Channel
Returns the local address where this channel is bound to. The returnedSocketAddress
is supposed to be down-cast into more concrete type such asInetSocketAddress
to retrieve the detailed information.- Specified by:
localAddress
in interfaceChannel
- Specified by:
localAddress
in interfaceDatagramChannel
- Overrides:
localAddress
in classAbstractChannel
- Returns:
- the local address of this channel.
null
if this channel is not bound.
-
metadata
public ChannelMetadata metadata()
Description copied from interface:Channel
- Specified by:
metadata
in interfaceChannel
- Overrides:
metadata
in classAbstractEpollChannel
-
isActive
public boolean isActive()
Description copied from interface:Channel
Returntrue
if theChannel
is active and so connected.- Specified by:
isActive
in interfaceChannel
- Overrides:
isActive
in classAbstractEpollChannel
-
isConnected
public boolean isConnected()
Description copied from interface:DatagramChannel
Returntrue
if theDatagramChannel
is connected to the remote peer.- Specified by:
isConnected
in interfaceDatagramChannel
-
joinGroup
public ChannelFuture joinGroup(java.net.InetAddress multicastAddress)
Description copied from interface:DatagramChannel
Joins a multicast group and notifies theChannelFuture
once the operation completes.- Specified by:
joinGroup
in interfaceDatagramChannel
-
joinGroup
public ChannelFuture joinGroup(java.net.InetAddress multicastAddress, ChannelPromise promise)
Description copied from interface:DatagramChannel
Joins a multicast group and notifies theChannelFuture
once the operation completes. The givenChannelFuture
will be notified and also returned.- Specified by:
joinGroup
in interfaceDatagramChannel
-
joinGroup
public ChannelFuture joinGroup(java.net.InetSocketAddress multicastAddress, java.net.NetworkInterface networkInterface)
Description copied from interface:DatagramChannel
Joins the specified multicast group at the specified interface and notifies theChannelFuture
once the operation completes.- Specified by:
joinGroup
in interfaceDatagramChannel
-
joinGroup
public ChannelFuture joinGroup(java.net.InetSocketAddress multicastAddress, java.net.NetworkInterface networkInterface, ChannelPromise promise)
Description copied from interface:DatagramChannel
Joins the specified multicast group at the specified interface and notifies theChannelFuture
once the operation completes. The givenChannelFuture
will be notified and also returned.- Specified by:
joinGroup
in interfaceDatagramChannel
-
joinGroup
public ChannelFuture joinGroup(java.net.InetAddress multicastAddress, java.net.NetworkInterface networkInterface, java.net.InetAddress source)
Description copied from interface:DatagramChannel
Joins the specified multicast group at the specified interface and notifies theChannelFuture
once the operation completes.- Specified by:
joinGroup
in interfaceDatagramChannel
-
joinGroup
public ChannelFuture joinGroup(java.net.InetAddress multicastAddress, java.net.NetworkInterface networkInterface, java.net.InetAddress source, ChannelPromise promise)
Description copied from interface:DatagramChannel
Joins the specified multicast group at the specified interface and notifies theChannelFuture
once the operation completes. The givenChannelFuture
will be notified and also returned.- Specified by:
joinGroup
in interfaceDatagramChannel
-
joinGroup0
private void joinGroup0(java.net.InetAddress multicastAddress, java.net.NetworkInterface networkInterface, java.net.InetAddress source, ChannelPromise promise)
-
leaveGroup
public ChannelFuture leaveGroup(java.net.InetAddress multicastAddress)
Description copied from interface:DatagramChannel
Leaves a multicast group and notifies theChannelFuture
once the operation completes.- Specified by:
leaveGroup
in interfaceDatagramChannel
-
leaveGroup
public ChannelFuture leaveGroup(java.net.InetAddress multicastAddress, ChannelPromise promise)
Description copied from interface:DatagramChannel
Leaves a multicast group and notifies theChannelFuture
once the operation completes. The givenChannelFuture
will be notified and also returned.- Specified by:
leaveGroup
in interfaceDatagramChannel
-
leaveGroup
public ChannelFuture leaveGroup(java.net.InetSocketAddress multicastAddress, java.net.NetworkInterface networkInterface)
Description copied from interface:DatagramChannel
Leaves a multicast group on a specified local interface and notifies theChannelFuture
once the operation completes.- Specified by:
leaveGroup
in interfaceDatagramChannel
-
leaveGroup
public ChannelFuture leaveGroup(java.net.InetSocketAddress multicastAddress, java.net.NetworkInterface networkInterface, ChannelPromise promise)
Description copied from interface:DatagramChannel
Leaves a multicast group on a specified local interface and notifies theChannelFuture
once the operation completes. The givenChannelFuture
will be notified and also returned.- Specified by:
leaveGroup
in interfaceDatagramChannel
-
leaveGroup
public ChannelFuture leaveGroup(java.net.InetAddress multicastAddress, java.net.NetworkInterface networkInterface, java.net.InetAddress source)
Description copied from interface:DatagramChannel
Leave the specified multicast group at the specified interface using the specified source and notifies theChannelFuture
once the operation completes.- Specified by:
leaveGroup
in interfaceDatagramChannel
-
leaveGroup
public ChannelFuture leaveGroup(java.net.InetAddress multicastAddress, java.net.NetworkInterface networkInterface, java.net.InetAddress source, ChannelPromise promise)
Description copied from interface:DatagramChannel
Leave the specified multicast group at the specified interface using the specified source and notifies theChannelFuture
once the operation completes. The givenChannelFuture
will be notified and also returned.- Specified by:
leaveGroup
in interfaceDatagramChannel
-
leaveGroup0
private void leaveGroup0(java.net.InetAddress multicastAddress, java.net.NetworkInterface networkInterface, java.net.InetAddress source, ChannelPromise promise)
-
block
public ChannelFuture block(java.net.InetAddress multicastAddress, java.net.NetworkInterface networkInterface, java.net.InetAddress sourceToBlock)
Description copied from interface:DatagramChannel
Block the given sourceToBlock address for the given multicastAddress on the given networkInterface and notifies theChannelFuture
once the operation completes. The givenChannelFuture
will be notified and also returned.- Specified by:
block
in interfaceDatagramChannel
-
block
public ChannelFuture block(java.net.InetAddress multicastAddress, java.net.NetworkInterface networkInterface, java.net.InetAddress sourceToBlock, ChannelPromise promise)
Description copied from interface:DatagramChannel
Block the given sourceToBlock address for the given multicastAddress on the given networkInterface and notifies theChannelFuture
once the operation completes. The givenChannelFuture
will be notified and also returned.- Specified by:
block
in interfaceDatagramChannel
-
block
public ChannelFuture block(java.net.InetAddress multicastAddress, java.net.InetAddress sourceToBlock)
Description copied from interface:DatagramChannel
Block the given sourceToBlock address for the given multicastAddress and notifies theChannelFuture
once the operation completes. The givenChannelFuture
will be notified and also returned.- Specified by:
block
in interfaceDatagramChannel
-
block
public ChannelFuture block(java.net.InetAddress multicastAddress, java.net.InetAddress sourceToBlock, ChannelPromise promise)
Description copied from interface:DatagramChannel
Block the given sourceToBlock address for the given multicastAddress and notifies theChannelFuture
once the operation completes. The givenChannelFuture
will be notified and also returned.- Specified by:
block
in interfaceDatagramChannel
-
newUnsafe
protected AbstractEpollChannel.AbstractEpollUnsafe newUnsafe()
Description copied from class:AbstractChannel
Create a newAbstractChannel.AbstractUnsafe
instance which will be used for the life-time of theChannel
- Specified by:
newUnsafe
in classAbstractEpollChannel
-
doBind
protected void doBind(java.net.SocketAddress localAddress) throws java.lang.Exception
Description copied from class:AbstractChannel
Bind theChannel
to theSocketAddress
- Overrides:
doBind
in classAbstractEpollChannel
- Throws:
java.lang.Exception
-
doWrite
protected void doWrite(ChannelOutboundBuffer in) throws java.lang.Exception
Description copied from class:AbstractChannel
Flush the content of the given buffer to the remote peer.- Specified by:
doWrite
in classAbstractChannel
- Throws:
java.lang.Exception
-
doWriteMessage
private boolean doWriteMessage(java.lang.Object msg) throws java.lang.Exception
- Throws:
java.lang.Exception
-
checkUnresolved
private static void checkUnresolved(AddressedEnvelope<?,?> envelope)
-
filterOutboundMessage
protected java.lang.Object filterOutboundMessage(java.lang.Object msg)
Description copied from class:AbstractChannel
Invoked when a new message is added to aChannelOutboundBuffer
of thisAbstractChannel
, so that theChannel
implementation converts the message to another. (e.g. heap buffer -> direct buffer)- Overrides:
filterOutboundMessage
in classAbstractChannel
-
config
public EpollDatagramChannelConfig config()
Description copied from interface:Channel
Returns the configuration of this channel.- Specified by:
config
in interfaceChannel
- Specified by:
config
in interfaceDatagramChannel
- Specified by:
config
in classAbstractEpollChannel
-
doDisconnect
protected void doDisconnect() throws java.lang.Exception
Description copied from class:AbstractChannel
Disconnect thisChannel
from its remote peer- Overrides:
doDisconnect
in classAbstractEpollChannel
- Throws:
java.lang.Exception
-
doConnect
protected boolean doConnect(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress) throws java.lang.Exception
Description copied from class:AbstractEpollChannel
Connect to the remote peer- Overrides:
doConnect
in classAbstractEpollChannel
- Throws:
java.lang.Exception
-
doClose
protected void doClose() throws java.lang.Exception
Description copied from class:AbstractChannel
Close theChannel
- Overrides:
doClose
in classAbstractEpollChannel
- Throws:
java.lang.Exception
-
connectedRead
private boolean connectedRead(EpollRecvByteAllocatorHandle allocHandle, ByteBuf byteBuf, int maxDatagramPacketSize) throws java.lang.Exception
- Throws:
java.lang.Exception
-
translateForConnected
private java.io.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 java.io.IOException
- Throws:
java.io.IOException
-
scatteringRead
private boolean scatteringRead(EpollRecvByteAllocatorHandle allocHandle, NativeDatagramPacketArray array, ByteBuf byteBuf, int datagramSize, int numDatagram) throws java.io.IOException
- Throws:
java.io.IOException
-
cleanDatagramPacketArray
private NativeDatagramPacketArray cleanDatagramPacketArray()
-
-