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

Field Summary
- Fields inherited from class io.netty5.channel.nio.AbstractNioChannel
  readInterestOp

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`autoReadCleared()`	Is called once `AbstractChannel.setAutoRead(boolean)` is called with `false` and `AbstractChannel.isAutoRead()` was `true` before.
`protected void`	`doBind(SocketAddress localAddress)`	Bind the `Channel` to the `SocketAddress`
`protected boolean`	`doConnect(SocketAddress remoteAddress, SocketAddress localAddress)`	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(Buffer buffer)`	Read bytes into the given `Buffer` and return the amount.
`protected void`	`doShutdown(ChannelShutdownDirection direction)`	Shutdown one direction of the `Channel`.
`protected void`	`doWrite(ChannelOutboundBuffer in)`	Flush the content of the given buffer to the remote peer.
`protected int`	`doWriteBytes(Buffer buf)`	Write bytes form the given `Buffer` to the underlying `Channel`.
`protected long`	`doWriteFileRegion(FileRegion region)`	Write a `FileRegion`
`protected <T> T`	`getExtendedOption(ChannelOption<T> option)`	Override to add support for more `ChannelOption`s.
`boolean`	`isActive()`	Return `true` if the `Channel` is active and so connected.
`protected boolean`	`isExtendedOptionSupported(ChannelOption<?> option)`	Override to add support for more `ChannelOption`s.
`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 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 `ChannelOption`s.

Methods inherited from class io.netty5.channel.nio.AbstractNioByteChannel
clearOpWrite, doWrite0, filterOutboundMessage, incompleteWrite, readNow, setOpWrite

Methods inherited from class io.netty5.channel.nio.AbstractNioChannel
clearReadPending, doBeginRead, doClose, isOpen, isReadPending, newDirectBuffer, newDirectBuffer, removeReadOp, selectionKey, setReadPending, writeFlushed

Methods inherited from class io.netty5.channel.AbstractChannel
annotateConnectException, assertEventLoop, bufferAllocator, cacheAddresses, closeForciblyTransport, closeFuture, closeIfClosed, closeTransport, compareTo, deregisterTransport, ensureOpen, equals, executor, finishConnect, fireChannelActiveIfNotActiveBefore, getMaxMessagesPerWrite, getOption, getWriteSpinCount, handleWriteError, hashCode, id, isAllowHalfClosure, isAutoRead, isConnectPending, isOptionSupported, isRegistered, localAddress, metadata, newChannelPipeline, newSupportedIdentityOptionsSet, outboundBuffer, parent, pipeline, readIfIsAutoRead, recvBufAllocHandle, remoteAddress, runAfterTransportAction, safeSetFailure, safeSetSuccess, setBufferAllocator, setOption, shutdownTransport, toString, validate, validateEventLoopGroup, validateFileRegion, writableBytes

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, metadata, pipeline, 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 shutdown.
    
    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>
  - 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>
  - 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>
    
    Throws:
    
    Exception
  - doConnect
```
protected boolean doConnect(SocketAddress remoteAddress,
                            SocketAddress localAddress)
                     throws Exception
```
    Description copied from class: AbstractChannel
    
    Connect to remote peer.
    
    Specified by:
    
    doConnect in class AbstractChannel<NioServerSocketChannel,SocketAddress,SocketAddress>
    
    Parameters:
    
    remoteAddress - the address of the remote peer.
    
    localAddress - the local address of this channel.
    
    Returns:
    
    true if the connect was completed, false if AbstractChannel.finishConnect() will be called later again to try finishing the connect.
    
    Throws:
    
    Exception - thrown on error.
  - doFinishConnect
```
protected boolean doFinishConnect(SocketAddress requestedRemoteAddress)
                           throws Exception
```
    Description copied from class: AbstractChannel
    
    Finish a connect request.
    
    Specified by:
    
    doFinishConnect in class AbstractChannel<NioServerSocketChannel,SocketAddress,SocketAddress>
    
    Parameters:
    
    requestedRemoteAddress - the remote address of the peer.
    
    Returns:
    
    true if the connect was completed, false if AbstractChannel.finishConnect() will be called later again to try finishing the connect.
    
    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
  - doReadBytes
```
protected int doReadBytes(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(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
  - doWrite
```
protected void doWrite(ChannelOutboundBuffer in)
                throws Exception
```
    Description copied from class: AbstractChannel
    
    Flush the content of the given buffer to the remote peer.
    
    Overrides:
    
    doWrite in class AbstractNioByteChannel<NioServerSocketChannel,SocketAddress,SocketAddress>
    
    Throws:
    
    Exception
  - prepareToClose
```
protected 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 {@link 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 {@link super} after handling the extra options.
    
    Overrides:
    
    isExtendedOptionSupported in class AbstractChannel<NioServerSocketChannel,SocketAddress,SocketAddress>
    
    Parameters:
    
    option - the ChannelOption.
    
    Returns:
    
    true if supported, false otherwise.
  - autoReadCleared
```
protected void autoReadCleared()
```
    Description copied from class: AbstractChannel
    
    Is called once AbstractChannel.setAutoRead(boolean) is called with false and AbstractChannel.isAutoRead() was true before.
    
    Overrides:
    
    autoReadCleared in class AbstractChannel<NioServerSocketChannel,SocketAddress,SocketAddress>

Class NioSocketChannel

Available options

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class io.netty5.channel.AbstractChannel

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

Methods inherited from interface java.lang.Comparable

Methods inherited from interface io.netty5.channel.IoHandle

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

Constructor Detail

NioSocketChannel

NioSocketChannel

NioSocketChannel

NioSocketChannel

NioSocketChannel

NioSocketChannel

Method Detail

javaChannel

isActive

isShutdown

doShutdown

localAddress0

remoteAddress0

doBind

doConnect

doFinishConnect

doDisconnect

doReadBytes

doWriteBytes

doWriteFileRegion

doWrite

prepareToClose

getExtendedOption

setExtendedOption

isExtendedOptionSupported

autoReadCleared