Module io.netty5.transport

Package io.netty5.channel

Class AbstractServerChannel<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.AbstractServerChannel<P,L,R>

All Implemented Interfaces:

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

Direct Known Subclasses:

LocalServerChannel

public abstract class AbstractServerChannel<P extends Channel,L extends SocketAddress,R extends SocketAddress>
extends AbstractChannel<P,L,R>
implements ServerChannel

A skeletal ServerChannel implementation.

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	AbstractServerChannel(EventLoop eventLoop, EventLoopGroup childEventLoopGroup, Class<? extends Channel> childChannelType)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
EventLoopGroup	childEventLoopGroup()	Returns the EventLoopGroup that is used to register the child Channels on after accepting these.
protected boolean	doConnect(SocketAddress remoteAddress, SocketAddress localAddress, io.netty5.buffer.Buffer initialData)	Connect to remote peer.
protected void	doDisconnect()	Disconnect this Channel from its remote peer
protected boolean	doFinishConnect(R requestedRemoteAddress)	Finish a connect request.
protected void	doShutdown(ChannelShutdownDirection direction)	Shutdown one direction of the Channel.
protected void	doWriteNow(AbstractChannel.WriteSink writeSink)	Called in a loop when writes should be performed until this method returns false or there are no more messages to write.
protected Object	filterOutboundMessage(Object msg)	Invoked when a new message is added to to the outbound queue of this AbstractChannel, so that the Channel implementation converts the message to another.
boolean	isShutdown(ChannelShutdownDirection direction)	Returns true if the ChannelShutdownDirection of the Channel was shutdown before.
protected R	remoteAddress0()	Return the SocketAddress which the Channel is connected to.

Methods inherited from class io.netty5.channel.AbstractChannel

bufferAllocator, cacheAddresses, closeFuture, closeTransport, compareTo, doBind, doClearScheduledRead, doClose, doRead, doReadNow, equals, executor, finishConnect, getExtendedOption, getOption, hashCode, id, isConnectPending, isExtendedOptionSupported, isOptionSupported, isReadPending, isRegistered, isSupportingDisconnect, isWriteFlushedScheduled, localAddress, localAddress0, newChannelPipeline, newSupportedIdentityOptionsSet, parent, pipeline, prepareToClose, readBufferAllocator, readHandle, readIfIsAutoRead, readLoopComplete, readNow, remoteAddress, setExtendedOption, setOption, shutdownReadSide, toString, validateEventLoopGroup, validateFileRegion, writableBytes, writeFlushed, writeFlushedNow, writeHandle, writeLoopComplete

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, bufferAllocator, close, closeFuture, connect, connect, deregister, disconnect, executor, flush, getOption, id, isActive, isOpen, isOptionSupported, isWritable, localAddress, parent, pipeline, read, read, register, remoteAddress, sendOutboundEvent, setOption, shutdown, writableBytes, write, writeAndFlush

Methods inherited from interface io.netty5.channel.ChannelOutboundInvoker

newFailedFuture, newPromise, newSucceededFuture, newSucceededFuture

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface io.netty5.channel.IoHandle

isRegistered

Constructor Detail

AbstractServerChannel

protected AbstractServerChannel(EventLoop eventLoop,
                                EventLoopGroup childEventLoopGroup,
                                Class<? extends Channel> childChannelType)

Creates a new instance.

Method Detail

childEventLoopGroup

public final EventLoopGroup childEventLoopGroup()

Description copied from interface: ServerChannel

Returns the EventLoopGroup that is used to register the child Channels on after accepting these.

Specified by:

childEventLoopGroup in interface ServerChannel

remoteAddress0

protected final R remoteAddress0()

Description copied from class: AbstractChannel

Return the SocketAddress which the Channel is connected to.

Specified by:

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

Returns:

the remote address if any, null otherwise.

doDisconnect

protected final void doDisconnect()

Description copied from class: AbstractChannel

Disconnect this Channel from its remote peer

Specified by:

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

doShutdown

protected final void doShutdown(ChannelShutdownDirection direction)

Description copied from class: AbstractChannel

Shutdown one direction of the Channel.

Specified by:

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

Parameters:

direction - the direction to shut down.

isShutdown

public final boolean isShutdown(ChannelShutdownDirection direction)

Description copied from interface: Channel

Returns true if the ChannelShutdownDirection of the Channel was shutdown before.

Specified by:

isShutdown in interface Channel

doWriteNow

protected final void doWriteNow(AbstractChannel.WriteSink writeSink)

Description copied from class: AbstractChannel

Called in a loop when writes should be performed until this method returns false or there are no more messages to write. Implementations are responsible for handling partial writes, which for example means that if Buffers are written partial implementations need to ensure the readerOffset is updated accordingly.

Specified by:

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

Parameters:

writeSink - the AbstractChannel.WriteSink that must be completed with the write progress. AbstractChannel.WriteSink.complete(long, long, int, boolean) or AbstractChannel.WriteSink.complete(long, Throwable, boolean) must be called exactly once before this method returns non-exceptional.

filterOutboundMessage

protected final Object filterOutboundMessage(Object msg)

Description copied from class: AbstractChannel

Invoked when a new message is added to to the outbound queue of this AbstractChannel, so that the Channel implementation converts the message to another. (e.g. heap buffer -> direct buffer)

Overrides:

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

Parameters:

msg - the message to filter / convert.

doConnect

protected final boolean doConnect(SocketAddress remoteAddress,
                                  SocketAddress localAddress,
                                  io.netty5.buffer.Buffer initialData)

Description copied from class: AbstractChannel

Connect to remote peer. This method should never be directly called.

Specified by:

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

Parameters:

remoteAddress - the address of the remote peer.

localAddress - the local address of this channel.

initialData - the initial data that is written during connect (if ChannelOption.TCP_FASTOPEN_CONNECT is supported and configured). If data is written care must be taken to update the reader offset.

Returns:

true if the connect operation was completed, false if AbstractChannel.finishConnect() will be called later again to try finish connecting.

doFinishConnect

protected final boolean doFinishConnect(R requestedRemoteAddress)

Description copied from class: AbstractChannel

Finish a connect request. This method should never be directly called, use AbstractChannel.finishConnect() instead.

Specified by:

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

Parameters:

requestedRemoteAddress - the remote address of the peer.

Returns:

true if the connect operations was completed, false if AbstractChannel.finishConnect() will be called later again to try finishing the connect operation.