AbstractNioChannel (Netty API Reference (4.0.56.Final))

java.lang.Object
- io.netty.util.DefaultAttributeMap
- - io.netty.channel.AbstractChannel
  - - io.netty.channel.nio.AbstractNioChannel

All Implemented Interfaces:

Channel, AttributeMap, java.lang.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 and Description
`protected class`	`AbstractNioChannel.AbstractNioUnsafe`
`static interface`	`AbstractNioChannel.NioUnsafe` Special `Unsafe` sub-type which allows to access the underlying `SelectableChannel`

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

protected int readInterestOp

Fields
Modifier and Type	Field and Description
`protected int`	`readInterestOp`

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractNioChannel(Channel parent, java.nio.channels.SelectableChannel ch, int readInterestOp)
Create a new instance

Constructors
Modifier	Constructor and Description
`protected`	`AbstractNioChannel(Channel parent, java.nio.channels.SelectableChannel ch, int readInterestOp)` Create a new instance

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`doBeginRead()` Schedule a read operation.
`protected void`	`doClose()` Close the `Channel`
`protected abstract boolean`	`doConnect(java.net.SocketAddress remoteAddress, java.net.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()` Is called after the `Channel` is registered with its `EventLoop` as part of the register process.
`NioEventLoop`	`eventLoop()` Return the `EventLoop` this `Channel` was registered to.
`protected boolean`	`isCompatible(EventLoop loop)` Return `true` if the given `EventLoop` is compatible with this instance.
`protected boolean`	`isInputShutdown()` Return `true` if the input of this `Channel` is shutdown
`boolean`	`isOpen()` Returns `true` if the `Channel` is open and may get active later
`protected boolean`	`isReadPending()`
`protected java.nio.channels.SelectableChannel`	`javaChannel()`
`protected ByteBuf`	`newDirectBuffer(ByteBuf buf)` Returns an off-heap copy of the specified `ByteBuf`, and releases the original one.
`protected ByteBuf`	`newDirectBuffer(ReferenceCounted holder, ByteBuf buf)` Returns an off-heap copy of the specified `ByteBuf`, and releases the specified holder.
`protected java.nio.channels.SelectionKey`	`selectionKey()` Return the current `SelectionKey`
`protected void`	`setReadPending(boolean readPending)`
`AbstractNioChannel.NioUnsafe`	`unsafe()` Returns an internal-use-only object that provides unsafe operations.

Methods inherited from class io.netty.channel.AbstractChannel
alloc, bind, bind, close, close, closeFuture, compareTo, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, doBind, doDisconnect, doShutdownOutput, doWrite, equals, filterOutboundMessage, flush, hashCode, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, localAddress, localAddress0, newChannelPipeline, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, newUnsafe, parent, pipeline, read, remoteAddress, remoteAddress0, toString, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from class io.netty.util.DefaultAttributeMap
attr

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.netty.channel.Channel
config, isActive, metadata

Methods inherited from interface io.netty.util.AttributeMap
attr

- Field Detail
  - readInterestOp
```
protected final int readInterestOp
```
- Constructor Detail
  - AbstractNioChannel
```
protected AbstractNioChannel(Channel parent,
                             java.nio.channels.SelectableChannel ch,
                             int readInterestOp)
```
    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
    
    readInterestOp - the ops to set to receive data from the SelectableChannel
- Method Detail
  - 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 java.nio.channels.SelectableChannel javaChannel()
```
  - eventLoop
```
public NioEventLoop eventLoop()
```
    Description copied from interface: Channel
    
    Return the EventLoop this Channel was registered to.
    
    Specified by:
    
    eventLoop in interface Channel
    
    Overrides:
    
    eventLoop in class AbstractChannel
  - selectionKey
```
protected java.nio.channels.SelectionKey selectionKey()
```
    Return the current SelectionKey
  - isReadPending
```
protected boolean isReadPending()
```
  - setReadPending
```
protected void setReadPending(boolean readPending)
```
  - isInputShutdown
```
protected boolean isInputShutdown()
```
    Return true if the input of this Channel is shutdown
  - 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()
                   throws java.lang.Exception
```
    Description copied from class: AbstractChannel
    
    Is called after the Channel is registered with its EventLoop as part of the register process. Sub-classes may override this method
    
    Overrides:
    
    doRegister in class AbstractChannel
    
    Throws:
    
    java.lang.Exception
  - doDeregister
```
protected void doDeregister()
                     throws java.lang.Exception
```
    Description copied from class: AbstractChannel
    
    Deregister the Channel from its EventLoop. Sub-classes may override this method
    
    Overrides:
    
    doDeregister in class AbstractChannel
    
    Throws:
    
    java.lang.Exception
  - doBeginRead
```
protected void doBeginRead()
                    throws java.lang.Exception
```
    Description copied from class: AbstractChannel
    
    Schedule a read operation.
    
    Specified by:
    
    doBeginRead in class AbstractChannel
    
    Throws:
    
    java.lang.Exception
  - doConnect
```
protected abstract boolean doConnect(java.net.SocketAddress remoteAddress,
                                     java.net.SocketAddress localAddress)
                              throws java.lang.Exception
```
    Connect to the remote peer
    
    Throws:
    
    java.lang.Exception
  - doFinishConnect
```
protected abstract void doFinishConnect()
                                 throws java.lang.Exception
```
    Finish the connect
    
    Throws:
    
    java.lang.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 java.lang.Exception
```
    Description copied from class: AbstractChannel
    
    Close the Channel
    
    Specified by:
    
    doClose in class AbstractChannel
    
    Throws:
    
    java.lang.Exception

Class AbstractNioChannel

Nested Class Summary

Nested classes/interfaces inherited from class io.netty.channel.AbstractChannel

Nested classes/interfaces inherited from interface io.netty.channel.Channel

Field Summary

Constructor Summary

Method Summary

Methods inherited from class io.netty.channel.AbstractChannel

Methods inherited from class io.netty.util.DefaultAttributeMap

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.channel.Channel

Methods inherited from interface io.netty.util.AttributeMap

Field Detail

readInterestOp

Constructor Detail

AbstractNioChannel

Method Detail

isOpen

unsafe

javaChannel

eventLoop

selectionKey

isReadPending

setReadPending

isInputShutdown

isCompatible

doRegister

doDeregister

doBeginRead

doConnect

doFinishConnect

newDirectBuffer

newDirectBuffer

doClose