Module io.netty5.transport

Package io.netty5.channel.socket.nio

Class NioServerSocketChannel

java.lang.Object

io.netty5.util.DefaultAttributeMap

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

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

io.netty5.channel.nio.AbstractNioMessageChannel<Channel,SocketAddress,SocketAddress>

io.netty5.channel.socket.nio.NioServerSocketChannel

All Implemented Interfaces:

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

public class NioServerSocketChannel
extends AbstractNioMessageChannel<Channel,SocketAddress,SocketAddress>
implements ServerSocketChannel

A ServerSocketChannel implementation which uses NIO selector based implementation to accept new connections.

Available options

In addition to the options provided by SocketChannel, NioSocketChannel allows the following options in the option map:

ChannelOption	INET	INET6	{@code UNIX
{@link NioChannelOption}	X	X	X

Nested Class Summary

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

AbstractChannel.DefaultAbstractChannelPipeline, AbstractChannel.ReadSink, AbstractChannel.WriteSink

Constructor Summary

Constructors

Constructor	Description
NioServerSocketChannel(EventLoop eventLoop, EventLoopGroup childEventLoopGroup)	Create a new instance
NioServerSocketChannel(EventLoop eventLoop, EventLoopGroup childEventLoopGroup, ServerSocketChannel channel)	Create a new instance using the given ServerSocketChannel.
NioServerSocketChannel(EventLoop eventLoop, EventLoopGroup childEventLoopGroup, ServerSocketChannel channel, ProtocolFamily family)	Create a new instance using the given ServerSocketChannel.
NioServerSocketChannel(EventLoop eventLoop, EventLoopGroup childEventLoopGroup, SelectorProvider provider)	Create a new instance using the given SelectorProvider.
NioServerSocketChannel(EventLoop eventLoop, EventLoopGroup childEventLoopGroup, SelectorProvider provider, ProtocolFamily protocolFamily)	Create a new instance using the given SelectorProvider and protocol family (supported only since JDK 15).

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 void	doBind(SocketAddress localAddress)	Bind the Channel to the SocketAddress
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(SocketAddress requestedRemoteAddress)	Finish a connect request.
protected int	doReadMessages(AbstractChannel.ReadSink readSink)	Read messages into the given array and return the amount which was read.
protected void	doShutdown(ChannelShutdownDirection direction)	Shutdown one direction of the Channel.
protected void	doWriteNow(AbstractChannel.WriteSink writeHandle)	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.
protected <T> T	getExtendedOption(ChannelOption<T> option)	Override to add support for more ChannelOptions.
boolean	isActive()	Return true if the Channel is active and so connected.
protected boolean	isExtendedOptionSupported(ChannelOption<?> option)	Override to add support for more ChannelOptions.
boolean	isShutdown(ChannelShutdownDirection direction)	Returns true if the ChannelShutdownDirection of the Channel was shutdown before.
protected ServerSocketChannel	javaChannel()
protected SocketAddress	localAddress0()	Returns the SocketAddress which is bound locally.
protected SocketAddress	remoteAddress0()	Return the SocketAddress which the Channel is connected to.
protected <T> void	setExtendedOption(ChannelOption<T> option, T value)	Override to add support for more ChannelOptions.

Methods inherited from class io.netty5.channel.nio.AbstractNioMessageChannel

doReadNow

Methods inherited from class io.netty5.channel.nio.AbstractNioChannel

doClearScheduledRead, doClose, doRead, isOpen, isWriteFlushedScheduled, newDirectBuffer, newDirectBuffer, selectionKey, writeLoopComplete

Methods inherited from class io.netty5.channel.AbstractChannel

bufferAllocator, cacheAddresses, closeFuture, closeTransport, compareTo, equals, executor, finishConnect, getOption, hashCode, id, isConnectPending, isOptionSupported, isReadPending, isRegistered, isSupportingDisconnect, localAddress, newChannelPipeline, newSupportedIdentityOptionsSet, parent, pipeline, prepareToClose, readBufferAllocator, readHandle, readIfIsAutoRead, readLoopComplete, readNow, remoteAddress, 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, bufferAllocator, close, closeFuture, connect, connect, deregister, disconnect, executor, flush, getOption, id, 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

NioServerSocketChannel

public NioServerSocketChannel(EventLoop eventLoop,
                              EventLoopGroup childEventLoopGroup)

Create a new instance

NioServerSocketChannel

public NioServerSocketChannel(EventLoop eventLoop,
                              EventLoopGroup childEventLoopGroup,
                              SelectorProvider provider)

Create a new instance using the given SelectorProvider.

NioServerSocketChannel

public NioServerSocketChannel(EventLoop eventLoop,
                              EventLoopGroup childEventLoopGroup,
                              SelectorProvider provider,
                              ProtocolFamily protocolFamily)

Create a new instance using the given SelectorProvider and protocol family (supported only since JDK 15).

NioServerSocketChannel

public NioServerSocketChannel(EventLoop eventLoop,
                              EventLoopGroup childEventLoopGroup,
                              ServerSocketChannel channel)

Create a new instance using the given ServerSocketChannel.

NioServerSocketChannel

public NioServerSocketChannel(EventLoop eventLoop,
                              EventLoopGroup childEventLoopGroup,
                              ServerSocketChannel channel,
                              ProtocolFamily family)

Create a new instance using the given ServerSocketChannel.

Method Detail

childEventLoopGroup

public 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

isActive

public boolean isActive()

Description copied from interface: Channel

Return true if the Channel is active and so connected.

Specified by:

isActive in interface Channel

getExtendedOption

protected <T> T getExtendedOption(ChannelOption<T> option)

Description copied from class: AbstractChannel

Override to add support for more ChannelOptions. You need to also call {@link super} after handling the extra options.

Overrides:

getExtendedOption in class AbstractChannel<Channel,SocketAddress,SocketAddress>

Type Parameters:

T - the value type.

Parameters:

option - the ChannelOption.

Returns:

the value for the option.

setExtendedOption

protected <T> void setExtendedOption(ChannelOption<T> option,
                                     T value)

Description copied from class: AbstractChannel

Override to add support for more ChannelOptions. You need to also call super after handling the extra options.

Overrides:

setExtendedOption in class AbstractChannel<Channel,SocketAddress,SocketAddress>

Type Parameters:

T - the value type.

Parameters:

option - the ChannelOption.

isExtendedOptionSupported

protected boolean isExtendedOptionSupported(ChannelOption<?> option)

Description copied from class: AbstractChannel

Override to add support for more ChannelOptions. You need to also call super after handling the extra options.

Overrides:

isExtendedOptionSupported in class AbstractChannel<Channel,SocketAddress,SocketAddress>

Parameters:

option - the ChannelOption.

Returns:

true if supported, false otherwise.

javaChannel

protected ServerSocketChannel javaChannel()

Overrides:

javaChannel in class AbstractNioChannel<Channel,SocketAddress,SocketAddress>

localAddress0

protected SocketAddress localAddress0()

Description copied from class: AbstractChannel

Returns the SocketAddress which is bound locally.

Specified by:

localAddress0 in class AbstractChannel<Channel,SocketAddress,SocketAddress>

Returns:

the local address if any, null otherwise.

doShutdown

protected void doShutdown(ChannelShutdownDirection direction)
                   throws Exception

Description copied from class: AbstractChannel

Shutdown one direction of the Channel.

Specified by:

doShutdown in class AbstractChannel<Channel,SocketAddress,SocketAddress>

Parameters:

direction - the direction to shut down.

Throws:

Exception - thrown on error.

isShutdown

public 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

doBind

protected void doBind(SocketAddress localAddress)
               throws Exception

Description copied from class: AbstractChannel

Bind the Channel to the SocketAddress

Specified by:

doBind in class AbstractChannel<Channel,SocketAddress,SocketAddress>

Parameters:

localAddress - the SocketAddress to bound to.

Throws:

Exception - when an error happens.

doReadMessages

protected int doReadMessages(AbstractChannel.ReadSink readSink)
                      throws Exception

Description copied from class: AbstractNioMessageChannel

Read messages into the given array and return the amount which was read.

Specified by:

doReadMessages in class AbstractNioMessageChannel<Channel,SocketAddress,SocketAddress>

Throws:

Exception

doConnect

protected 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<Channel,SocketAddress,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 boolean doFinishConnect(SocketAddress 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<Channel,SocketAddress,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.

remoteAddress0

protected SocketAddress remoteAddress0()

Description copied from class: AbstractChannel

Return the SocketAddress which the Channel is connected to.

Specified by:

remoteAddress0 in class AbstractChannel<Channel,SocketAddress,SocketAddress>

Returns:

the remote address if any, null otherwise.

doDisconnect

protected void doDisconnect()

Description copied from class: AbstractChannel

Disconnect this Channel from its remote peer

Specified by:

doDisconnect in class AbstractChannel<Channel,SocketAddress,SocketAddress>

doWriteNow

protected void doWriteNow(AbstractChannel.WriteSink writeHandle)
                   throws Exception

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<Channel,SocketAddress,SocketAddress>

Parameters:

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

Throws:

Exception - if an error happened during writing. This will also terminate the write loop.

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<Channel,SocketAddress,SocketAddress>

Parameters:

msg - the message to filter / convert.