Package 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, 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	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 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	Description
private java.nio.channels.SelectableChannel	ch
private java.lang.Runnable	clearReadPendingRunnable
private ChannelPromise	connectPromise	The future of the current connection attempt.
private Future<?>	connectTimeoutFuture
private static InternalLogger	logger
protected int	readInterestOp
protected NioIoOps	readOps
(package private) boolean	readPending
(package private) IoRegistration	registration
private java.net.SocketAddress	requestedRemoteAddress

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractNioChannel(Channel parent, java.nio.channels.SelectableChannel ch, int readOps)	Create a new instance
protected	AbstractNioChannel(Channel parent, java.nio.channels.SelectableChannel ch, NioIoOps readOps)

Method Summary

Modifier and Type	Method	Description
protected void	addAndSubmit(NioIoOps addOps)
protected void	clearReadPending()	Set read pending to false.
private void	clearReadPending0()
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(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 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 IoRegistration	registration()
protected void	removeAndSubmit(NioIoOps removeOps)
protected java.nio.channels.SelectionKey	selectionKey()	Deprecated. use registration.
protected void	setReadPending(boolean readPending)	Deprecated. Use clearReadPending() if appropriate instead.
private void	setReadPending0(boolean readPending)
AbstractNioChannel.NioUnsafe	unsafe()	Returns an internal-use-only object that provides unsafe operations.

Methods inherited from class io.netty.channel.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 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.util.AttributeMap

attr, hasAttr

Methods inherited from interface io.netty.channel.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 Detail

logger

private static final InternalLogger logger

ch

private final java.nio.channels.SelectableChannel ch

readInterestOp

protected final int readInterestOp

readOps

protected final NioIoOps readOps

registration

volatile IoRegistration registration

readPending

boolean readPending

clearReadPendingRunnable

private final java.lang.Runnable clearReadPendingRunnable

connectPromise

private ChannelPromise connectPromise

The future of the current connection attempt. If not null, subsequent connection attempts will fail.

connectTimeoutFuture

private Future<?> connectTimeoutFuture

requestedRemoteAddress

private java.net.SocketAddress requestedRemoteAddress

Constructor Detail

AbstractNioChannel

protected AbstractNioChannel(Channel parent,
                             java.nio.channels.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,
                             java.nio.channels.SelectableChannel ch,
                             NioIoOps readOps)

Method Detail

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 java.nio.channels.SelectableChannel javaChannel()

selectionKey

@Deprecated
protected java.nio.channels.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.

setReadPending0

private void setReadPending0(boolean readPending)

clearReadPending0

private void clearReadPending0()

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