Class EpollDomainSocketChannel

io.netty.channel.epoll.EpollDomainSocketChannel

All Implemented Interfaces:: Channel, ChannelOutboundInvoker, DuplexChannel, DomainSocketChannel, UnixChannel, AttributeMap, Comparable<Channel>

public final class EpollDomainSocketChannel extends AbstractEpollStreamChannel implements DomainSocketChannel

Nested Class Summary

Nested classes/interfaces inherited from class AbstractEpollStreamChannel
AbstractEpollStreamChannel.SpliceInTask

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

protected final LinuxSocket

socket
Constructor Summary

Constructors

Constructor

Description

EpollDomainSocketChannel()

EpollDomainSocketChannel (int fd)

EpollDomainSocketChannel (int fd, boolean active)

EpollDomainSocketChannel (Channel parent, LinuxSocket fd)
Method Summary

Modifier and Type

Method

Description

protected static void

checkResolvable (InetSocketAddress addr)

EpollDomainSocketChannelConfig

config()

Returns the configuration of this channel.

protected void

doBeginRead()

Schedule a read operation.

protected void

doBind (SocketAddress localAddress)

Bind the Channel to the SocketAddress

protected boolean

doConnect (SocketAddress remoteAddress, SocketAddress localAddress)

Connect to the remote peer

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 final int

doWriteBytes (ChannelOutboundBuffer in, ByteBuf buf)

protected int

doWriteSingle (ChannelOutboundBuffer in)

Attempt to write a single object.

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

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.

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.epoll.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

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.

protected void

setFlag (int flag)

Methods inherited from class AbstractEpollStreamChannel
doClose, doShutdownOutput, doWrite, isInputShutdown, isOutputShutdown, isShutdown, metadata, shutdown, shutdown, shutdownInput, shutdownInput, shutdownOutput, shutdownOutput, spliceTo, spliceTo, spliceTo, spliceTo

Methods inherited from class AbstractChannel
closeFuture, compareTo, doRegister, 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, isActive, 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 DuplexChannel
isInputShutdown, isOutputShutdown, isShutdown, shutdown, shutdown, shutdownInput, shutdownInput, shutdownOutput, shutdownOutput

Methods inherited from interface UnixChannel
fd

Field Details
- socket
  
  protected final LinuxSocket socket
- active
  
  protected volatile boolean active
Constructor Details
- EpollDomainSocketChannel
  
  public EpollDomainSocketChannel()
- EpollDomainSocketChannel
  
  public EpollDomainSocketChannel(int fd)
- EpollDomainSocketChannel
  
  public EpollDomainSocketChannel(Channel parent, LinuxSocket fd)
- EpollDomainSocketChannel
  
  public EpollDomainSocketChannel(int fd, boolean active)
Method Details
- newUnsafe
  
  protected io.netty.channel.epoll.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.
- remoteAddress0
  
  protected DomainSocketAddress remoteAddress0()
  
  Description copied from class: AbstractChannel
  
  Return the SocketAddress which the Channel is connected to.
- doBind
  
  protected void doBind(SocketAddress localAddress) throws Exception
  
  Description copied from class: AbstractChannel
  
  Bind the Channel to the SocketAddress
  
  Throws:
  
  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
- doConnect
  
  protected boolean doConnect(SocketAddress remoteAddress, SocketAddress localAddress) throws Exception
  
  Connect to the remote peer
  
  Throws:
  
  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 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:
  
  Exception - If an I/O error occurs.
- 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 AbstractEpollStreamChannel
- peerCredentials
  
  public PeerCredentials peerCredentials() throws IOException
  
  Returns the unix credentials (uid, gid, pid) of the peer SO_PEERCRED
  
  Throws:
  
  IOException
- setFlag
  
  protected void setFlag(int flag) throws IOException
  
  Throws:
  
  IOException
- 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
- 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
- doDisconnect
  
  protected void doDisconnect() throws Exception
  
  Description copied from class: AbstractChannel
  
  Disconnect this Channel from its remote peer
  
  Specified by:
  
  doDisconnect in class AbstractChannel
  
  Throws:
  
  Exception
- 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
- 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
- doBeginRead
  
  protected 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

Class EpollDomainSocketChannel

Nested Class Summary

Nested classes/interfaces inherited from class AbstractEpollStreamChannel

Nested classes/interfaces inherited from class AbstractChannel

Nested classes/interfaces inherited from interface Channel

Field Summary

Constructor Summary

Method Summary

Methods inherited from class AbstractEpollStreamChannel

Methods inherited from class AbstractChannel

Methods inherited from class DefaultAttributeMap

Methods inherited from class Object

Methods inherited from interface AttributeMap

Methods inherited from interface Channel

Methods inherited from interface Comparable

Methods inherited from interface DuplexChannel

Methods inherited from interface UnixChannel

Field Details

socket

active

Constructor Details

EpollDomainSocketChannel

EpollDomainSocketChannel

EpollDomainSocketChannel

EpollDomainSocketChannel

Method Details

newUnsafe

localAddress0

remoteAddress0

doBind

config

doConnect

remoteAddress

localAddress

doWriteSingle

filterOutboundMessage

peerCredentials

setFlag

registration

fd

isActive

doDisconnect

isOpen

doDeregister

isCompatible

doBeginRead

doRegister

newDirectBuffer

newDirectBuffer

checkResolvable

doReadBytes

doWriteBytes