Package io.netty.channel.epoll

Class EpollDatagramChannel

java.lang.Object

io.netty.util.DefaultAttributeMap

io.netty.channel.AbstractChannel

io.netty.channel.epoll.EpollDatagramChannel

All Implemented Interfaces:

io.netty.channel.Channel, io.netty.channel.ChannelOutboundInvoker, io.netty.channel.socket.DatagramChannel, io.netty.channel.unix.UnixChannel, io.netty.util.AttributeMap, Comparable<io.netty.channel.Channel>

public final class EpollDatagramChannel
extends io.netty.channel.AbstractChannel
implements io.netty.channel.socket.DatagramChannel

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

Nested Class Summary

Nested classes/interfaces inherited from class io.netty.channel.AbstractChannel

io.netty.channel.AbstractChannel.AbstractUnsafe

Nested classes/interfaces inherited from interface io.netty.channel.Channel

io.netty.channel.Channel.Unsafe

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	active
protected LinuxSocket	socket

Constructor Summary

Constructors

Constructor	Description
EpollDatagramChannel()	Create a new instance which selects the SocketProtocolFamily to use depending on the Operation Systems default which will be chosen.
EpollDatagramChannel(int fd)	Create a new instance which selects the SocketProtocolFamily to use depending on the Operation Systems default which will be chosen.
EpollDatagramChannel(io.netty.channel.socket.InternetProtocolFamily family)	Deprecated. use EpollDatagramChannel(SocketProtocolFamily)
EpollDatagramChannel(io.netty.channel.socket.SocketProtocolFamily family)	Create a new instance using the given SocketProtocolFamily.

Method Summary

Modifier and Type	Method	Description
io.netty.channel.ChannelFuture	block(InetAddress multicastAddress, InetAddress sourceToBlock)
io.netty.channel.ChannelFuture	block(InetAddress multicastAddress, InetAddress sourceToBlock, io.netty.channel.ChannelPromise promise)
io.netty.channel.ChannelFuture	block(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress sourceToBlock)
io.netty.channel.ChannelFuture	block(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress sourceToBlock, io.netty.channel.ChannelPromise promise)
protected static void	checkResolvable(InetSocketAddress addr)
EpollDatagramChannelConfig	config()
protected void	doBeginRead()
protected void	doBind(SocketAddress localAddress)
protected void	doClose()
protected boolean	doConnect(SocketAddress remoteAddress, SocketAddress localAddress)	Connect to the remote peer
protected void	doDeregister()
protected void	doDisconnect()
protected int	doReadBytes(io.netty.buffer.ByteBuf byteBuf)	Read bytes into the given ByteBuf and return the amount.
protected void	doRegister(io.netty.channel.ChannelPromise promise)
protected void	doWrite(io.netty.channel.ChannelOutboundBuffer in)
protected int	doWriteBytes(io.netty.channel.ChannelOutboundBuffer in, io.netty.buffer.ByteBuf buf)
io.netty.channel.unix.FileDescriptor	fd()
protected Object	filterOutboundMessage(Object msg)
boolean	isActive()
protected boolean	isCompatible(io.netty.channel.EventLoop loop)
boolean	isConnected()
boolean	isOpen()
static boolean	isSegmentedDatagramPacketSupported()	Returns true if SegmentedDatagramPacket is supported natively.
io.netty.channel.ChannelFuture	joinGroup(InetAddress multicastAddress)
io.netty.channel.ChannelFuture	joinGroup(InetAddress multicastAddress, io.netty.channel.ChannelPromise promise)
io.netty.channel.ChannelFuture	joinGroup(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source)
io.netty.channel.ChannelFuture	joinGroup(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source, io.netty.channel.ChannelPromise promise)
io.netty.channel.ChannelFuture	joinGroup(InetSocketAddress multicastAddress, NetworkInterface networkInterface)
io.netty.channel.ChannelFuture	joinGroup(InetSocketAddress multicastAddress, NetworkInterface networkInterface, io.netty.channel.ChannelPromise promise)
io.netty.channel.ChannelFuture	leaveGroup(InetAddress multicastAddress)
io.netty.channel.ChannelFuture	leaveGroup(InetAddress multicastAddress, io.netty.channel.ChannelPromise promise)
io.netty.channel.ChannelFuture	leaveGroup(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source)
io.netty.channel.ChannelFuture	leaveGroup(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source, io.netty.channel.ChannelPromise promise)
io.netty.channel.ChannelFuture	leaveGroup(InetSocketAddress multicastAddress, NetworkInterface networkInterface)
io.netty.channel.ChannelFuture	leaveGroup(InetSocketAddress multicastAddress, NetworkInterface networkInterface, io.netty.channel.ChannelPromise promise)
InetSocketAddress	localAddress()
protected SocketAddress	localAddress0()
io.netty.channel.ChannelMetadata	metadata()
protected io.netty.buffer.ByteBuf	newDirectBuffer(io.netty.buffer.ByteBuf buf)	Returns an off-heap copy of the specified ByteBuf, and releases the original one.
protected io.netty.buffer.ByteBuf	newDirectBuffer(Object holder, io.netty.buffer.ByteBuf buf)	Returns an off-heap copy of the specified ByteBuf, and releases the specified holder.
protected io.netty.channel.epoll.AbstractEpollChannel.AbstractEpollUnsafe	newUnsafe()
protected io.netty.channel.IoRegistration	registration()
InetSocketAddress	remoteAddress()
protected SocketAddress	remoteAddress0()
protected void	setFlag(int flag)

Methods inherited from class io.netty.channel.AbstractChannel

closeFuture, compareTo, doRegister, doShutdownOutput, equals, eventLoop, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, maxMessagesPerWrite, newChannelPipeline, newId, parent, pipeline, toString, unsafe, validateFileRegion, voidPromise

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, bind, bind, bytesBeforeUnwritable, bytesBeforeWritable, close, close, closeFuture, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, eventLoop, flush, getOption, id, isOpen, isRegistered, isWritable, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, setOption, unsafe, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

socket

protected final LinuxSocket socket

active

protected volatile boolean active

Constructor Detail

EpollDatagramChannel

public EpollDatagramChannel()

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

EpollDatagramChannel

@Deprecated
public EpollDatagramChannel(io.netty.channel.socket.InternetProtocolFamily family)

Deprecated.

use EpollDatagramChannel(SocketProtocolFamily)

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(io.netty.channel.socket.SocketProtocolFamily family)

Create a new instance using the given SocketProtocolFamily. 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 SocketProtocolFamily to use depending on the Operation Systems default which will be chosen.

Method Detail

isSegmentedDatagramPacketSupported

public static boolean isSegmentedDatagramPacketSupported()

Returns true if SegmentedDatagramPacket is supported natively.

Returns:

true if supported, false otherwise.

remoteAddress

public InetSocketAddress remoteAddress()

Specified by:

remoteAddress in interface io.netty.channel.Channel

Specified by:

remoteAddress in interface io.netty.channel.socket.DatagramChannel

Overrides:

remoteAddress in class io.netty.channel.AbstractChannel

localAddress

public InetSocketAddress localAddress()

Specified by:

localAddress in interface io.netty.channel.Channel

Specified by:

localAddress in interface io.netty.channel.socket.DatagramChannel

Overrides:

localAddress in class io.netty.channel.AbstractChannel

metadata

public io.netty.channel.ChannelMetadata metadata()

Specified by:

metadata in interface io.netty.channel.Channel

isActive

public boolean isActive()

Specified by:

isActive in interface io.netty.channel.Channel

isConnected

public boolean isConnected()

Specified by:

isConnected in interface io.netty.channel.socket.DatagramChannel

joinGroup

public io.netty.channel.ChannelFuture joinGroup(InetAddress multicastAddress)

Specified by:

joinGroup in interface io.netty.channel.socket.DatagramChannel

joinGroup

public io.netty.channel.ChannelFuture joinGroup(InetAddress multicastAddress,
                                                io.netty.channel.ChannelPromise promise)

Specified by:

joinGroup in interface io.netty.channel.socket.DatagramChannel

joinGroup

public io.netty.channel.ChannelFuture joinGroup(InetSocketAddress multicastAddress,
                                                NetworkInterface networkInterface)

Specified by:

joinGroup in interface io.netty.channel.socket.DatagramChannel

joinGroup

public io.netty.channel.ChannelFuture joinGroup(InetSocketAddress multicastAddress,
                                                NetworkInterface networkInterface,
                                                io.netty.channel.ChannelPromise promise)

Specified by:

joinGroup in interface io.netty.channel.socket.DatagramChannel

joinGroup

public io.netty.channel.ChannelFuture joinGroup(InetAddress multicastAddress,
                                                NetworkInterface networkInterface,
                                                InetAddress source)

Specified by:

joinGroup in interface io.netty.channel.socket.DatagramChannel

joinGroup

public io.netty.channel.ChannelFuture joinGroup(InetAddress multicastAddress,
                                                NetworkInterface networkInterface,
                                                InetAddress source,
                                                io.netty.channel.ChannelPromise promise)

Specified by:

joinGroup in interface io.netty.channel.socket.DatagramChannel

leaveGroup

public io.netty.channel.ChannelFuture leaveGroup(InetAddress multicastAddress)

Specified by:

leaveGroup in interface io.netty.channel.socket.DatagramChannel

leaveGroup

public io.netty.channel.ChannelFuture leaveGroup(InetAddress multicastAddress,
                                                 io.netty.channel.ChannelPromise promise)

Specified by:

leaveGroup in interface io.netty.channel.socket.DatagramChannel

leaveGroup

public io.netty.channel.ChannelFuture leaveGroup(InetSocketAddress multicastAddress,
                                                 NetworkInterface networkInterface)

Specified by:

leaveGroup in interface io.netty.channel.socket.DatagramChannel

leaveGroup

public io.netty.channel.ChannelFuture leaveGroup(InetSocketAddress multicastAddress,
                                                 NetworkInterface networkInterface,
                                                 io.netty.channel.ChannelPromise promise)

Specified by:

leaveGroup in interface io.netty.channel.socket.DatagramChannel

leaveGroup

public io.netty.channel.ChannelFuture leaveGroup(InetAddress multicastAddress,
                                                 NetworkInterface networkInterface,
                                                 InetAddress source)

Specified by:

leaveGroup in interface io.netty.channel.socket.DatagramChannel

leaveGroup

public io.netty.channel.ChannelFuture leaveGroup(InetAddress multicastAddress,
                                                 NetworkInterface networkInterface,
                                                 InetAddress source,
                                                 io.netty.channel.ChannelPromise promise)

Specified by:

leaveGroup in interface io.netty.channel.socket.DatagramChannel

block

public io.netty.channel.ChannelFuture block(InetAddress multicastAddress,
                                            NetworkInterface networkInterface,
                                            InetAddress sourceToBlock)

Specified by:

block in interface io.netty.channel.socket.DatagramChannel

block

public io.netty.channel.ChannelFuture block(InetAddress multicastAddress,
                                            NetworkInterface networkInterface,
                                            InetAddress sourceToBlock,
                                            io.netty.channel.ChannelPromise promise)

Specified by:

block in interface io.netty.channel.socket.DatagramChannel

block

public io.netty.channel.ChannelFuture block(InetAddress multicastAddress,
                                            InetAddress sourceToBlock)

Specified by:

block in interface io.netty.channel.socket.DatagramChannel

block

public io.netty.channel.ChannelFuture block(InetAddress multicastAddress,
                                            InetAddress sourceToBlock,
                                            io.netty.channel.ChannelPromise promise)

Specified by:

block in interface io.netty.channel.socket.DatagramChannel

newUnsafe

protected io.netty.channel.epoll.AbstractEpollChannel.AbstractEpollUnsafe newUnsafe()

doBind

protected void doBind(SocketAddress localAddress)
               throws Exception

Throws:

Exception

doWrite

protected void doWrite(io.netty.channel.ChannelOutboundBuffer in)
                throws Exception

Specified by:

doWrite in class io.netty.channel.AbstractChannel

Throws:

Exception

filterOutboundMessage

protected Object filterOutboundMessage(Object msg)

Overrides:

filterOutboundMessage in class io.netty.channel.AbstractChannel

config

public EpollDatagramChannelConfig config()

Specified by:

config in interface io.netty.channel.Channel

Specified by:

config in interface io.netty.channel.socket.DatagramChannel

doDisconnect

protected void doDisconnect()
                     throws Exception

Throws:

Exception

doConnect

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

Connect to the remote peer

Throws:

Exception

doClose

protected void doClose()
                throws Exception

Throws:

Exception

setFlag

protected void setFlag(int flag)
                throws IOException

Throws:

IOException

registration

protected final io.netty.channel.IoRegistration registration()

fd

public final io.netty.channel.unix.FileDescriptor fd()

Specified by:

fd in interface io.netty.channel.unix.UnixChannel

isOpen

public boolean isOpen()

Specified by:

isOpen in interface io.netty.channel.Channel

doDeregister

protected void doDeregister()
                     throws Exception

Overrides:

doDeregister in class io.netty.channel.AbstractChannel

Throws:

Exception

isCompatible

protected boolean isCompatible(io.netty.channel.EventLoop loop)

Specified by:

isCompatible in class io.netty.channel.AbstractChannel

doBeginRead

protected void doBeginRead()
                    throws Exception

Specified by:

doBeginRead in class io.netty.channel.AbstractChannel

Throws:

Exception

doRegister

protected void doRegister(io.netty.channel.ChannelPromise promise)

Overrides:

doRegister in class io.netty.channel.AbstractChannel

newDirectBuffer

protected final io.netty.buffer.ByteBuf newDirectBuffer(io.netty.buffer.ByteBuf buf)

Returns an off-heap copy of the specified ByteBuf, and releases the original one.

newDirectBuffer

protected final io.netty.buffer.ByteBuf newDirectBuffer(Object holder,
                                                        io.netty.buffer.ByteBuf buf)

Returns an off-heap copy of the specified ByteBuf, and releases the specified holder. The caller must ensure that the holder releases the original ByteBuf when the holder is released by this method.

checkResolvable

protected static void checkResolvable(InetSocketAddress addr)

doReadBytes

protected final int doReadBytes(io.netty.buffer.ByteBuf byteBuf)
                         throws Exception

Read bytes into the given ByteBuf and return the amount.

Throws:

Exception

doWriteBytes

protected final int doWriteBytes(io.netty.channel.ChannelOutboundBuffer in,
                                 io.netty.buffer.ByteBuf buf)
                          throws Exception

Throws:

Exception

localAddress0

protected SocketAddress localAddress0()

Specified by:

localAddress0 in class io.netty.channel.AbstractChannel

remoteAddress0

protected SocketAddress remoteAddress0()

Specified by:

remoteAddress0 in class io.netty.channel.AbstractChannel