Module io.netty5.transport

Package io.netty5.channel.nio

Class AbstractNioChannel<P extends Channel,L extends SocketAddress,R extends SocketAddress>

java.lang.Object

io.netty5.util.DefaultAttributeMap

io.netty5.channel.AbstractChannel<P,L,R>

io.netty5.channel.nio.AbstractNioChannel<P,L,R>

All Implemented Interfaces:

Channel, ChannelOutboundInvoker, IoHandle, io.netty5.util.AttributeMap, io.netty5.util.concurrent.FuturePromiseFactory, Comparable<Channel>

Direct Known Subclasses:

AbstractNioByteChannel, AbstractNioMessageChannel

public abstract class AbstractNioChannel<P extends Channel,L extends SocketAddress,R extends SocketAddress>
extends AbstractChannel<P,L,R>

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

Nested Class Summary

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

AbstractChannel.DefaultAbstractChannelPipeline, AbstractChannel.ReadSink, AbstractChannel.WriteSink

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractNioChannel(P parent, EventLoop eventLoop, boolean supportingDisconnect, ReadHandleFactory defaultReadHandleFactory, WriteHandleFactory defaultWriteHandleFactory, SelectableChannel ch, int readInterestOp)	Create a new instance

Method Summary

Modifier and Type	Method	Description
protected void	doClearScheduledRead()	Clear any previous scheduled read.
protected void	doClose()	Close the Channel
protected void	doRead(boolean wasReadPendingAlready)	Schedule a read operation.
boolean	isOpen()	Returns true if the Channel is open and may get active later
protected boolean	isWriteFlushedScheduled()	Returns true if flushed messages should not be tried to write when calling Channel.flush().
protected SelectableChannel	javaChannel()
protected io.netty5.buffer.Buffer	newDirectBuffer(io.netty5.buffer.Buffer buf)	Allocates a new off-heap copy of the given buffer, unless the cost of doing so is too high.
protected io.netty5.buffer.Buffer	newDirectBuffer(io.netty5.util.Resource<?> holder, io.netty5.buffer.Buffer buf)	Allocates a new off-heap copy of the given buffer, unless the cost of doing so is too high.
protected SelectionKey	selectionKey()	Return the current SelectionKey or null if the underlying channel was not registered with the Selector yet.
protected void	writeLoopComplete(boolean allWritten)	Called once the write loop completed.

Methods inherited from class io.netty5.channel.AbstractChannel

bufferAllocator, cacheAddresses, closeFuture, closeTransport, compareTo, doBind, doConnect, doDisconnect, doFinishConnect, doReadNow, doShutdown, doWriteNow, equals, executor, filterOutboundMessage, finishConnect, getExtendedOption, getOption, hashCode, id, isConnectPending, isExtendedOptionSupported, isOptionSupported, isReadPending, isRegistered, isSupportingDisconnect, localAddress, localAddress0, newChannelPipeline, newSupportedIdentityOptionsSet, parent, pipeline, prepareToClose, readBufferAllocator, readHandle, readIfIsAutoRead, readLoopComplete, readNow, remoteAddress, remoteAddress0, setExtendedOption, setOption, shutdownReadSide, toString, validateEventLoopGroup, validateFileRegion, writableBytes, writeFlushed, writeFlushedNow, writeHandle

Methods inherited from class io.netty5.util.DefaultAttributeMap

attr, hasAttr

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.netty5.util.AttributeMap

attr, hasAttr

Methods inherited from interface io.netty5.channel.Channel

bind, close, connect, connect, deregister, disconnect, flush, isActive, isShutdown, isWritable, read, read, register, sendOutboundEvent, shutdown, write, writeAndFlush

Methods inherited from interface io.netty5.channel.ChannelOutboundInvoker

newFailedFuture, newPromise, newSucceededFuture, newSucceededFuture

Constructor Detail

AbstractNioChannel

protected AbstractNioChannel(P parent,
                             EventLoop eventLoop,
                             boolean supportingDisconnect,
                             ReadHandleFactory defaultReadHandleFactory,
                             WriteHandleFactory defaultWriteHandleFactory,
                             SelectableChannel ch,
                             int readInterestOp)

Create a new instance

Parameters:

parent - the parent Channel by which this instance was created. May be null

eventLoop - the EventLoop to use for all I/O.

supportingDisconnect - true if and only if the channel has the disconnect() operation that allows a user to disconnect and then call {

Method Detail

isOpen

public final boolean isOpen()

Description copied from interface: Channel

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

javaChannel

protected SelectableChannel javaChannel()

selectionKey

protected final SelectionKey selectionKey()

Return the current SelectionKey or null if the underlying channel was not registered with the Selector yet.

doClearScheduledRead

protected final void doClearScheduledRead()

Description copied from class: AbstractChannel

Clear any previous scheduled read. By default, this method does nothing but implementations might override it to add extra logic.

Overrides:

doClearScheduledRead in class AbstractChannel<P extends Channel,L extends SocketAddress,R extends SocketAddress>

isWriteFlushedScheduled

protected final boolean isWriteFlushedScheduled()

Description copied from class: AbstractChannel

Returns true if flushed messages should not be tried to write when calling Channel.flush(). Instead these will be written once AbstractChannel.writeFlushedNow() is called, which is typically done once the underlying transport becomes writable again.

Overrides:

isWriteFlushedScheduled in class AbstractChannel<P extends Channel,L extends SocketAddress,R extends SocketAddress>

Returns:

true if write will be done later on by calling AbstractChannel.writeFlushedNow(), false otherwise.

doRead

protected final void doRead(boolean wasReadPendingAlready)

Description copied from class: AbstractChannel

Schedule a read operation.

Specified by:

doRead in class AbstractChannel<P extends Channel,L extends SocketAddress,R extends SocketAddress>

Parameters:

wasReadPendingAlready - true if a read was already pending when Channel.read() was called.

doClose

protected final void doClose()
                      throws Exception

Description copied from class: AbstractChannel

Close the Channel

Specified by:

doClose in class AbstractChannel<P extends Channel,L extends SocketAddress,R extends SocketAddress>

Throws:

Exception - thrown on error.

newDirectBuffer

protected final io.netty5.buffer.Buffer newDirectBuffer(io.netty5.buffer.Buffer buf)

Allocates a new off-heap copy of the given buffer, unless the cost of doing so is too high. The given buffer is closed if a copy is created, or returned directly.

Parameters:

buf - The buffer to copy.

Returns:

Probably an off-heap copy of the given buffer.

newDirectBuffer

protected final io.netty5.buffer.Buffer newDirectBuffer(io.netty5.util.Resource<?> holder,
                                                        io.netty5.buffer.Buffer buf)

Allocates a new off-heap copy of the given buffer, unless the cost of doing so is too high. The given holder is closed regardless.

Parameters:

buf - The buffer to copy.

Returns:

Probably an off-heap copy of the given buffer.

writeLoopComplete

protected final void writeLoopComplete(boolean allWritten)

Description copied from class: AbstractChannel

Called once the write loop completed. Subclasses might override this method for custom logic but should also call super.

Overrides:

writeLoopComplete in class AbstractChannel<P extends Channel,L extends SocketAddress,R extends SocketAddress>

Parameters:

allWritten - true if all messages were written during the write loop, false otherwise.