io.netty.channel.nio

Class AbstractNioChannel

java.lang.Object

io.netty.util.DefaultAttributeMap

io.netty.channel.AbstractChannel

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractNioChannel(Channel parent, SelectableChannel ch, int readInterestOp) Create a new instance

Method Summary

Modifier and Type	Method and Description
protected 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() 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.
boolean	isOpen() Returns true if the Channel is open and may get active later
protected boolean	isReadPending() Deprecated. No longer supported. No longer supported.
protected 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 SelectionKey	selectionKey() Return the current SelectionKey
protected void	setReadPending(boolean readPending) Deprecated. Use clearReadPending() if appropriate instead. No longer supported.
AbstractNioChannel.NioUnsafe	unsafe() Returns an internal-use-only object that provides unsafe operations.

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, doBind, doDisconnect, doWrite, equals, filterOutboundMessage, flush, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, localAddress, localAddress0, newChannelPipeline, newFailedFuture, newId, newProgressivePromise, newPromise, newSucceededFuture, newUnsafe, parent, pipeline, read, remoteAddress, remoteAddress0, toString, 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.channel.Channel

config, isActive, metadata

Methods inherited from interface io.netty.util.AttributeMap

attr, hasAttr

Field Detail

readInterestOp

protected final int readInterestOp

Constructor Detail

AbstractNioChannel

protected AbstractNioChannel(Channel parent,
                             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 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 SelectionKey selectionKey()

Return the current SelectionKey

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()
                   throws 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:

Exception

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