Nested and Inner Type Summary

Modifier and Type	Class and Description
protected abstract class	AbstractNioChannel.AbstractNioUnsafe
public static interface	AbstractNioChannel.NioUnsafe Special `Unsafe` sub-type which allows to access the underlying `SelectableChannel`

Field Summary

Modifier and Type	Field and Description
private final SelectableChannel	ch
private final Runnable	clearReadPendingRunnable
private ChannelPromise	connectPromise The future of the current connection attempt.
private Future<?>	connectTimeoutFuture
private static final InternalLogger	logger Hides io.netty.channel.AbstractChannel.logger.
protected final int	readInterestOp
pack-priv boolean	readPending
private SocketAddress	requestedRemoteAddress
pack-priv volatile SelectionKey	selectionKey

Constructor Summary

Access	Constructor and Description
protected	AbstractNioChannel(Channel the parent `Channel` by which this instance was created. May be `null` parent, SelectableChannel the underlying `SelectableChannel` on which it operates ch, int the ops to set to receive data from the `SelectableChannel` readInterestOp) Create a new instance

Method Summary

Modifier and Type	Method and Description
protected final void	clearReadPending() Set read pending to `false`.
private void	clearReadPending0()
protected void	doBeginRead() Implements abstract io.netty.channel.AbstractChannel.doBeginRead. Schedule a read operation.
protected void	doClose() Implements abstract io.netty.channel.AbstractChannel.doClose. Close the `Channel`
protected abstract boolean	doConnect(SocketAddress remoteAddress, SocketAddress localAddress) Connect to the remote peer
protected void	doDeregister() Overrides io.netty.channel.AbstractChannel.doDeregister. Deregister the `Channel` from its `EventLoop`.
protected abstract void	doFinishConnect() Finish the connect
protected void	doRegister() Overrides io.netty.channel.AbstractChannel.doRegister. Is called after the `Channel` is registered with its `EventLoop` as part of the register process.
public NioEventLoop	eventLoop() Overrides io.netty.channel.AbstractChannel.eventLoop. Implements io.netty.channel.Channel.eventLoop. Return the `EventLoop` this `Channel` was registered to.
protected boolean	isCompatible(EventLoop loop) Implements abstract io.netty.channel.AbstractChannel.isCompatible. Return `true` if the given `EventLoop` is compatible with this instance.
public boolean	isOpen() Implements io.netty.channel.Channel.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 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 SelectionKey	selectionKey() Return the current `SelectionKey`
protected void	setReadPending(final boolean readPending) Deprecated Use `clearReadPending()` if appropriate instead. No longer supported.
private void	setReadPending0(boolean readPending)
public AbstractNioChannel.NioUnsafe	unsafe() Overrides io.netty.channel.AbstractChannel.unsafe. Implements io.netty.channel.Channel.unsafe. Returns an internal-use-only object that provides unsafe operations.

Field Detail

ch	back to summary
private final SelectableChannel ch

clearReadPendingRunnable	back to summary
private final Runnable clearReadPendingRunnable

connectPromise	back to summary
private ChannelPromise connectPromise The future of the current connection attempt. If not null, subsequent connection attempts will fail.

connectTimeoutFuture	back to summary
private Future<?> connectTimeoutFuture

logger	back to summary
private static final InternalLogger logger Hides io.netty.channel.AbstractChannel.logger.

readInterestOp	back to summary
protected final int readInterestOp

readPending	back to summary
pack-priv boolean readPending

requestedRemoteAddress	back to summary
private SocketAddress requestedRemoteAddress

selectionKey	back to summary
pack-priv volatile SelectionKey selectionKey

Constructor Detail

AbstractNioChannel back to summary

AbstractNioChannel	back to summary
protected AbstractNioChannel(Channel parent, SelectableChannel ch, int readInterestOp) Create a new instance Parameters parent:Channel the parent `Channel` by which this instance was created. May be `null` ch:SelectableChannel the underlying `SelectableChannel` on which it operates readInterestOp:int the ops to set to receive data from the `SelectableChannel`

protected AbstractNioChannel(Channel parent, SelectableChannel ch, int readInterestOp)

Create a new instance

Parameters

parent:Channel: the parent Channel by which this instance was created. May be null
ch:SelectableChannel: the underlying SelectableChannel on which it operates
readInterestOp:int: the ops to set to receive data from the SelectableChannel

Method Detail

clearReadPending	back to summary
protected final void clearReadPending() Set read pending to `false`.

clearReadPending0	back to summary
private void clearReadPending0()

doBeginRead	back to summary
protected void doBeginRead() throws Exception Implements abstract io.netty.channel.AbstractChannel.doBeginRead. Doc from io.netty.channel.AbstractChannel.doBeginRead. Schedule a read operation. Annotations @Override

doBeginRead

back to summary

protected void doBeginRead() throws Exception

Implements abstract io.netty.channel.AbstractChannel.doBeginRead.

Doc from io.netty.channel.AbstractChannel.doBeginRead.

Schedule a read operation.

Annotations

@Override

doClose back to summary

doClose	back to summary
protected void doClose() throws Exception Implements abstract io.netty.channel.AbstractChannel.doClose. Doc from io.netty.channel.AbstractChannel.doClose. Close the `Channel` Annotations @Override

protected void doClose() throws Exception

Implements abstract io.netty.channel.AbstractChannel.doClose.

Doc from io.netty.channel.AbstractChannel.doClose.

Close the Channel

Annotations

@Override

doConnect	back to summary
protected abstract boolean doConnect(SocketAddress remoteAddress, SocketAddress localAddress) throws Exception Connect to the remote peer

doDeregister back to summary

doDeregister	back to summary
protected void doDeregister() throws Exception Overrides io.netty.channel.AbstractChannel.doDeregister. Doc from io.netty.channel.AbstractChannel.doDeregister. Deregister the `Channel` from its `EventLoop`. Sub-classes may override this method Annotations @Override

protected void doDeregister() throws Exception

Overrides io.netty.channel.AbstractChannel.doDeregister.

Doc from io.netty.channel.AbstractChannel.doDeregister.

Deregister the Channel from its EventLoop. Sub-classes may override this method

Annotations

@Override

doFinishConnect	back to summary
protected abstract void doFinishConnect() throws Exception Finish the connect

doRegister back to summary

doRegister	back to summary
protected void doRegister() throws Exception Overrides io.netty.channel.AbstractChannel.doRegister. Doc from io.netty.channel.AbstractChannel.doRegister. Is called after the `Channel` is registered with its `EventLoop` as part of the register process. Sub-classes may override this method Annotations @Override

protected void doRegister() throws Exception

Overrides io.netty.channel.AbstractChannel.doRegister.

Doc from io.netty.channel.AbstractChannel.doRegister.

Is called after the Channel is registered with its EventLoop as part of the register process. Sub-classes may override this method

Annotations

@Override

eventLoop back to summary

eventLoop	back to summary
public NioEventLoop eventLoop() Overrides io.netty.channel.AbstractChannel.eventLoop. Implements io.netty.channel.Channel.eventLoop. Doc from io.netty.channel.Channel.eventLoop. Return the `EventLoop` this `Channel` was registered to. Annotations @Override

public NioEventLoop eventLoop()

Overrides io.netty.channel.AbstractChannel.eventLoop.

Implements io.netty.channel.Channel.eventLoop.

Doc from io.netty.channel.Channel.eventLoop.

Return the EventLoop this Channel was registered to.

Annotations

@Override

isCompatible back to summary

isCompatible	back to summary
protected boolean isCompatible(EventLoop loop) Implements abstract io.netty.channel.AbstractChannel.isCompatible. Doc from io.netty.channel.AbstractChannel.isCompatible. Return `true` if the given `EventLoop` is compatible with this instance. Annotations @Override

protected boolean isCompatible(EventLoop loop)

Implements abstract io.netty.channel.AbstractChannel.isCompatible.

Doc from io.netty.channel.AbstractChannel.isCompatible.

Return true if the given EventLoop is compatible with this instance.

Annotations

@Override

isOpen back to summary

isOpen	back to summary
public boolean isOpen() Implements io.netty.channel.Channel.isOpen. Doc from io.netty.channel.Channel.isOpen. Returns `true` if the `Channel` is open and may get active later Annotations @Override

public boolean isOpen()

Implements io.netty.channel.Channel.isOpen.

Doc from io.netty.channel.Channel.isOpen.

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

Annotations

@Override

isReadPending	back to summary
protected boolean isReadPending() Deprecated No longer supported. No longer supported. Annotations @Deprecated

javaChannel	back to summary
protected SelectableChannel javaChannel()

newDirectBuffer	back to summary
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 back to summary

newDirectBuffer	back to summary
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`..

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

selectionKey	back to summary
protected SelectionKey selectionKey() Return the current `SelectionKey`

setReadPending	back to summary
protected void setReadPending(final boolean readPending) Deprecated Use `clearReadPending()` if appropriate instead. No longer supported. Annotations @Deprecated

setReadPending0	back to summary
private void setReadPending0(boolean readPending)

unsafe	back to summary
public AbstractNioChannel.NioUnsafe unsafe() Overrides io.netty.channel.AbstractChannel.unsafe. Implements io.netty.channel.Channel.unsafe. Doc from io.netty.channel.Channel.unsafe. Returns an internal-use-only object that provides unsafe operations. Annotations @Override

unsafe

back to summary

public AbstractNioChannel.NioUnsafe unsafe()

Overrides io.netty.channel.AbstractChannel.unsafe.

Implements io.netty.channel.Channel.unsafe.

Doc from io.netty.channel.Channel.unsafe.

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

Annotations

@Override

io.netty.channel.nio back to summary

protected abstract Class AbstractNioChannel.AbstractNioUnsafe

Class Inheritance

extends AbstractUnsafe
implements NioUnsafe

java.lang.Object
io.netty.channel.AbstractChannel.AbstractUnsafe
io.netty.channel.nio.AbstractNioChannel.AbstractNioUnsafe

All Implemented Interfaces

io.netty.channel.nio.AbstractNioChannel.NioUnsafe, io.netty.channel.Channel.Unsafe

Known Direct Subclasses

io.netty.channel.nio.AbstractNioMessageChannel.NioMessageUnsafe, io.netty.channel.nio.AbstractNioByteChannel.NioByteUnsafe

Constructor Summary

Access	Constructor and Description
protected	AbstractNioUnsafe()

Method Summary

Modifier and Type	Method and Description
public final SelectableChannel	ch() Implements io.netty.channel.nio.AbstractNioChannel.NioUnsafe.ch. Return underlying `SelectableChannel`
public final void	connect(final SocketAddress remoteAddress, final SocketAddress localAddress, final ChannelPromise promise) Implements io.netty.channel.Channel.Unsafe.connect. Connect the `Channel` of the given `ChannelFuture` with the given remote `SocketAddress`.
public final void	finishConnect() Implements io.netty.channel.nio.AbstractNioChannel.NioUnsafe.finishConnect. Finish connect
protected final void	flush0() Overrides io.netty.channel.AbstractChannel.AbstractUnsafe.flush0.
public final void	forceFlush() Implements io.netty.channel.nio.AbstractNioChannel.NioUnsafe.forceFlush.
private void	fulfillConnectPromise(ChannelPromise promise, boolean wasActive)
private void	fulfillConnectPromise(ChannelPromise promise, Throwable cause)
private boolean	isFlushPending()
protected final void	removeReadOp()

Constructor Detail

AbstractNioUnsafe	back to summary
protected AbstractNioUnsafe()

Method Detail

ch back to summary

ch	back to summary
public final SelectableChannel ch() Implements io.netty.channel.nio.AbstractNioChannel.NioUnsafe.ch. Doc from io.netty.channel.nio.AbstractNioChannel.NioUnsafe.ch. Return underlying `SelectableChannel` Annotations @Override

public final SelectableChannel ch()

Implements io.netty.channel.nio.AbstractNioChannel.NioUnsafe.ch.

Doc from io.netty.channel.nio.AbstractNioChannel.NioUnsafe.ch.

Return underlying SelectableChannel

Annotations

@Override

connect back to summary

connect	back to summary
public final void connect(final SocketAddress remoteAddress, final SocketAddress localAddress, final ChannelPromise promise) Implements io.netty.channel.Channel.Unsafe.connect. Doc from io.netty.channel.Channel.Unsafe.connect. Connect the `Channel` of the given `ChannelFuture` with the given remote `SocketAddress`. If a specific local `SocketAddress` should be used it need to be given as argument. Otherwise just pass `null` to it. The `ChannelPromise` will get notified once the connect operation was complete. Annotations @Override

public final void connect(final SocketAddress remoteAddress, final SocketAddress localAddress, final ChannelPromise promise)

Implements io.netty.channel.Channel.Unsafe.connect.

Doc from io.netty.channel.Channel.Unsafe.connect.

Connect the Channel of the given ChannelFuture with the given remote SocketAddress. If a specific local SocketAddress should be used it need to be given as argument. Otherwise just pass null to it. The ChannelPromise will get notified once the connect operation was complete.

Annotations

@Override

finishConnect	back to summary
public final void finishConnect() Implements io.netty.channel.nio.AbstractNioChannel.NioUnsafe.finishConnect. Doc from io.netty.channel.nio.AbstractNioChannel.NioUnsafe.finishConnect. Finish connect Annotations @Override

finishConnect

back to summary

public final void finishConnect()

Implements io.netty.channel.nio.AbstractNioChannel.NioUnsafe.finishConnect.

Doc from io.netty.channel.nio.AbstractNioChannel.NioUnsafe.finishConnect.

Finish connect

Annotations

@Override

flush0	back to summary
protected final void flush0() Overrides io.netty.channel.AbstractChannel.AbstractUnsafe.flush0. Annotations @Override

flush0

back to summary

protected final void flush0()

Overrides io.netty.channel.AbstractChannel.AbstractUnsafe.flush0.

Annotations

@Override

forceFlush	back to summary
public final void forceFlush() Implements io.netty.channel.nio.AbstractNioChannel.NioUnsafe.forceFlush. Annotations @Override

forceFlush

back to summary

public final void forceFlush()

Implements io.netty.channel.nio.AbstractNioChannel.NioUnsafe.forceFlush.

Annotations

@Override

fulfillConnectPromise	back to summary
private void fulfillConnectPromise(ChannelPromise promise, boolean wasActive)

fulfillConnectPromise	back to summary
private void fulfillConnectPromise(ChannelPromise promise, Throwable cause)

isFlushPending	back to summary
private boolean isFlushPending()

removeReadOp	back to summary
protected final void removeReadOp()

io.netty.channel.nio back to summary

public Interface AbstractNioChannel.NioUnsafe

Known Direct Implementers: io.netty.channel.nio.AbstractNioChannel.AbstractNioUnsafe

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

Method Summary

Modifier and Type	Method and Description
public SelectableChannel	ch() Return underlying `SelectableChannel`
public void	finishConnect() Finish connect
public void	forceFlush()
public void	read() Read from underlying `SelectableChannel`

Inherited from io.netty.channel.Channel.Unsafe:: beginRead bind close closeForcibly connect deregister disconnect flush localAddress outboundBuffer recvBufAllocHandle register remoteAddress voidPromise write

Method Detail

ch	back to summary
public SelectableChannel ch() Return underlying `SelectableChannel`

finishConnect	back to summary
public void finishConnect() Finish connect

forceFlush	back to summary
public void forceFlush()

read	back to summary
public void read() Read from underlying `SelectableChannel`

public abstract Class AbstractNioChannel

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected abstract Class AbstractNioChannel.AbstractNioUnsafe

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public Interface AbstractNioChannel.NioUnsafe

Method Summary

Method Detail