Package io.netty.channel.epoll

Class EpollDomainSocketChannel

java.lang.Object

io.netty.util.DefaultAttributeMap

io.netty.channel.AbstractChannel

io.netty.channel.epoll.AbstractEpollChannel

io.netty.channel.epoll.AbstractEpollStreamChannel

io.netty.channel.epoll.EpollDomainSocketChannel

All Implemented Interfaces:

Channel, ChannelOutboundInvoker, DuplexChannel, DomainSocketChannel, UnixChannel, AttributeMap, java.lang.Comparable<Channel>

public final class EpollDomainSocketChannel
extends AbstractEpollStreamChannel
implements DomainSocketChannel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	EpollDomainSocketChannel.EpollDomainUnsafe

Nested classes/interfaces inherited from class io.netty.channel.epoll.AbstractEpollStreamChannel

AbstractEpollStreamChannel.EpollStreamUnsafe, AbstractEpollStreamChannel.SpliceInTask

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 EpollDomainSocketChannelConfig	config
private DomainSocketAddress	local
private DomainSocketAddress	remote

Fields inherited from class io.netty.channel.epoll.AbstractEpollChannel

active, epollInReadyRunnablePending, flags, inputClosedSeenErrorOnRead, socket

Constructor Summary

Constructors

Constructor	Description
EpollDomainSocketChannel()
EpollDomainSocketChannel(int fd)
EpollDomainSocketChannel(int fd, boolean active)
EpollDomainSocketChannel(Channel parent, LinuxSocket fd)
EpollDomainSocketChannel(Channel parent, FileDescriptor fd)

Method Summary

Modifier and Type	Method	Description
EpollDomainSocketChannelConfig	config()	Returns the configuration of this channel.
protected void	doBind(java.net.SocketAddress localAddress)	Bind the Channel to the SocketAddress
protected boolean	doConnect(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress)	Connect to the remote peer
protected int	doWriteSingle(ChannelOutboundBuffer in)	Attempt to write a single object.
protected java.lang.Object	filterOutboundMessage(java.lang.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.
DomainSocketAddress	localAddress()	Returns the local address where this channel is bound to.
protected DomainSocketAddress	localAddress0()	Returns the SocketAddress which is bound locally.
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 io.netty.channel.epoll.AbstractEpollStreamChannel

doClose, doShutdownOutput, doWrite, isInputShutdown, isOutputShutdown, isShutdown, metadata, shutdown, shutdown, shutdownInput, shutdownInput, shutdownOutput, shutdownOutput, spliceTo, spliceTo, spliceTo, spliceTo

Methods inherited from class io.netty.channel.epoll.AbstractEpollChannel

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

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface io.netty.channel.socket.DuplexChannel

isInputShutdown, isOutputShutdown, isShutdown, shutdown, shutdown, shutdownInput, shutdownInput, shutdownOutput, shutdownOutput

Methods inherited from interface io.netty.channel.unix.UnixChannel

fd

Field Detail

config

private final EpollDomainSocketChannelConfig config

local

private volatile DomainSocketAddress local

remote

private volatile DomainSocketAddress remote

Constructor Detail

EpollDomainSocketChannel

public EpollDomainSocketChannel()

EpollDomainSocketChannel

EpollDomainSocketChannel(Channel parent,
                         FileDescriptor fd)

EpollDomainSocketChannel

public EpollDomainSocketChannel(int fd)

EpollDomainSocketChannel

public EpollDomainSocketChannel(Channel parent,
                                LinuxSocket fd)

EpollDomainSocketChannel

public EpollDomainSocketChannel(int fd,
                                boolean active)

Method Detail

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

Overrides:

newUnsafe in class AbstractEpollStreamChannel

localAddress0

protected DomainSocketAddress localAddress0()

Description copied from class: AbstractChannel

Returns the SocketAddress which is bound locally.

Overrides:

localAddress0 in class AbstractEpollChannel

remoteAddress0

protected DomainSocketAddress remoteAddress0()

Description copied from class: AbstractChannel

Return the SocketAddress which the Channel is connected to.

Overrides:

remoteAddress0 in class AbstractEpollChannel

doBind

protected void doBind(java.net.SocketAddress localAddress)
               throws java.lang.Exception

Description copied from class: AbstractChannel

Bind the Channel to the SocketAddress

Overrides:

doBind in class AbstractEpollChannel

Throws:

java.lang.Exception

config

public EpollDomainSocketChannelConfig config()

Description copied from interface: Channel

Returns the configuration of this channel.

Specified by:

config in interface Channel

Specified by:

config in interface DomainSocketChannel

Specified by:

config in class AbstractEpollChannel

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 class AbstractEpollChannel

Throws:

java.lang.Exception

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 DomainSocketChannel

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 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 DomainSocketChannel

Overrides:

localAddress in class AbstractChannel

Returns:

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

doWriteSingle

protected int doWriteSingle(ChannelOutboundBuffer in)
                     throws java.lang.Exception

Description copied from class: AbstractEpollStreamChannel

Attempt to write a single object.

Overrides:

doWriteSingle in class AbstractEpollStreamChannel

Parameters:

in - the collection which contains objects to write.

Returns:

The value that should be decremented from the write quantum which starts at ChannelConfig.getWriteSpinCount(). The typical use cases are as follows:

• 0 - if no write was attempted. This is appropriate if an empty ByteBuf (or other empty content) is encountered
• 1 - if a single call to write data was made to the OS
• ChannelUtils.WRITE_STATUS_SNDBUF_FULL - if an attempt to write data was made to the OS, but no data was accepted

Throws:

java.lang.Exception - If an I/O error occurs.

filterOutboundMessage

protected java.lang.Object filterOutboundMessage(java.lang.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 AbstractEpollStreamChannel

peerCredentials

public PeerCredentials peerCredentials()
                                throws java.io.IOException

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

Throws:

java.io.IOException