java.lang.Object
- io.netty5.util.DefaultAttributeMap
- - io.netty5.channel.AbstractChannel<P,L,R>

All Implemented Interfaces:

Channel, ChannelOutboundInvoker, IoHandle, AttributeMap, FuturePromiseFactory, Comparable<Channel>

Direct Known Subclasses:

AbstractNioChannel, AbstractServerChannel, EmbeddedChannel, EpollDatagramChannel, EpollServerSocketChannel, EpollSocketChannel, KQueueDatagramChannel, KQueueServerSocketChannel, KQueueSocketChannel, LocalChannel
```
public abstract class AbstractChannel<P extends Channel,L extends SocketAddress,R extends SocketAddress>
extends DefaultAttributeMap
implements Channel
```
A skeletal Channel implementation.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

protected static class AbstractChannel.DefaultAbstractChannelPipeline

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`AbstractChannel(P parent, EventLoop eventLoop, ChannelMetadata metadata)`	Creates a new instance.
`protected`	`AbstractChannel(P parent, EventLoop eventLoop, ChannelMetadata metadata, RecvBufferAllocator defaultRecvBufferAllocator)`	Creates a new instance.
`protected`	`AbstractChannel(P parent, EventLoop eventLoop, ChannelMetadata metadata, RecvBufferAllocator defaultRecvBufferAllocator, ChannelId id)`	Creates a new instance.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected static Throwable`	`annotateConnectException(Throwable cause, SocketAddress remoteAddress)`	Appends the remote address to the message of the exceptions caused by connection attempt failure.
`protected void`	`assertEventLoop()`
`protected void`	`autoReadCleared()`	Is called once `setAutoRead(boolean)` is called with `false` and `isAutoRead()` was `true` before.
`BufferAllocator`	`bufferAllocator()`	Return the assigned `BufferAllocator` which will be used to allocate `Buffer`s.
`protected void`	`cacheAddresses(L localAddress, R remoteAddress)`
`protected void`	`closeForciblyTransport()`
`Future<Void>`	`closeFuture()`	Returns the `Future` which will be notified when this channel is closed.
`protected void`	`closeIfClosed()`
`protected void`	`closeTransport(Promise<Void> promise)`
`int`	`compareTo(Channel o)`
`protected void`	`deregisterTransport(Promise<Void> promise)`
`protected abstract void`	`doBeginRead()`	Schedule a read operation.
`protected abstract void`	`doBind(SocketAddress localAddress)`	Bind the `Channel` to the `SocketAddress`
`protected abstract void`	`doClose()`	Close the `Channel`
`protected abstract boolean`	`doConnect(SocketAddress remoteAddress, SocketAddress localAddress)`	Connect to remote peer.
`protected abstract void`	`doDisconnect()`	Disconnect this `Channel` from its remote peer
`protected abstract boolean`	`doFinishConnect(R requestedRemoteAddress)`	Finish a connect request.
`protected abstract void`	`doShutdown(ChannelShutdownDirection direction)`	Shutdown one direction of the `Channel`.
`protected abstract void`	`doWrite(ChannelOutboundBuffer in)`	Flush the content of the given buffer to the remote peer.
`protected boolean`	`ensureOpen(Promise<Void> promise)`
`boolean`	`equals(Object o)`	Returns `true` if and only if the specified object is identical with this channel (i.e: `this == o`).
`EventLoop`	`executor()`	Return the `EventLoop` this `Channel` was registered to.
`protected Object`	`filterOutboundMessage(Object msg)`	Invoked when a new message is added to a `ChannelOutboundBuffer` of this `AbstractChannel`, so that the `Channel` implementation converts the message to another.
`protected void`	`finishConnect()`	Should be called once the connect request is ready to be completed.
`protected boolean`	`fireChannelActiveIfNotActiveBefore()`	Calls `ChannelPipeline.fireChannelActive()` if it was not done yet.
`protected <T> T`	`getExtendedOption(ChannelOption<T> option)`	Override to add support for more `ChannelOption`s.
`protected int`	`getMaxMessagesPerWrite()`	Get the maximum number of message to write per eventloop run.
`<T> T`	`getOption(ChannelOption<T> option)`	Return the value of the given `ChannelOption`
`protected int`	`getWriteSpinCount()`
`protected void`	`handleWriteError(Throwable t)`
`int`	`hashCode()`	Returns the ID of this channel.
`ChannelId`	`id()`	Returns the globally unique identifier of this `Channel`.
`protected boolean`	`isAllowHalfClosure()`
`protected boolean`	`isAutoRead()`
`protected boolean`	`isConnectPending()`	Returns if a connect request was issued before and we are waiting for `finishConnect()` to be called.
`protected boolean`	`isExtendedOptionSupported(ChannelOption<?> option)`	Override to add support for more `ChannelOption`s.
`boolean`	`isOptionSupported(ChannelOption<?> option)`	Returns `true` if the given `ChannelOption` is supported by this `Channel` implementation.
`boolean`	`isRegistered()`	Return true if registered already.
`L`	`localAddress()`	Returns the local address where this channel is bound to.
`protected abstract L`	`localAddress0()`	Returns the `SocketAddress` which is bound locally.
`ChannelMetadata`	`metadata()`	Return the `ChannelMetadata` of the `Channel` which describe the nature of the `Channel`.
`protected ChannelPipeline`	`newChannelPipeline()`	Returns a new `ChannelPipeline` instance.
`protected static Set<ChannelOption<?>>`	`newSupportedIdentityOptionsSet(ChannelOption<?>... options)`
`protected ChannelOutboundBuffer`	`outboundBuffer()`	Returns the `ChannelOutboundBuffer` that is used by this `AbstractChannel`.
`P`	`parent()`	Returns the parent of this channel.
`ChannelPipeline`	`pipeline()`	Return the assigned `ChannelPipeline`.
`protected Future<Executor>`	`prepareToClose()`	Prepares to close the `Channel`.
`protected void`	`readIfIsAutoRead()`
`protected RecvBufferAllocator.Handle`	`recvBufAllocHandle()`
`R`	`remoteAddress()`	Returns the remote address where this channel is connected to.
`protected abstract R`	`remoteAddress0()`	Return the `SocketAddress` which the `Channel` is connected to.
`protected void`	`runAfterTransportAction()`
`protected void`	`safeSetFailure(Promise<Void> promise, Throwable cause)`	Marks the specified `promise` as failure.
`protected void`	`safeSetSuccess(Promise<Void> promise)`	Marks the specified `promise` as success.
`void`	`setBufferAllocator(BufferAllocator bufferAllocator)`
`protected <T> void`	`setExtendedOption(ChannelOption<T> option, T value)`	Override to add support for more `ChannelOption`s.
`<T> Channel`	`setOption(ChannelOption<T> option, T value)`	Sets a configuration property with the specified name and value.
`protected void`	`shutdownTransport(ChannelShutdownDirection direction, Promise<Void> promise)`
`String`	`toString()`	Returns the `String` representation of this channel.
`protected <T> void`	`validate(ChannelOption<T> option, T value)`
`protected static <T extends EventLoopGroup> T`	`validateEventLoopGroup(T group, String name, Class<? extends Channel> channelType)`
`protected static void`	`validateFileRegion(DefaultFileRegion region, long position)`
`long`	`writableBytes()`	Returns how many bytes can be written before the `Channel` becomes 'unwritable'.
`protected void`	`writeFlushed()`	Write previous flushed messages.

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, isOpen, isShutdown, isWritable, read, register, sendOutboundEvent, shutdown, write, writeAndFlush

Methods inherited from interface io.netty5.channel.ChannelOutboundInvoker
newFailedFuture, newPromise, newSucceededFuture, newSucceededFuture

- Constructor Detail
  - AbstractChannel
```
protected AbstractChannel(P parent,
                          EventLoop eventLoop,
                          ChannelMetadata metadata)
```
    Creates a new instance.
    
    Parameters:
    
    parent - the parent of this channel. null if there's no parent.
    
    eventLoop - the EventLoop which will be used.
    
    metadata - the ChannelMetadata to use.
  - AbstractChannel
```
protected AbstractChannel(P parent,
                          EventLoop eventLoop,
                          ChannelMetadata metadata,
                          RecvBufferAllocator defaultRecvBufferAllocator)
```
    Creates a new instance.
    
    Parameters:
    
    parent - the parent of this channel. null if there's no parent.
    
    eventLoop - the EventLoop which will be used.
    
    metadata - the ChannelMetadata to use.
    
    defaultRecvBufferAllocator - the RecvBufferAllocator that is used by default.
  - AbstractChannel
```
protected AbstractChannel(P parent,
                          EventLoop eventLoop,
                          ChannelMetadata metadata,
                          RecvBufferAllocator defaultRecvBufferAllocator,
                          ChannelId id)
```
    Creates a new instance.
    
    Parameters:
    
    parent - the parent of this channel. null if there's no parent.
    
    eventLoop - the EventLoop which will be used.
    
    metadata - the ChannelMetadata to use.
    
    defaultRecvBufferAllocator - the RecvBufferAllocator that is used by default.
    
    id - the ChannelId which will be used.
- Method Detail
  - validateEventLoopGroup
```
protected static <T extends EventLoopGroup> T validateEventLoopGroup(T group,
                                                                     String name,
                                                                     Class<? extends Channel> channelType)
```
  - id
```
public final ChannelId id()
```
    Description copied from interface: Channel
    
    Returns the globally unique identifier of this Channel.
    
    Specified by:
    
    id in interface Channel
  - metadata
```
public final ChannelMetadata metadata()
```
    Description copied from interface: Channel
    
    Return the ChannelMetadata of the Channel which describe the nature of the Channel.
    
    Specified by:
    
    metadata in interface Channel
  - newChannelPipeline
```
protected ChannelPipeline newChannelPipeline()
```
    Returns a new ChannelPipeline instance.
  - bufferAllocator
```
public BufferAllocator bufferAllocator()
```
    Description copied from interface: Channel
    
    Return the assigned BufferAllocator which will be used to allocate Buffers.
    
    Specified by:
    
    bufferAllocator in interface Channel
  - parent
```
public final P parent()
```
    Description copied from interface: Channel
    
    Returns the parent of this channel.
    
    Specified by:
    
    parent in interface Channel
    
    Returns:
    
    the parent channel. null if this channel does not have a parent channel.
  - pipeline
```
public final ChannelPipeline pipeline()
```
    Description copied from interface: Channel
    
    Return the assigned ChannelPipeline.
    
    Specified by:
    
    pipeline in interface Channel
  - executor
```
public final EventLoop executor()
```
    Description copied from interface: Channel
    
    Return the EventLoop this Channel was registered to.
    
    Specified by:
    
    executor in interface Channel
    
    Specified by:
    
    executor in interface ChannelOutboundInvoker
    
    Returns:
    
    the executor.
  - localAddress
```
public final L localAddress()
```
    Description copied from interface: Channel
    
    Returns the local address where this channel is bound to. The returned SocketAddress is supposed to be down-cast into more concrete type such as InetSocketAddress to retrieve the detailed information.
    
    Specified by:
    
    localAddress in interface Channel
    
    Returns:
    
    the local address of this channel. null if this channel is not bound.
  - remoteAddress
```
public final R remoteAddress()
```
    Description copied from interface: Channel
    
    Returns the remote address where this channel is connected to. The returned SocketAddress is supposed to be down-cast into more concrete type such as InetSocketAddress to retrieve the detailed information.
    
    Specified by:
    
    remoteAddress in interface Channel
    
    Returns:
    
    the remote address of this channel. null if this channel is not connected. If this channel is not connected but it can receive messages from arbitrary remote addresses (e.g. DatagramChannel, use DefaultAddressedEnvelope.recipient() to determine the origination of the received message as this method will return null.
  - cacheAddresses
```
protected final void cacheAddresses(L localAddress,
                                    R remoteAddress)
```
  - isRegistered
```
public final boolean isRegistered()
```
    Description copied from interface: IoHandle
    
    Return true if registered already.
    
    Specified by:
    
    isRegistered in interface IoHandle
    
    Returns:
    
    true if registered, false otherwise
  - closeFuture
```
public final Future<Void> closeFuture()
```
    Description copied from interface: Channel
    
    Returns the Future which will be notified when this channel is closed. This method always returns the same future instance.
    
    Specified by:
    
    closeFuture in interface Channel
  - writableBytes
```
public final long writableBytes()
```
    Description copied from interface: Channel
    
    Returns how many bytes can be written before the Channel becomes 'unwritable'. Once a Channel becomes unwritable, all messages will be queued until the I/O thread is ready to process the queued write requests.
    
    Specified by:
    
    writableBytes in interface Channel
    
    Returns:
    
    the number of bytes that can be written before the Channel becomes unwritable.
  - hashCode
```
public final int hashCode()
```
    Returns the ID of this channel.
    
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object o)
```
    Returns true if and only if the specified object is identical with this channel (i.e: this == o).
    
    Overrides:
    
    equals in class Object
  - compareTo
```
public final int compareTo(Channel o)
```
    Specified by:
    
    compareTo in interface Comparable<P extends Channel>
  - toString
```
public String toString()
```
    Returns the String representation of this channel. The returned string contains the ID, local address, and remote address of this channel for easier identification.
    
    Overrides:
    
    toString in class Object
  - readIfIsAutoRead
```
protected final void readIfIsAutoRead()
```
  - assertEventLoop
```
protected final void assertEventLoop()
```
  - recvBufAllocHandle
```
protected RecvBufferAllocator.Handle recvBufAllocHandle()
```
  - fireChannelActiveIfNotActiveBefore
```
protected final boolean fireChannelActiveIfNotActiveBefore()
```
    Calls ChannelPipeline.fireChannelActive() if it was not done yet.
    
    Returns:
    
    true if ChannelPipeline.fireChannelActive() was called, false otherwise.
  - closeTransport
```
protected void closeTransport(Promise<Void> promise)
```
  - closeForciblyTransport
```
protected final void closeForciblyTransport()
```
  - shutdownTransport
```
protected final void shutdownTransport(ChannelShutdownDirection direction,
                                       Promise<Void> promise)
```
  - deregisterTransport
```
protected void deregisterTransport(Promise<Void> promise)
```
  - writeFlushed
```
protected void writeFlushed()
```
    Write previous flushed messages.
  - handleWriteError
```
protected final void handleWriteError(Throwable t)
```
  - ensureOpen
```
protected final boolean ensureOpen(Promise<Void> promise)
```
  - safeSetSuccess
```
protected final void safeSetSuccess(Promise<Void> promise)
```
    Marks the specified promise as success. If the promise is done already, log a message.
  - safeSetFailure
```
protected final void safeSetFailure(Promise<Void> promise,
                                    Throwable cause)
```
    Marks the specified promise as failure. If the promise is done already, log a message.
  - closeIfClosed
```
protected final void closeIfClosed()
```
  - annotateConnectException
```
protected static Throwable annotateConnectException(Throwable cause,
                                                    SocketAddress remoteAddress)
```
    Appends the remote address to the message of the exceptions caused by connection attempt failure.
  - prepareToClose
```
protected Future<Executor> prepareToClose()
```
    Prepares to close the Channel. If this method returns an Executor, the caller must call the Executor.execute(Runnable) method with a task that calls doClose() on the returned Executor. If this method returns null, doClose() must be called from the caller thread. (i.e. EventLoop)
  - outboundBuffer
```
protected final ChannelOutboundBuffer outboundBuffer()
```
    Returns the ChannelOutboundBuffer that is used by this AbstractChannel. This might be null if no more writes are allowed.
    
    Returns:
    
    the outbound buffer.
  - localAddress0
```
protected abstract L localAddress0()
```
    Returns the SocketAddress which is bound locally.
  - remoteAddress0
```
protected abstract R remoteAddress0()
```
    Return the SocketAddress which the Channel is connected to.
  - doBind
```
protected abstract void doBind(SocketAddress localAddress)
                        throws Exception
```
    Bind the Channel to the SocketAddress
    
    Throws:
    
    Exception
  - doDisconnect
```
protected abstract void doDisconnect()
                              throws Exception
```
    Disconnect this Channel from its remote peer
    
    Throws:
    
    Exception
  - doClose
```
protected abstract void doClose()
                         throws Exception
```
    Close the Channel
    
    Throws:
    
    Exception
  - doShutdown
```
protected abstract void doShutdown(ChannelShutdownDirection direction)
                            throws Exception
```
    Shutdown one direction of the Channel.
    
    Parameters:
    
    direction - the direction to shutdown.
    
    Throws:
    
    Exception - thrown on error.
  - doBeginRead
```
protected abstract void doBeginRead()
                             throws Exception
```
    Schedule a read operation.
    
    Throws:
    
    Exception
  - doWrite
```
protected abstract void doWrite(ChannelOutboundBuffer in)
                         throws Exception
```
    Flush the content of the given buffer to the remote peer.
    
    Throws:
    
    Exception
  - doConnect
```
protected abstract boolean doConnect(SocketAddress remoteAddress,
                                     SocketAddress localAddress)
                              throws Exception
```
    Connect to remote peer.
    
    Parameters:
    
    remoteAddress - the address of the remote peer.
    
    localAddress - the local address of this channel.
    
    Returns:
    
    true if the connect was completed, false if finishConnect() will be called later again to try finishing the connect.
    
    Throws:
    
    Exception - thrown on error.
  - doFinishConnect
```
protected abstract boolean doFinishConnect(R requestedRemoteAddress)
                                    throws Exception
```
    Finish a connect request.
    
    Parameters:
    
    requestedRemoteAddress - the remote address of the peer.
    
    Returns:
    
    true if the connect was completed, false if finishConnect() will be called later again to try finishing the connect.
    
    Throws:
    
    Exception - thrown on error.
  - isConnectPending
```
protected final boolean isConnectPending()
```
    Returns if a connect request was issued before and we are waiting for finishConnect() to be called.
    
    Returns:
    
    true if there is an outstanding connect request.
  - finishConnect
```
protected final void finishConnect()
```
    Should be called once the connect request is ready to be completed.
  - filterOutboundMessage
```
protected Object filterOutboundMessage(Object msg)
                                throws Exception
```
    Invoked when a new message is added to a ChannelOutboundBuffer of this AbstractChannel, so that the Channel implementation converts the message to another. (e.g. heap buffer -> direct buffer)
    
    Throws:
    
    Exception
  - validateFileRegion
```
protected static void validateFileRegion(DefaultFileRegion region,
                                         long position)
                                  throws IOException
```
    Throws:
    
    IOException
  - getOption
```
public final <T> T getOption(ChannelOption<T> option)
```
    Description copied from interface: Channel
    
    Return the value of the given ChannelOption
    
    Specified by:
    
    getOption in interface Channel
    
    Type Parameters:
    
    T - the type of the value.
    
    Parameters:
    
    option - the ChannelOption.
    
    Returns:
    
    the value for the ChannelOption
  - getExtendedOption
```
protected <T> T getExtendedOption(ChannelOption<T> option)
```
    Override to add support for more ChannelOptions. You need to also call {@link super} after handling the extra options.
    
    Type Parameters:
    
    T - the value type.
    
    Parameters:
    
    option - the ChannelOption.
    
    Returns:
    
    the value for the option
    
    Throws:
    
    UnsupportedOperationException - if the ChannelOption is not supported.
  - setOption
```
public final <T> Channel setOption(ChannelOption<T> option,
                                   T value)
```
    Description copied from interface: Channel
    
    Sets a configuration property with the specified name and value.
    
    Specified by:
    
    setOption in interface Channel
    
    Type Parameters:
    
    T - the type of the value.
    
    Parameters:
    
    option - the ChannelOption.
    
    value - the value for the ChannelOption
    
    Returns:
    
    itself.
  - setExtendedOption
```
protected <T> void setExtendedOption(ChannelOption<T> option,
                                     T value)
```
    Override to add support for more ChannelOptions. You need to also call {@link super} after handling the extra options.
    
    Type Parameters:
    
    T - the value type.
    
    Parameters:
    
    option - the ChannelOption.
    
    Throws:
    
    UnsupportedOperationException - if the ChannelOption is not supported.
  - isOptionSupported
```
public final boolean isOptionSupported(ChannelOption<?> option)
```
    Description copied from interface: Channel
    
    Returns true if the given ChannelOption is supported by this Channel implementation. If this methods returns false, calls to Channel.setOption(ChannelOption, Object) and Channel.getOption(ChannelOption) with the ChannelOption will throw an UnsupportedOperationException.
    
    Specified by:
    
    isOptionSupported in interface Channel
    
    Parameters:
    
    option - the option.
    
    Returns:
    
    true if supported, false otherwise.
  - isExtendedOptionSupported
```
protected boolean isExtendedOptionSupported(ChannelOption<?> option)
```
    Override to add support for more ChannelOptions. You need to also call {@link super} after handling the extra options.
    
    Parameters:
    
    option - the ChannelOption.
    
    Returns:
    
    true if supported, false otherwise.
  - newSupportedIdentityOptionsSet
```
protected static Set<ChannelOption<?>> newSupportedIdentityOptionsSet(ChannelOption<?>... options)
```
  - validate
```
protected <T> void validate(ChannelOption<T> option,
                            T value)
```
  - getMaxMessagesPerWrite
```
protected final int getMaxMessagesPerWrite()
```
    Get the maximum number of message to write per eventloop run. Once this limit is reached we will continue to process other events before trying to write the remaining messages.
  - getWriteSpinCount
```
protected final int getWriteSpinCount()
```
  - setBufferAllocator
```
public void setBufferAllocator(BufferAllocator bufferAllocator)
```
  - isAutoRead
```
protected final boolean isAutoRead()
```
  - autoReadCleared
```
protected void autoReadCleared()
```
    Is called once setAutoRead(boolean) is called with false and isAutoRead() was true before.
  - isAllowHalfClosure
```
protected final boolean isAllowHalfClosure()
```
  - runAfterTransportAction
```
protected void runAfterTransportAction()
```

Class AbstractChannel<P extends Channel,​L extends SocketAddress,​R extends SocketAddress>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class io.netty5.util.DefaultAttributeMap

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty5.util.AttributeMap

Methods inherited from interface io.netty5.channel.Channel

Methods inherited from interface io.netty5.channel.ChannelOutboundInvoker

Constructor Detail

AbstractChannel

AbstractChannel

AbstractChannel

Method Detail

validateEventLoopGroup

id

metadata

newChannelPipeline

bufferAllocator

parent

pipeline

executor

localAddress

remoteAddress

cacheAddresses

isRegistered

closeFuture

writableBytes

hashCode

equals

compareTo

toString

readIfIsAutoRead

assertEventLoop

recvBufAllocHandle

fireChannelActiveIfNotActiveBefore

closeTransport

closeForciblyTransport

shutdownTransport

deregisterTransport

writeFlushed

handleWriteError

ensureOpen

safeSetSuccess

safeSetFailure

closeIfClosed

annotateConnectException

prepareToClose

outboundBuffer

localAddress0

remoteAddress0

doBind

doDisconnect

doClose

doShutdown

doBeginRead

doWrite

doConnect

doFinishConnect

isConnectPending

finishConnect

filterOutboundMessage

validateFileRegion

getOption

getExtendedOption

setOption

setExtendedOption

isOptionSupported

isExtendedOptionSupported

newSupportedIdentityOptionsSet

validate

getMaxMessagesPerWrite

getWriteSpinCount

setBufferAllocator

isAutoRead

autoReadCleared

isAllowHalfClosure

runAfterTransportAction

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