Class AbstractNioChannel

io.netty.channel.nio.AbstractNioChannel

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

Direct Known Subclasses:: AbstractNioByteChannel, AbstractNioMessageChannel

public abstract class AbstractNioChannel extends AbstractChannel

Abstract base class for Channel implementations which use a Selector based approach.

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

protected class

AbstractNioChannel.AbstractNioUnsafe

static interface

AbstractNioChannel.NioUnsafe

Special Channel.Unsafe sub-type which allows to access the underlying SelectableChannel

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

readInterestOp

protected final NioIoOps

readOps
Constructor Summary

Constructors

Modifier

Constructor

Description

protected

AbstractNioChannel (Channel parent, SelectableChannel ch, int readOps)

Create a new instance

protected

AbstractNioChannel (Channel parent, SelectableChannel ch, NioIoOps readOps)
Method Summary

Modifier and Type

Method

Description

protected void

addAndSubmit (NioIoOps addOps)

protected final void

clearReadPending()

Set read pending to false.

protected void

doBeginRead()

Schedule a read operation.

protected void

doClose()

Close the Channel

protected abstract boolean

doConnect (SocketAddress remoteAddress, SocketAddress localAddress)

Connect to the remote peer

protected void

doDeregister()

Deregister the Channel from its EventLoop.

protected abstract void

doFinishConnect()

Finish the connect

protected void

doRegister (ChannelPromise promise)

Is called after the Channel is registered with its EventLoop as part of the register process.

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

protected boolean

isReadPending()

Deprecated.
No longer supported.

protected SelectableChannel

javaChannel()

protected final ByteBuf

newDirectBuffer (ByteBuf buf)

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

protected final ByteBuf

newDirectBuffer (ReferenceCounted holder, ByteBuf buf)

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

protected IoRegistration

registration()

protected void

removeAndSubmit (NioIoOps removeOps)

protected SelectionKey

selectionKey()

Deprecated.
use registration.

protected void

setReadPending (boolean readPending)

Deprecated.
Use clearReadPending() if appropriate instead.

AbstractNioChannel.NioUnsafe

unsafe()

Returns an internal-use-only object that provides unsafe operations.

Methods inherited from class AbstractChannel
closeFuture, compareTo, doBind, doDisconnect, doRegister, doShutdownOutput, doWrite, equals, eventLoop, filterOutboundMessage, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, localAddress, localAddress0, maxMessagesPerWrite, newChannelPipeline, newId, newUnsafe, parent, pipeline, remoteAddress, remoteAddress0, toString, 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, config, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, flush, getOption, isActive, isWritable, metadata, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, read, setOption, write, write, writeAndFlush, writeAndFlush

Field Details
- readInterestOp
  
  protected final int readInterestOp
- readOps
  
  protected final NioIoOps readOps
Constructor Details
- AbstractNioChannel
  
  protected AbstractNioChannel(Channel parent, SelectableChannel ch, int readOps)
  
  Create a new instance
  
  Parameters:
  
  parent - the parent Channel by which this instance was created. May be null
  
  ch - the underlying SelectableChannel on which it operates
  
  readOps - the ops to set to receive data from the SelectableChannel
- AbstractNioChannel
  
  protected AbstractNioChannel(Channel parent, SelectableChannel ch, NioIoOps readOps)
Method Details
- addAndSubmit
  
  protected void addAndSubmit(NioIoOps addOps)
- removeAndSubmit
  
  protected void removeAndSubmit(NioIoOps removeOps)
- isOpen
  
  public boolean isOpen()
  
  Description copied from interface: Channel
  
  Returns true if the Channel is open and may get active later
- unsafe
  
  public AbstractNioChannel.NioUnsafe unsafe()
  
  Description copied from interface: Channel
  
  Returns an internal-use-only object that provides unsafe operations.
  
  Specified by:
  
  unsafe in interface Channel
  
  Overrides:
  
  unsafe in class AbstractChannel
- javaChannel
  
  protected SelectableChannel javaChannel()
- selectionKey
  
  @Deprecated protected SelectionKey selectionKey()
  
  Deprecated.
  use registration.
  
  Return the current SelectionKey
- registration
  
  protected IoRegistration registration()
- isReadPending
  
  @Deprecated protected boolean isReadPending()
  
  Deprecated.
  No longer supported. No longer supported.
- setReadPending
  
  @Deprecated protected void setReadPending(boolean readPending)
  
  Deprecated.
  Use clearReadPending() if appropriate instead. No longer supported.
- clearReadPending
  
  protected final void clearReadPending()
  
  Set read pending to false.
- 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
- 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.
- 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 void doBeginRead() throws Exception
  
  Description copied from class: AbstractChannel
  
  Schedule a read operation.
  
  Specified by:
  
  doBeginRead in class AbstractChannel
  
  Throws:
  
  Exception
- doConnect
  
  protected abstract boolean doConnect(SocketAddress remoteAddress, SocketAddress localAddress) throws Exception
  
  Connect to the remote peer
  
  Throws:
  
  Exception
- doFinishConnect
  
  protected abstract void doFinishConnect() throws Exception
  
  Finish the connect
  
  Throws:
  
  Exception
- newDirectBuffer
  
  protected final ByteBuf newDirectBuffer(ByteBuf buf)
  
  Returns an off-heap copy of the specified ByteBuf, and releases the original one. Note that this method does not create an off-heap copy if the allocation / deallocation cost is too high, but just returns the original ByteBuf..
- newDirectBuffer
  
  protected final ByteBuf newDirectBuffer(ReferenceCounted 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. Note that this method does not create an off-heap copy if the allocation / deallocation cost is too high, but just returns the original ByteBuf..
- doClose
  
  protected void doClose() throws Exception
  
  Description copied from class: AbstractChannel
  
  Close the Channel
  
  Specified by:
  
  doClose in class AbstractChannel
  
  Throws:
  
  Exception

Class AbstractNioChannel

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

Field Details

readInterestOp

readOps

Constructor Details

AbstractNioChannel

AbstractNioChannel

Method Details

addAndSubmit

removeAndSubmit

isOpen

unsafe

javaChannel

selectionKey

registration

isReadPending

setReadPending

clearReadPending

isCompatible

doRegister

doDeregister

doBeginRead

doConnect

doFinishConnect

newDirectBuffer

newDirectBuffer

doClose