NioSocketChannel (Netty API Reference (4.1.22.Final))

java.lang.Object
- io.netty.util.DefaultAttributeMap
- - io.netty.channel.AbstractChannel
  - - io.netty.channel.nio.AbstractNioChannel
    - - io.netty.channel.nio.AbstractNioByteChannel
      - io.netty.channel.socket.nio.NioSocketChannel

All Implemented Interfaces:

Channel ， ChannelOutboundInvoker ， DuplexChannel ， SocketChannel ， AttributeMap ，java.lang.Comparable的< Channel >
```
public class NioSocketChannel
extends AbstractNioByteChannel
implements SocketChannel
```
SocketChannel它使用基于NIO选择器的实现。

Nested Class Summary
- Nested classes/interfaces inherited from class io.netty.channel.nio.AbstractNioByteChannel
  AbstractNioByteChannel.NioByteUnsafe
- Nested classes/interfaces inherited from class io.netty.channel.nio.AbstractNioChannel
  AbstractNioChannel.AbstractNioUnsafe, AbstractNioChannel.NioUnsafe
- Nested classes/interfaces inherited from class io.netty.channel.AbstractChannel
  AbstractChannel.AbstractUnsafe
- Nested classes/interfaces inherited from interface io.netty.channel.Channel
  Channel.Unsafe

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

构造方法摘要

构造方法
Constructor and Description
`NioSocketChannel()` 创建一个新的实例
`NioSocketChannel(Channel parent, java.nio.channels.SocketChannel socket)` 创建一个新的实例
`NioSocketChannel(java.nio.channels.spi.SelectorProvider provider)` 使用给定的 `SelectorProvider`创建一个新实例。
`NioSocketChannel(java.nio.channels.SocketChannel socket)` 使用给定的 `SocketChannel`创建一个新实例。

方法摘要

所有方法接口方法具体的方法
Modifier and Type	Method and Description
`SocketChannelConfig`	`config()` 返回此频道的配置。
`protected void`	`doBind(java.net.SocketAddress localAddress)` 将`Channel`绑定到`SocketAddress`
`protected void`	`doClose()` 关闭`Channel`
`protected boolean`	`doConnect(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress)` 连接到远程对等
`protected void`	`doDisconnect()` 将此`Channel`从其远程对等方断开
`protected void`	`doFinishConnect()` 完成连接
`protected int`	`doReadBytes(ByteBuf byteBuf)` 将字节读入给定的`ByteBuf`并返回金额。
`protected void`	`doShutdownOutput()` 当条件证明关闭通道的输出部分时调用。
`protected void`	`doWrite(ChannelOutboundBuffer in)` 将给定缓冲区的内容刷新到远程对等体。
`protected int`	`doWriteBytes(ByteBuf buf)` 写字节形成给定的`ByteBuf`到底层的`Channel` 。
`protected long`	`doWriteFileRegion(FileRegion region)` 写一个`FileRegion`
`boolean`	`isActive()` 如果`Channel`处于活动状态且已连接，则返回`true` 。
`boolean`	`isInputShutdown()` 返回 `true`当且仅当远程节点关闭其输出以便从此通道接收不到更多数据时。
`protected boolean`	`isInputShutdown0()`
`boolean`	`isOutputShutdown()`
`boolean`	`isShutdown()` 确定此通道的输入和输出是否都已关闭。
`protected java.nio.channels.SocketChannel`	`javaChannel()`
`java.net.InetSocketAddress`	`localAddress()` 返回此通道绑定的本地地址。
`protected java.net.SocketAddress`	`localAddress0()` 返回本地绑定的 `SocketAddress` 。
`protected AbstractNioChannel.AbstractNioUnsafe`	`newUnsafe()` 创建一个新的`AbstractChannel.AbstractUnsafe`实例，该实例将用于`Channel`的生命周期
`ServerSocketChannel`	`parent()` 返回此频道的父级。
`java.net.InetSocketAddress`	`remoteAddress()` 返回此通道连接到的远程地址。
`protected java.net.SocketAddress`	`remoteAddress0()` 返回`SocketAddress`其中`Channel`被连接到。
`ChannelFuture`	`shutdown()` 将关闭此通道的输入和输出端。
`ChannelFuture`	`shutdown(ChannelPromise promise)` 将关闭此通道的输入和输出端。
`ChannelFuture`	`shutdownInput()` 关闭通道的输入端。
`ChannelFuture`	`shutdownInput(ChannelPromise promise)` 将关闭输入并通知`ChannelPromise` 。
`ChannelFuture`	`shutdownOutput()`
`ChannelFuture`	`shutdownOutput(ChannelPromise promise)` 将关闭输出并通知`ChannelPromise` 。

Methods inherited from class io.netty.channel.nio.AbstractNioByteChannel
clearOpWrite, doWrite0, filterOutboundMessage, incompleteWrite, metadata, setOpWrite

Methods inherited from class io.netty.channel.nio.AbstractNioChannel
clearReadPending, doBeginRead, doDeregister, doRegister, eventLoop, isCompatible, isOpen, isReadPending, newDirectBuffer, newDirectBuffer, selectionKey, setReadPending, unsafe

Methods inherited from class io.netty.channel.AbstractChannel
alloc, bind, bind, bytesBeforeUnwritable, bytesBeforeWritable, close, close, closeFuture, compareTo, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, equals, flush, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, newChannelPipeline, newFailedFuture, newId, newProgressivePromise, newPromise, newSucceededFuture, pipeline, read, toString, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from class io.netty.util.DefaultAttributeMap
attr, hasAttr

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.netty.channel.Channel
alloc, bytesBeforeUnwritable, bytesBeforeWritable, closeFuture, eventLoop, flush, id, isOpen, isRegistered, isWritable, metadata, pipeline, read, unsafe

Methods inherited from interface io.netty.util.AttributeMap
attr, hasAttr

Methods inherited from interface io.netty.channel.ChannelOutboundInvoker
bind, bind, close, close, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from interface java.lang.Comparable
compareTo

- 构造方法详细信息
  - NioSocketChannel
```
public NioSocketChannel()
```
    创建一个新的实例
  - NioSocketChannel
```
public NioSocketChannel(java.nio.channels.spi.SelectorProvider provider)
```
    使用给定的 SelectorProvider创建一个新实例。
  - NioSocketChannel
```
public NioSocketChannel(java.nio.channels.SocketChannel socket)
```
    使用给定的 SocketChannel创建一个新实例。
  - NioSocketChannel
```
public NioSocketChannel(Channel parent,
                        java.nio.channels.SocketChannel socket)
```
    创建一个新的实例
    
    参数
    
    parent -在Channel这创造了这个实例或null ，如果它是由用户创建
    
    socket - 将使用 SocketChannel
- 方法详细信息
  - parent
```
public ServerSocketChannel parent()
```
    从接口复制的描述： Channel
    
    返回此频道的父级。
    
    Specified by:
    
    parent在界面 Channel
    
    Specified by:
    
    parent在界面 SocketChannel
    
    重写：
    
    parent在课堂上 AbstractChannel
    
    结果
    
    父频道。 null如果此频道没有父频道。
  - config
```
public SocketChannelConfig config()
```
    从接口复制的描述： Channel
    
    返回此频道的配置。
    
    Specified by:
    
    config在界面 Channel
    
    Specified by:
    
    config在界面 SocketChannel
  - javaChannel
```
protected java.nio.channels.SocketChannel javaChannel()
```
    重写：
    
    javaChannel在课堂上 AbstractNioChannel
  - isActive
```
public boolean isActive()
```
    从接口Channel复制的描述
    
    如果Channel处于活动状态并已连接，则返回true 。
    
    Specified by:
    
    isActive在界面 Channel
  - isOutputShutdown
```
public boolean isOutputShutdown()
```
    Specified by:
    
    isOutputShutdown在界面 DuplexChannel
    
    另请参见：
    
    Socket.isOutputShutdown()
  - isInputShutdown
```
public boolean isInputShutdown()
```
    从接口复制的描述： DuplexChannel
    
    返回true当且仅当远程节点关闭其输出，以便从此通道接收不到更多数据时。请注意，此方法的语义不同于Socket.shutdownInput()和Socket.isInputShutdown() 。
    
    Specified by:
    
    isInputShutdown在界面 DuplexChannel
  - isShutdown
```
public boolean isShutdown()
```
    从接口DuplexChannel复制的描述
    
    确定此通道的输入和输出是否都已关闭。
    
    Specified by:
    
    isShutdown在界面 DuplexChannel
  - localAddress
```
public java.net.InetSocketAddress localAddress()
```
    从接口Channel复制的描述
    
    返回此通道绑定的本地地址。返回的SocketAddress应该被下推到更具体的类型，例如InetSocketAddress以检索详细信息。
    
    Specified by:
    
    localAddress在界面 Channel
    
    Specified by:
    
    localAddress在界面 SocketChannel
    
    重写：
    
    localAddress在课堂上 AbstractChannel
    
    结果
    
    这个频道的本地地址。 null如果此通道未绑定。
  - remoteAddress
```
public java.net.InetSocketAddress remoteAddress()
```
    从接口Channel复制的描述
    
    返回此通道连接到的远程地址。返回的SocketAddress应该被转换为更具体的类型，例如InetSocketAddress以检索详细信息。
    
    Specified by:
    
    remoteAddress在界面 Channel
    
    Specified by:
    
    remoteAddress在界面 SocketChannel
    
    重写：
    
    remoteAddress在课堂上 AbstractChannel
    
    结果
    
    该频道的远程地址。 null如果此通道未连接。如果此通道未连接，但它可以接收来自任意远程地址的消息（例如DatagramChannel ，请使用DefaultAddressedEnvelope.recipient()来确定接收消息的来源，因为此方法将返回null 。
  - doShutdownOutput
```
@UnstableApi
protected final void doShutdownOutput()
                                            throws java.lang.Exception
```
    从类复制的描述： AbstractChannel
    
    当条件证明关闭通道的输出部分时调用。如果写入操作抛出异常，则可能会发生这种情况。
    
    重写：
    
    doShutdownOutput在课堂上 AbstractChannel
    
    异常
    
    java.lang.Exception
  - shutdownOutput
```
public ChannelFuture shutdownOutput()
```
    Specified by:
    
    shutdownOutput在界面 DuplexChannel
    
    另请参见：
    
    Socket.shutdownOutput()
  - shutdownOutput
```
public ChannelFuture shutdownOutput(ChannelPromise promise)
```
    从界面复制的描述： DuplexChannel
    
    将关闭输出并通知ChannelPromise 。
    
    Specified by:
    
    shutdownOutput在界面 DuplexChannel
    
    另请参见：
    
    Socket.shutdownOutput()
  - shutdownInput
```
public ChannelFuture shutdownInput()
```
    从类复制的描述： AbstractNioByteChannel
    
    关闭通道的输入端。
    
    Specified by:
    
    shutdownInput在界面 DuplexChannel
    
    Specified by:
    
    shutdownInput在课堂上 AbstractNioByteChannel
    
    另请参见：
    
    Socket.shutdownInput()
  - isInputShutdown0
```
protected boolean isInputShutdown0()
```
    重写：
    
    isInputShutdown0在课堂上 AbstractNioByteChannel
  - shutdownInput
```
public ChannelFuture shutdownInput(ChannelPromise promise)
```
    从接口DuplexChannel复制的描述
    
    将关闭输入并通知ChannelPromise 。
    
    Specified by:
    
    shutdownInput ，界面 DuplexChannel
    
    另请参见：
    
    Socket.shutdownInput()
  - shutdown
```
public ChannelFuture shutdown()
```
    从接口DuplexChannel复制的描述
    
    将关闭此通道的输入和输出端。
    
    Specified by:
    
    shutdown在界面 DuplexChannel
    
    结果
    
    将在两次关机操作完成时完成。
  - shutdown
```
public ChannelFuture shutdown(ChannelPromise promise)
```
    从接口复制的描述： DuplexChannel
    
    将关闭此通道的输入和输出端。
    
    Specified by:
    
    shutdown在界面 DuplexChannel
    
    参数
    
    promise - 将在关机操作完成时完成。
    
    结果
    
    将在两次关机操作完成时完成。
  - localAddress0
```
protected java.net.SocketAddress localAddress0()
```
    从类复制的描述： AbstractChannel
    
    返回本地绑定的 SocketAddress 。
    
    Specified by:
    
    localAddress0在课堂上 AbstractChannel
  - remoteAddress0
```
protected java.net.SocketAddress remoteAddress0()
```
    从类复制的描述： AbstractChannel
    
    返回SocketAddress其中Channel被连接到。
    
    Specified by:
    
    remoteAddress0在课堂上 AbstractChannel
  - doBind
```
protected void doBind(java.net.SocketAddress localAddress)
               throws java.lang.Exception
```
    从类复制的描述： AbstractChannel
    
    将Channel绑定到SocketAddress
    
    Specified by:
    
    doBind在类 AbstractChannel
    
    异常
    
    java.lang.Exception
  - doConnect
```
protected boolean doConnect(java.net.SocketAddress remoteAddress,
                            java.net.SocketAddress localAddress)
                     throws java.lang.Exception
```
    从类复制的描述： AbstractNioChannel
    
    连接到远程对等
    
    Specified by:
    
    doConnect在课堂上 AbstractNioChannel
    
    异常
    
    java.lang.Exception
  - doFinishConnect
```
protected void doFinishConnect()
                        throws java.lang.Exception
```
    从类复制的描述： AbstractNioChannel
    
    完成连接
    
    Specified by:
    
    doFinishConnect在课堂 AbstractNioChannel
    
    异常
    
    java.lang.Exception
  - doDisconnect
```
protected void doDisconnect()
                     throws java.lang.Exception
```
    从类复制的描述： AbstractChannel
    
    将此Channel从其远程对等方断开
    
    Specified by:
    
    doDisconnect在课堂上 AbstractChannel
    
    异常
    
    java.lang.Exception
  - doClose
```
protected void doClose()
                throws java.lang.Exception
```
    从类复制的描述： AbstractChannel
    
    关闭Channel
    
    重写：
    
    doClose在课堂 AbstractNioChannel
    
    异常
    
    java.lang.Exception
  - doReadBytes
```
protected int doReadBytes(ByteBuf byteBuf)
                   throws java.lang.Exception
```
    从类复制的描述： AbstractNioByteChannel
    
    将字节读入给定的ByteBuf并返回金额。
    
    Specified by:
    
    doReadBytes在课堂上 AbstractNioByteChannel
    
    异常
    
    java.lang.Exception
  - doWriteBytes
```
protected int doWriteBytes(ByteBuf buf)
                    throws java.lang.Exception
```
    从类复制的描述： AbstractNioByteChannel
    
    将字节从给定的ByteBuf写入底层的Channel 。
    
    Specified by:
    
    doWriteBytes在课堂上 AbstractNioByteChannel
    
    参数
    
    buf - 应写入字节的ByteBuf
    
    结果
    
    计算写入字节的数量
    
    异常
    
    java.lang.Exception
  - doWriteFileRegion
```
protected long doWriteFileRegion(FileRegion region)
                          throws java.lang.Exception
```
    从类复制的描述： AbstractNioByteChannel
    
    写一个FileRegion
    
    Specified by:
    
    doWriteFileRegion在课堂上 AbstractNioByteChannel
    
    参数
    
    region - 应写入字节的FileRegion
    
    结果
    
    计算写入字节的数量
    
    异常
    
    java.lang.Exception
  - doWrite
```
protected void doWrite(ChannelOutboundBuffer in)
                throws java.lang.Exception
```
    从类复制的描述： AbstractChannel
    
    将给定缓冲区的内容刷新到远程对等体。
    
    重写：
    
    doWrite在课堂上 AbstractNioByteChannel
    
    异常
    
    java.lang.Exception
  - newUnsafe
```
protected AbstractNioChannel.AbstractNioUnsafe newUnsafe()
```
    从类复制的描述： AbstractChannel
    
    创建一个新的AbstractChannel.AbstractUnsafe实例，该实例将用于Channel的生命周期
    
    重写：
    
    newUnsafe在课堂上 AbstractNioByteChannel

Class NioSocketChannel

Nested Class Summary

Nested classes/interfaces inherited from class io.netty.channel.nio.AbstractNioByteChannel

Nested classes/interfaces inherited from class io.netty.channel.nio.AbstractNioChannel

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

Nested classes/interfaces inherited from interface io.netty.channel.Channel

Field Summary

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

构造方法摘要

方法摘要

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

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

Methods inherited from class io.netty.channel.AbstractChannel

Methods inherited from class io.netty.util.DefaultAttributeMap

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.channel.Channel

Methods inherited from interface io.netty.util.AttributeMap

Methods inherited from interface io.netty.channel.ChannelOutboundInvoker

Methods inherited from interface java.lang.Comparable

构造方法详细信息

NioSocketChannel

NioSocketChannel

NioSocketChannel

NioSocketChannel

方法详细信息

parent

config

javaChannel

isActive

isOutputShutdown

isInputShutdown

isShutdown

localAddress

remoteAddress

doShutdownOutput

shutdownOutput

shutdownOutput

shutdownInput

isInputShutdown0

shutdownInput

shutdown

shutdown

localAddress0

remoteAddress0

doBind

doConnect

doFinishConnect

doDisconnect

doClose

doReadBytes

doWriteBytes

doWriteFileRegion

doWrite

newUnsafe