Class KQueueDomainDatagramChannel

java.lang.Object

io.netty.util.DefaultAttributeMap

io.netty.channel.AbstractChannel

io.netty.channel.kqueue.KQueueDomainDatagramChannel

All Implemented Interfaces:

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

public final class KQueueDomainDatagramChannel
extends AbstractChannel
implements DomainDatagramChannel

Nested Class Summary

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
protected boolean	active

Constructor Summary

Constructors

Constructor	Description
KQueueDomainDatagramChannel()
KQueueDomainDatagramChannel(int fd)

Method Summary

Modifier and Type	Method	Description
protected static void	checkResolvable(InetSocketAddress addr)
KQueueDomainDatagramChannelConfig	config()	Returns the configuration of this channel.
protected final void	doBeginRead()	Schedule a read operation.
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 boolean	doConnect0(SocketAddress remoteAddress, SocketAddress localAddress)
protected void	doDeregister()	Deregister the Channel from its EventLoop.
protected void	doDisconnect()	Disconnect this Channel from its remote peer
protected final int	doReadBytes(ByteBuf byteBuf)	Read bytes into the given ByteBuf and return the amount.
protected void	doRegister(ChannelPromise promise)	Is called after the Channel is registered with its EventLoop as part of the register process.
protected void	doWrite(ChannelOutboundBuffer in)	Flush the content of the given buffer to the remote peer.
protected final int	doWriteBytes(ChannelOutboundBuffer in, ByteBuf buf)
protected boolean	doWriteMessage(Object msg)
final FileDescriptor	fd()	Returns the FileDescriptor that is used by this Channel.
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.
protected boolean	isCompatible(EventLoop loop)	Return true if the given EventLoop is compatible with this instance.
boolean	isConnected()	Return true if the DomainDatagramChannel is connected to the remote peer.
boolean	isOpen()	Returns true if the Channel is open and may get active later
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 final ByteBuf	newDirectBuffer(ByteBuf buf)	Returns an off-heap copy of the specified ByteBuf, and releases the original one.
protected final ByteBuf	newDirectBuffer(Object holder, ByteBuf buf)	Returns an off-heap copy of the specified ByteBuf, and releases the specified holder.
protected io.netty.channel.kqueue.AbstractKQueueChannel.AbstractKQueueUnsafe	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
protected final IoRegistration	registration()
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 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 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, bind, bind, bytesBeforeUnwritable, bytesBeforeWritable, close, close, closeFuture, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, eventLoop, flush, getOption, id, isOpen, isRegistered, isWritable, metadata, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, setOption, unsafe, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from interface Comparable

compareTo

Methods inherited from interface UnixChannel

fd

Field Details

active

protected volatile boolean active

Constructor Details

KQueueDomainDatagramChannel

public KQueueDomainDatagramChannel()

KQueueDomainDatagramChannel

public KQueueDomainDatagramChannel(int fd)

Method Details

config

public KQueueDomainDatagramChannelConfig config()

Description copied from interface: Channel

Returns the configuration of this channel.

Specified by:

config in interface Channel

Specified by:

config in interface DomainDatagramChannel

doBind

protected void doBind(SocketAddress localAddress)
               throws Exception

Description copied from class: AbstractChannel

Bind the Channel to the SocketAddress

Throws:

Exception

doClose

protected void doClose()
                throws Exception

Description copied from class: AbstractChannel

Close the Channel

Throws:

Exception

doConnect

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

Connect to the remote peer

Throws:

Exception

doDisconnect

protected void doDisconnect()
                     throws Exception

Description copied from class: AbstractChannel

Disconnect this Channel from its remote peer

Throws:

Exception

doWriteMessage

protected 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

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.

newUnsafe

protected io.netty.channel.kqueue.AbstractKQueueChannel.AbstractKQueueUnsafe newUnsafe()

Description copied from class: AbstractChannel

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

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.

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

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

isCompatible

protected boolean isCompatible(EventLoop loop)

Description copied from class: AbstractChannel

Return true if the given EventLoop is compatible with this instance.

Specified by:

isCompatible in class AbstractChannel

registration

protected final IoRegistration registration()

fd

public final FileDescriptor fd()

Description copied from interface: UnixChannel

Returns the FileDescriptor that is used by this Channel.

Specified by:

fd in interface UnixChannel

isOpen

public boolean isOpen()

Description copied from interface: Channel

Returns true if the Channel is open and may get active later

Specified by:

isOpen in interface Channel

doDeregister

protected void doDeregister()
                     throws Exception

Description copied from class: AbstractChannel

Deregister the Channel from its EventLoop. Sub-classes may override this method

Overrides:

doDeregister in class AbstractChannel

Throws:

Exception

doBeginRead

protected final void doBeginRead()
                          throws Exception

Description copied from class: AbstractChannel

Schedule a read operation.

Specified by:

doBeginRead in class AbstractChannel

Throws:

Exception

doRegister

protected void doRegister(ChannelPromise promise)

Description copied from class: AbstractChannel

Is called after the Channel is registered with its EventLoop as part of the register process. Subclasses may override this method

Overrides:

doRegister in class AbstractChannel

Parameters:

promise - ChannelPromise that must be notified once done to continue the registration.

newDirectBuffer

protected final ByteBuf newDirectBuffer(ByteBuf buf)

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

newDirectBuffer

protected final ByteBuf newDirectBuffer(Object holder,
 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(ByteBuf byteBuf)
                         throws Exception

Read bytes into the given ByteBuf and return the amount.

Throws:

Exception

doWriteBytes

protected final int doWriteBytes(ChannelOutboundBuffer in,
 ByteBuf buf)
                          throws Exception

Throws:

Exception

doConnect0

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

Throws:

Exception