Class AbstractEpollStreamChannel

io.netty.channel.epoll.AbstractEpollStreamChannel

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

Direct Known Subclasses:: EpollDomainSocketChannel, EpollSocketChannel

public abstract class AbstractEpollStreamChannel extends AbstractChannel implements DuplexChannel

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

protected class

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

Modifier

Constructor

Description

protected

AbstractEpollStreamChannel (int fd)

protected

AbstractEpollStreamChannel (Channel parent, int fd)

protected

AbstractEpollStreamChannel (Channel parent, LinuxSocket fd, SocketAddress remote)

protected

AbstractEpollStreamChannel (LinuxSocket fd, boolean active)
Method Summary

Modifier and Type

Method

Description

protected static void

checkResolvable (InetSocketAddress addr)

abstract EpollChannelConfig

config()

Returns the configuration of this channel.

protected void

doBeginRead()

Schedule a read operation.

protected void

doBind (SocketAddress local)

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

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 void

doShutdownOutput()

Called when conditions justify shutting down the output portion of the channel.

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

isInputShutdown()

Returns true if and only if the remote peer shut down its output so that no more data is received from this channel.

boolean

isOpen()

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

boolean

isOutputShutdown()

boolean

isShutdown()

Determine if both the input and output of this channel have been shutdown.

protected SocketAddress

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

newUnsafe()

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

protected final IoRegistration

registration()

protected SocketAddress

remoteAddress0()

Return the SocketAddress which the Channel is connected to.

protected void

setFlag (int flag)

ChannelFuture

shutdown()

Will shutdown the input and output sides of this channel.

ChannelFuture

shutdown (ChannelPromise promise)

Will shutdown the input and output sides of this channel.

ChannelFuture

shutdownInput()

ChannelFuture

shutdownInput (ChannelPromise promise)

Will shutdown the input and notify ChannelPromise.

ChannelFuture

shutdownOutput()

ChannelFuture

shutdownOutput (ChannelPromise promise)

Will shutdown the output and notify ChannelPromise.

final ChannelFuture

spliceTo (AbstractEpollStreamChannel ch, int len)

Deprecated.
Will be removed in the future.

final ChannelFuture

spliceTo (AbstractEpollStreamChannel ch, int len, ChannelPromise promise)

Deprecated.
will be removed in the future.

final ChannelFuture

spliceTo (FileDescriptor ch, int offset, int len)

Deprecated.
Will be removed in the future.

final ChannelFuture

spliceTo (FileDescriptor ch, int offset, int len, ChannelPromise promise)

Deprecated.
Will be removed in the future.

Methods inherited from class AbstractChannel
closeFuture, compareTo, doRegister, equals, eventLoop, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, localAddress, maxMessagesPerWrite, newChannelPipeline, newId, parent, pipeline, remoteAddress, 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, config, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, eventLoop, flush, getOption, id, isActive, isOpen, isRegistered, isWritable, localAddress, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, remoteAddress, setOption, unsafe, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from interface Comparable
compareTo

Field Details
- socket
  
  protected final LinuxSocket socket
- active
  
  protected volatile boolean active
Constructor Details
- AbstractEpollStreamChannel
  
  protected AbstractEpollStreamChannel(Channel parent, int fd)
- AbstractEpollStreamChannel
  
  protected AbstractEpollStreamChannel(int fd)
- AbstractEpollStreamChannel
  
  protected AbstractEpollStreamChannel(Channel parent, LinuxSocket fd, SocketAddress remote)
- AbstractEpollStreamChannel
  
  protected AbstractEpollStreamChannel(LinuxSocket 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
- 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
- spliceTo
  @Deprecated public final ChannelFuture spliceTo(AbstractEpollStreamChannel ch, int len)
  
  Deprecated.
  Will be removed in the future.
  
  Splice from this AbstractEpollStreamChannel to another AbstractEpollStreamChannel. The len is the number of bytes to splice. If using Integer.MAX_VALUE it will splice until the ChannelFuture was canceled or it was failed. Please note:
  
  both channels need to be registered to the same EventLoop, otherwise an IllegalArgumentException is thrown.
  
  EpollChannelConfig.getEpollMode() must be EpollMode.LEVEL_TRIGGERED for this and the target AbstractEpollStreamChannel
- spliceTo
  @Deprecated public final ChannelFuture spliceTo(AbstractEpollStreamChannel ch, int len, ChannelPromise promise)
  
  Deprecated.
  will be removed in the future.
  
  Splice from this AbstractEpollStreamChannel to another AbstractEpollStreamChannel. The len is the number of bytes to splice. If using Integer.MAX_VALUE it will splice until the ChannelFuture was canceled or it was failed. Please note:
  
  both channels need to be registered to the same EventLoop, otherwise an IllegalArgumentException is thrown.
  
  EpollChannelConfig.getEpollMode() must be EpollMode.LEVEL_TRIGGERED for this and the target AbstractEpollStreamChannel
- spliceTo
  @Deprecated public final ChannelFuture spliceTo(FileDescriptor ch, int offset, int len)
  
  Deprecated.
  Will be removed in the future.
  
  Splice from this AbstractEpollStreamChannel to another FileDescriptor. The offset is the offset for the FileDescriptor and len is the number of bytes to splice. If using Integer.MAX_VALUE it will splice until the ChannelFuture was canceled or it was failed. Please note:
  
  EpollChannelConfig.getEpollMode() must be EpollMode.LEVEL_TRIGGERED for this AbstractEpollStreamChannel
  
  the FileDescriptor will not be closed after the ChannelFuture is notified
  
  this channel must be registered to an event loop or IllegalStateException will be thrown.
- spliceTo
  @Deprecated public final ChannelFuture spliceTo(FileDescriptor ch, int offset, int len, ChannelPromise promise)
  
  Deprecated.
  Will be removed in the future.
  
  Splice from this AbstractEpollStreamChannel to another FileDescriptor. The offset is the offset for the FileDescriptor and len is the number of bytes to splice. If using Integer.MAX_VALUE it will splice until the ChannelFuture was canceled or it was failed. Please note:
  
  EpollChannelConfig.getEpollMode() must be EpollMode.LEVEL_TRIGGERED for this AbstractEpollStreamChannel
  
  the FileDescriptor will not be closed after the ChannelPromise is notified
  
  this channel must be registered to an event loop or IllegalStateException will be thrown.
- 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
- doWriteSingle
  protected int doWriteSingle(ChannelOutboundBuffer in) throws Exception
  
  Attempt to write a single object.
  
  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 AbstractChannel
- doShutdownOutput
  
  protected final void doShutdownOutput() throws Exception
  
  Description copied from class: AbstractChannel
  
  Called when conditions justify shutting down the output portion of the channel. This may happen if a write operation throws an exception.
  
  Overrides:
  
  doShutdownOutput in class AbstractChannel
  
  Throws:
  
  Exception
- isOutputShutdown
  public boolean isOutputShutdown()
  
  Specified by:
  
  isOutputShutdown in interface DuplexChannel
  
  See Also:
  
  Socket.isOutputShutdown()
- isInputShutdown
  
  public boolean isInputShutdown()
  
  Description copied from interface: DuplexChannel
  
  Returns true if and only if the remote peer shut down its output so that no more data is received from this channel. Note that the semantic of this method is different from that of Socket.shutdownInput() and Socket.isInputShutdown().
  
  Specified by:
  
  isInputShutdown in interface DuplexChannel
- isShutdown
  
  public boolean isShutdown()
  
  Description copied from interface: DuplexChannel
  
  Determine if both the input and output of this channel have been shutdown.
  
  Specified by:
  
  isShutdown in interface DuplexChannel
- shutdownOutput
  public ChannelFuture shutdownOutput()
  
  Specified by:
  
  shutdownOutput in interface DuplexChannel
  
  See Also:
  
  Socket.shutdownOutput()
- shutdownOutput
  public ChannelFuture shutdownOutput(ChannelPromise promise)
  
  Description copied from interface: DuplexChannel
  
  Will shutdown the output and notify ChannelPromise.
  
  Specified by:
  
  shutdownOutput in interface DuplexChannel
  
  See Also:
  
  Socket.shutdownOutput()
- shutdownInput
  public ChannelFuture shutdownInput()
  
  Specified by:
  
  shutdownInput in interface DuplexChannel
  
  See Also:
  
  Socket.shutdownInput()
- shutdownInput
  public ChannelFuture shutdownInput(ChannelPromise promise)
  
  Description copied from interface: DuplexChannel
  
  Will shutdown the input and notify ChannelPromise.
  
  Specified by:
  
  shutdownInput in interface DuplexChannel
  
  See Also:
  
  Socket.shutdownInput()
- shutdown
  
  public ChannelFuture shutdown()
  
  Description copied from interface: DuplexChannel
  
  Will shutdown the input and output sides of this channel.
  
  Specified by:
  
  shutdown in interface DuplexChannel
  
  Returns:
  
  will be completed when both shutdown operations complete.
- shutdown
  
  public ChannelFuture shutdown(ChannelPromise promise)
  
  Description copied from interface: DuplexChannel
  
  Will shutdown the input and output sides of this channel.
  
  Specified by:
  
  shutdown in interface DuplexChannel
  
  Parameters:
  
  promise - will be completed when both shutdown operations complete.
  
  Returns:
  
  will be completed when both shutdown operations complete.
- doClose
  
  protected void doClose() throws Exception
  
  Description copied from class: AbstractChannel
  
  Close the Channel
  
  Throws:
  
  Exception
- 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
- config
  
  public abstract EpollChannelConfig config()
  
  Description copied from interface: Channel
  
  Returns the configuration of this channel.
  
  Specified by:
  
  config in interface Channel
- 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
- doBind
  
  protected void doBind(SocketAddress local) throws Exception
  
  Description copied from class: AbstractChannel
  
  Bind the Channel to the SocketAddress
  
  Specified by:
  
  doBind in class AbstractChannel
  
  Throws:
  
  Exception
- doConnect
  
  protected boolean doConnect(SocketAddress remoteAddress, SocketAddress localAddress) throws Exception
  
  Connect to the remote peer
  
  Throws:
  
  Exception
- localAddress0
  
  protected SocketAddress localAddress0()
  
  Description copied from class: AbstractChannel
  
  Returns the SocketAddress which is bound locally.
  
  Specified by:
  
  localAddress0 in class AbstractChannel
- remoteAddress0
  
  protected SocketAddress remoteAddress0()
  
  Description copied from class: AbstractChannel
  
  Return the SocketAddress which the Channel is connected to.
  
  Specified by:
  
  remoteAddress0 in class AbstractChannel

Class AbstractEpollStreamChannel

Nested Class Summary

Nested classes/interfaces inherited from class AbstractChannel

Nested classes/interfaces inherited from interface Channel

Field Summary

Constructor Summary

Method Summary

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

Field Details

socket

active

Constructor Details

AbstractEpollStreamChannel

AbstractEpollStreamChannel

AbstractEpollStreamChannel

AbstractEpollStreamChannel

Method Details

newUnsafe

metadata

spliceTo

spliceTo

spliceTo

spliceTo

doWrite

doWriteSingle

filterOutboundMessage

doShutdownOutput

isOutputShutdown

isInputShutdown

isShutdown

shutdownOutput

shutdownOutput

shutdownInput

shutdownInput

shutdown

shutdown

doClose

setFlag

registration

fd

config

isActive

doDisconnect

isOpen

doDeregister

isCompatible

doBeginRead

doRegister

newDirectBuffer

newDirectBuffer

checkResolvable

doReadBytes

doWriteBytes

doBind

doConnect

localAddress0

remoteAddress0