Class EpollDomainDatagramChannel

java.lang.Object

io.netty.util.DefaultAttributeMap

io.netty.channel.AbstractChannel

io.netty.channel.epoll.AbstractEpollChannel

io.netty.channel.epoll.EpollDomainDatagramChannel

All Implemented Interfaces:

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

public final class EpollDomainDatagramChannel
extends AbstractEpollChannel
implements DomainDatagramChannel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) final class	EpollDomainDatagramChannel.EpollDomainDatagramChannelUnsafe

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 EpollDomainDatagramChannelConfig	config
private boolean	connected
private static final String	EXPECTED_TYPES
private DomainSocketAddress	local
private static final ChannelMetadata	METADATA
private DomainSocketAddress	remote

Fields inherited from class AbstractEpollChannel

active, epollInReadyRunnablePending, flags, inputClosedSeenErrorOnRead, socket

Constructor Summary

Constructors

Modifier	Constructor	Description
	EpollDomainDatagramChannel()
	EpollDomainDatagramChannel(int fd)
private	EpollDomainDatagramChannel(LinuxSocket socket, boolean active)

Method Summary

Modifier and Type	Method	Description
EpollDomainDatagramChannelConfig	config()	Returns the configuration of this channel.
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 DomainDatagramChannel is connected to the remote peer.
DomainSocketAddress	localAddress()	Returns the local address where this channel is bound to.
protected DomainSocketAddress	localAddress0()	Returns the SocketAddress which is bound locally.
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
PeerCredentials	peerCredentials()	Returns the unix credentials (uid, gid, pid) of the peer SO_PEERCRED
DomainSocketAddress	remoteAddress()	Returns the remote address where this channel is connected to.
protected DomainSocketAddress	remoteAddress0()	Return the SocketAddress which the Channel is connected to.

Methods inherited from class AbstractEpollChannel

checkResolvable, clearEpollIn, clearFlag, doBeginRead, doConnect0, doDeregister, doReadBytes, doRegister, doWriteBytes, doWriteOrSendBytes, fd, isCompatible, isFlagSet, isOpen, isSoErrorZero, newDirectBuffer, newDirectBuffer, 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

Methods inherited from interface UnixChannel

fd

Field Details

METADATA

private static final ChannelMetadata METADATA

EXPECTED_TYPES

private static final String EXPECTED_TYPES

connected

private volatile boolean connected

local

private volatile DomainSocketAddress local

remote

private volatile DomainSocketAddress remote

config

private final EpollDomainDatagramChannelConfig config

Constructor Details

EpollDomainDatagramChannel

public EpollDomainDatagramChannel()

EpollDomainDatagramChannel

public EpollDomainDatagramChannel(int fd)

EpollDomainDatagramChannel

private EpollDomainDatagramChannel(LinuxSocket socket,
 boolean active)

Method Details

config

public EpollDomainDatagramChannelConfig config()

Description copied from interface: Channel

Returns the configuration of this channel.

Specified by:

config in interface Channel

Specified by:

config in interface DomainDatagramChannel

Specified by:

config 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

doClose

protected void doClose()
                throws Exception

Description copied from class: AbstractChannel

Close the Channel

Overrides:

doClose 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

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

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

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

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: DomainDatagramChannel

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

Specified by:

isConnected in interface DomainDatagramChannel

localAddress

public DomainSocketAddress 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 DomainDatagramChannel

Overrides:

localAddress in class AbstractChannel

Returns:

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

localAddress0

protected DomainSocketAddress localAddress0()

Description copied from class: AbstractChannel

Returns the SocketAddress which is bound locally.

Overrides:

localAddress0 in class AbstractEpollChannel

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

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

peerCredentials

public PeerCredentials peerCredentials()
                                throws IOException

Returns the unix credentials (uid, gid, pid) of the peer SO_PEERCRED

Throws:

IOException

remoteAddress

public DomainSocketAddress 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 DomainDatagramChannel

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.

remoteAddress0

protected DomainSocketAddress remoteAddress0()

Description copied from class: AbstractChannel

Return the SocketAddress which the Channel is connected to.

Overrides:

remoteAddress0 in class AbstractEpollChannel