Module io.netty5.transport

Package io.netty5.channel.socket.nio

Class NioSocketChannel

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.AbstractNioByteChannel<NioServerSocketChannel,SocketAddress,SocketAddress>

io.netty5.channel.socket.nio.NioSocketChannel

All Implemented Interfaces:

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

public class NioSocketChannel
extends AbstractNioByteChannel<NioServerSocketChannel,SocketAddress,SocketAddress>
implements SocketChannel

SocketChannel which uses NIO selector based implementation.

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
NioSocketChannel(EventLoop eventLoop)	Create a new instance
NioSocketChannel(EventLoop eventLoop, SocketChannel socket)	Create a new instance using the given SocketChannel.
NioSocketChannel(EventLoop eventLoop, SelectorProvider provider)	Create a new instance using the given SelectorProvider.
NioSocketChannel(EventLoop eventLoop, SelectorProvider provider, ProtocolFamily family)	Create a new instance using the given SelectorProvider and protocol family (supported only since JDK 15).
NioSocketChannel(NioServerSocketChannel parent, EventLoop eventLoop, SocketChannel socket)	Create a new instance
NioSocketChannel(NioServerSocketChannel parent, EventLoop eventLoop, SocketChannel socket, ProtocolFamily family)	Create a new instance

Method Summary

Modifier and Type	Method	Description
protected void	doBind(SocketAddress localAddress)	Bind the Channel to the SocketAddress
protected boolean	doConnect(SocketAddress remoteAddress, SocketAddress localAddress, io.netty5.buffer.Buffer data)	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	doReadBytes(io.netty5.buffer.Buffer buffer)	Read bytes into the given Buffer and return the amount.
protected void	doShutdown(ChannelShutdownDirection direction)	Shutdown one direction of the Channel.
protected int	doWriteBytes(io.netty5.buffer.Buffer buf)	Write bytes form the given Buffer to the underlying Channel.
protected long	doWriteFileRegion(FileRegion region)	Write a FileRegion
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 <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 SocketChannel	javaChannel()
protected SocketAddress	localAddress0()	Returns the SocketAddress which is bound locally.
protected io.netty5.util.concurrent.Future<Executor>	prepareToClose()	Prepares to close the Channel.
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.AbstractNioByteChannel

doReadNow, filterOutboundMessage

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

Methods inherited from interface io.netty5.channel.socket.SocketChannel

parent

Constructor Detail

NioSocketChannel

public NioSocketChannel(EventLoop eventLoop)

Create a new instance

NioSocketChannel

public NioSocketChannel(EventLoop eventLoop,
                        SelectorProvider provider)

Create a new instance using the given SelectorProvider.

NioSocketChannel

public NioSocketChannel(EventLoop eventLoop,
                        SelectorProvider provider,
                        ProtocolFamily family)

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

NioSocketChannel

public NioSocketChannel(EventLoop eventLoop,
                        SocketChannel socket)

Create a new instance using the given SocketChannel.

NioSocketChannel

public NioSocketChannel(NioServerSocketChannel parent,
                        EventLoop eventLoop,
                        SocketChannel socket)

Create a new instance

Parameters:

parent - the Channel which created this instance or null if it was created by the user

eventLoop - the EventLoop to use for IO.

socket - the SocketChannel which will be used

NioSocketChannel

public NioSocketChannel(NioServerSocketChannel parent,
                        EventLoop eventLoop,
                        SocketChannel socket,
                        ProtocolFamily family)

Create a new instance

Parameters:

parent - the Channel which created this instance or null if it was created by the user

eventLoop - the EventLoop to use for IO.

socket - the SocketChannel which will be used

family - the ProtocolFamily that was used to create th SocketChannel

Method Detail

javaChannel

protected SocketChannel javaChannel()

Overrides:

javaChannel in class AbstractNioChannel<NioServerSocketChannel,SocketAddress,SocketAddress>

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

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

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

Parameters:

direction - the direction to shut down.

Throws:

Exception - thrown on error.

localAddress0

protected SocketAddress localAddress0()

Description copied from class: AbstractChannel

Returns the SocketAddress which is bound locally.

Specified by:

localAddress0 in class AbstractChannel<NioServerSocketChannel,SocketAddress,SocketAddress>

Returns:

the local address if any, null otherwise.

remoteAddress0

protected SocketAddress remoteAddress0()

Description copied from class: AbstractChannel

Return the SocketAddress which the Channel is connected to.

Specified by:

remoteAddress0 in class AbstractChannel<NioServerSocketChannel,SocketAddress,SocketAddress>

Returns:

the remote address if any, null otherwise.

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

Parameters:

localAddress - the SocketAddress to bound to.

Throws:

Exception - when an error happens.

doConnect

protected boolean doConnect(SocketAddress remoteAddress,
                            SocketAddress localAddress,
                            io.netty5.buffer.Buffer data)
                     throws Exception

Description copied from class: AbstractChannel

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

Specified by:

doConnect in class AbstractChannel<NioServerSocketChannel,SocketAddress,SocketAddress>

Parameters:

remoteAddress - the address of the remote peer.

localAddress - the local address of this channel.

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

Throws:

Exception - thrown on error.

doFinishConnect

protected boolean doFinishConnect(SocketAddress requestedRemoteAddress)
                           throws Exception

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

Throws:

Exception - thrown on error.

doDisconnect

protected void doDisconnect()
                     throws Exception

Description copied from class: AbstractChannel

Disconnect this Channel from its remote peer

Specified by:

doDisconnect in class AbstractChannel<NioServerSocketChannel,SocketAddress,SocketAddress>

Throws:

Exception - thrown on error.

doReadBytes

protected int doReadBytes(io.netty5.buffer.Buffer buffer)
                   throws Exception

Description copied from class: AbstractNioByteChannel

Read bytes into the given Buffer and return the amount.

Specified by:

doReadBytes in class AbstractNioByteChannel<NioServerSocketChannel,SocketAddress,SocketAddress>

Throws:

Exception

doWriteBytes

protected int doWriteBytes(io.netty5.buffer.Buffer buf)
                    throws Exception

Description copied from class: AbstractNioByteChannel

Write bytes form the given Buffer to the underlying Channel.

Specified by:

doWriteBytes in class AbstractNioByteChannel<NioServerSocketChannel,SocketAddress,SocketAddress>

Parameters:

buf - the Buffer from which the bytes should be written

Returns:

amount the amount of written bytes

Throws:

Exception

doWriteFileRegion

protected long doWriteFileRegion(FileRegion region)
                          throws Exception

Description copied from class: AbstractNioByteChannel

Write a FileRegion

Specified by:

doWriteFileRegion in class AbstractNioByteChannel<NioServerSocketChannel,SocketAddress,SocketAddress>

Parameters:

region - the FileRegion from which the bytes should be written

Returns:

amount the amount of written bytes

Throws:

Exception

doWriteNow

protected void doWriteNow(AbstractChannel.WriteSink writeSink)
                   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.

Overrides:

doWriteNow in class AbstractNioByteChannel<NioServerSocketChannel,SocketAddress,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.

Throws:

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

prepareToClose

protected io.netty5.util.concurrent.Future<Executor> prepareToClose()

Description copied from class: AbstractChannel

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 AbstractChannel.doClose() on the returned Executor. If this method returns null, AbstractChannel.doClose() must be called from the caller thread. (i.e. EventLoop)

Overrides:

prepareToClose in class AbstractChannel<NioServerSocketChannel,SocketAddress,SocketAddress>

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

Parameters:

option - the ChannelOption.

Returns:

true if supported, false otherwise.