NioSocketChannel (Netty 4.1.109.Final API文档

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

所有已实现的接口:

Channel, ChannelOutboundInvoker, DuplexChannel, SocketChannel, AttributeMap, java.lang.Comparable<Channel>
```
public class NioSocketChannel
extends AbstractNioByteChannel
implements SocketChannel
```
SocketChannel which uses NIO selector based implementation.

嵌套类概要
- 从类继承的嵌套类/接口 io.netty.channel.nio.AbstractNioByteChannel
  AbstractNioByteChannel.NioByteUnsafe
- 从类继承的嵌套类/接口 io.netty.channel.nio.AbstractNioChannel
  AbstractNioChannel.AbstractNioUnsafe, AbstractNioChannel.NioUnsafe
- 从类继承的嵌套类/接口 io.netty.channel.AbstractChannel
  AbstractChannel.AbstractUnsafe
- 从接口继承的嵌套类/接口 io.netty.channel.Channel
  Channel.Unsafe

字段概要
- 从类继承的字段 io.netty.channel.nio.AbstractNioChannel
  readInterestOp

构造器概要

构造器
构造器和说明
`NioSocketChannel()` Create a new instance
`NioSocketChannel(Channel parent, java.nio.channels.SocketChannel socket)` Create a new instance
`NioSocketChannel(java.nio.channels.spi.SelectorProvider provider)` Create a new instance using the given `SelectorProvider`.
`NioSocketChannel(java.nio.channels.spi.SelectorProvider provider, InternetProtocolFamily family)` Create a new instance using the given `SelectorProvider` and protocol family (supported only since JDK 15).
`NioSocketChannel(java.nio.channels.SocketChannel socket)` Create a new instance using the given `SocketChannel`.

方法概要

All Methods Instance Methods Concrete Methods
限定符和类型	方法和说明
`SocketChannelConfig`	`config()` Returns the configuration of this channel.
`protected void`	`doBind(java.net.SocketAddress localAddress)` Bind the `Channel` to the `SocketAddress`
`protected void`	`doClose()` Close the `Channel`
`protected boolean`	`doConnect(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress)` Connect to the remote peer
`protected void`	`doDisconnect()` Disconnect this `Channel` from its remote peer
`protected void`	`doFinishConnect()` Finish the connect
`protected int`	`doReadBytes(ByteBuf byteBuf)` Read bytes into the given `ByteBuf` and return the amount.
`protected void`	`doShutdownOutput()` Called when conditions justify shutting down the output portion of the channel.
`protected void`	`doWrite(ChannelOutboundBuffer in)` Flush the content of the given buffer to the remote peer.
`protected int`	`doWriteBytes(ByteBuf buf)` Write bytes form the given `ByteBuf` to the underlying `Channel`.
`protected long`	`doWriteFileRegion(FileRegion region)` Write a `FileRegion`
`boolean`	`isActive()` Return `true` if the `Channel` is active and so connected.
`boolean`	`isInputShutdown()` Returns `true` if and only if the remote peer shut down its output so that no more data is received from this channel.
`protected boolean`	`isInputShutdown0()`
`boolean`	`isOutputShutdown()`
`boolean`	`isShutdown()` Determine if both the input and output of this channel have been shutdown.
`protected java.nio.channels.SocketChannel`	`javaChannel()`
`java.net.InetSocketAddress`	`localAddress()` Returns the local address where this channel is bound to.
`protected java.net.SocketAddress`	`localAddress0()` Returns the `SocketAddress` which is bound locally.
`protected AbstractNioChannel.AbstractNioUnsafe`	`newUnsafe()` Create a new `AbstractChannel.AbstractUnsafe` instance which will be used for the life-time of the `Channel`
`ServerSocketChannel`	`parent()` Returns the parent of this channel.
`java.net.InetSocketAddress`	`remoteAddress()` Returns the remote address where this channel is connected to.
`protected java.net.SocketAddress`	`remoteAddress0()` Return the `SocketAddress` which the `Channel` is connected to.
`ChannelFuture`	`shutdown()` Will shutdown the input and output sides of this channel.
`ChannelFuture`	`shutdown(ChannelPromise promise)` Will shutdown the input and output sides of this channel.
`ChannelFuture`	`shutdownInput()` Shutdown the input side of the channel.
`ChannelFuture`	`shutdownInput(ChannelPromise promise)` Will shutdown the input and notify `ChannelPromise`.
`ChannelFuture`	`shutdownOutput()`
`ChannelFuture`	`shutdownOutput(ChannelPromise promise)` Will shutdown the output and notify `ChannelPromise`.

从类继承的方法 io.netty.channel.nio.AbstractNioByteChannel
clearOpWrite, doWrite0, filterOutboundMessage, incompleteWrite, metadata, setOpWrite

从类继承的方法 io.netty.channel.nio.AbstractNioChannel
clearReadPending, doBeginRead, doDeregister, doRegister, eventLoop, isCompatible, isOpen, isReadPending, newDirectBuffer, newDirectBuffer, selectionKey, setReadPending, unsafe

从类继承的方法 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, maxMessagesPerWrite, newChannelPipeline, newFailedFuture, newId, newProgressivePromise, newPromise, newSucceededFuture, pipeline, read, toString, validateFileRegion, voidPromise, write, write, writeAndFlush, writeAndFlush

从类继承的方法 io.netty.util.DefaultAttributeMap
attr, hasAttr

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

从接口继承的方法 io.netty.channel.Channel
alloc, bytesBeforeUnwritable, bytesBeforeWritable, closeFuture, eventLoop, flush, id, isOpen, isRegistered, isWritable, metadata, pipeline, read, unsafe

从接口继承的方法 io.netty.util.AttributeMap
attr, hasAttr

从接口继承的方法 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

从接口继承的方法 java.lang.Comparable
compareTo

- 构造器详细资料
  - NioSocketChannel
```
public NioSocketChannel()
```
    Create a new instance
  - NioSocketChannel
```
public NioSocketChannel(java.nio.channels.spi.SelectorProvider provider)
```
    Create a new instance using the given SelectorProvider.
  - NioSocketChannel
```
public NioSocketChannel(java.nio.channels.spi.SelectorProvider provider,
                        InternetProtocolFamily family)
```
    Create a new instance using the given SelectorProvider and protocol family (supported only since JDK 15).
  - NioSocketChannel
```
public NioSocketChannel(java.nio.channels.SocketChannel socket)
```
    Create a new instance using the given SocketChannel.
  - NioSocketChannel
```
public NioSocketChannel(Channel parent,
                        java.nio.channels.SocketChannel socket)
```
    Create a new instance
    
    参数:
    
    parent - the Channel which created this instance or null if it was created by the user
    
    socket - the SocketChannel which will be used
- 方法详细资料
  - parent
```
public ServerSocketChannel parent()
```
    从接口复制的说明: Channel
    
    Returns the parent of this channel.
    
    指定者:
    
    parent 在接口中 Channel
    
    指定者:
    
    parent 在接口中 SocketChannel
    
    覆盖:
    
    parent 在类中 AbstractChannel
    
    返回:
    
    the parent channel. null if this channel does not have a parent channel.
  - config
```
public SocketChannelConfig config()
```
    从接口复制的说明: Channel
    
    Returns the configuration of this channel.
    
    指定者:
    
    config 在接口中 Channel
    
    指定者:
    
    config 在接口中 SocketChannel
  - javaChannel
```
protected java.nio.channels.SocketChannel javaChannel()
```
    覆盖:
    
    javaChannel 在类中 AbstractNioChannel
  - isActive
```
public boolean isActive()
```
    从接口复制的说明: Channel
    
    Return true if the Channel is active and so connected.
    
    指定者:
    
    isActive 在接口中 Channel
  - isOutputShutdown
```
public boolean isOutputShutdown()
```
    指定者:
    
    isOutputShutdown 在接口中 DuplexChannel
    
    另请参阅:
    
    Socket.isOutputShutdown()
  - isInputShutdown
```
public boolean isInputShutdown()
```
    从接口复制的说明: DuplexChannel
    
    Returns true if and only if the remote peer shut down its output so that no more data is received from this channel. Note that the semantic of this method is different from that of Socket.shutdownInput() and Socket.isInputShutdown().
    
    指定者:
    
    isInputShutdown 在接口中 DuplexChannel
  - isShutdown
```
public boolean isShutdown()
```
    从接口复制的说明: DuplexChannel
    
    Determine if both the input and output of this channel have been shutdown.
    
    指定者:
    
    isShutdown 在接口中 DuplexChannel
  - localAddress
```
public java.net.InetSocketAddress localAddress()
```
    从接口复制的说明: Channel
    
    Returns the local address where this channel is bound to. The returned SocketAddress is supposed to be down-cast into more concrete type such as InetSocketAddress to retrieve the detailed information.
    
    指定者:
    
    localAddress 在接口中 Channel
    
    指定者:
    
    localAddress 在接口中 SocketChannel
    
    覆盖:
    
    localAddress 在类中 AbstractChannel
    
    返回:
    
    the local address of this channel. null if this channel is not bound.
  - remoteAddress
```
public java.net.InetSocketAddress remoteAddress()
```
    从接口复制的说明: Channel
    
    Returns the remote address where this channel is connected to. The returned SocketAddress is supposed to be down-cast into more concrete type such as InetSocketAddress to retrieve the detailed information.
    
    指定者:
    
    remoteAddress 在接口中 Channel
    
    指定者:
    
    remoteAddress 在接口中 SocketChannel
    
    覆盖:
    
    remoteAddress 在类中 AbstractChannel
    
    返回:
    
    the remote address of this channel. null if this channel is not connected. If this channel is not connected but it can receive messages from arbitrary remote addresses (e.g. DatagramChannel, use DefaultAddressedEnvelope.recipient() to determine the origination of the received message as this method will return null.
  - doShutdownOutput
```
@UnstableApi
protected final void doShutdownOutput()
                                             throws java.lang.Exception
```
    从类复制的说明: AbstractChannel
    
    Called when conditions justify shutting down the output portion of the channel. This may happen if a write operation throws an exception.
    
    覆盖:
    
    doShutdownOutput 在类中 AbstractChannel
    
    抛出:
    
    java.lang.Exception
  - shutdownOutput
```
public ChannelFuture shutdownOutput()
```
    指定者:
    
    shutdownOutput 在接口中 DuplexChannel
    
    另请参阅:
    
    Socket.shutdownOutput()
  - shutdownOutput
```
public ChannelFuture shutdownOutput(ChannelPromise promise)
```
    从接口复制的说明: DuplexChannel
    
    Will shutdown the output and notify ChannelPromise.
    
    指定者:
    
    shutdownOutput 在接口中 DuplexChannel
    
    另请参阅:
    
    Socket.shutdownOutput()
  - shutdownInput
```
public ChannelFuture shutdownInput()
```
    从类复制的说明: AbstractNioByteChannel
    
    Shutdown the input side of the channel.
    
    指定者:
    
    shutdownInput 在接口中 DuplexChannel
    
    指定者:
    
    shutdownInput 在类中 AbstractNioByteChannel
    
    另请参阅:
    
    Socket.shutdownInput()
  - isInputShutdown0
```
protected boolean isInputShutdown0()
```
    覆盖:
    
    isInputShutdown0 在类中 AbstractNioByteChannel
  - shutdownInput
```
public ChannelFuture shutdownInput(ChannelPromise promise)
```
    从接口复制的说明: DuplexChannel
    
    Will shutdown the input and notify ChannelPromise.
    
    指定者:
    
    shutdownInput 在接口中 DuplexChannel
    
    另请参阅:
    
    Socket.shutdownInput()
  - shutdown
```
public ChannelFuture shutdown()
```
    从接口复制的说明: DuplexChannel
    
    Will shutdown the input and output sides of this channel.
    
    指定者:
    
    shutdown 在接口中 DuplexChannel
    
    返回:
    
    will be completed when both shutdown operations complete.
  - shutdown
```
public ChannelFuture shutdown(ChannelPromise promise)
```
    从接口复制的说明: DuplexChannel
    
    Will shutdown the input and output sides of this channel.
    
    指定者:
    
    shutdown 在接口中 DuplexChannel
    
    参数:
    
    promise - will be completed when both shutdown operations complete.
    
    返回:
    
    will be completed when both shutdown operations complete.
  - localAddress0
```
protected java.net.SocketAddress localAddress0()
```
    从类复制的说明: AbstractChannel
    
    Returns the SocketAddress which is bound locally.
    
    指定者:
    
    localAddress0 在类中 AbstractChannel
  - remoteAddress0
```
protected java.net.SocketAddress remoteAddress0()
```
    从类复制的说明: AbstractChannel
    
    Return the SocketAddress which the Channel is connected to.
    
    指定者:
    
    remoteAddress0 在类中 AbstractChannel
  - doBind
```
protected void doBind(java.net.SocketAddress localAddress)
               throws java.lang.Exception
```
    从类复制的说明: AbstractChannel
    
    Bind the Channel to the SocketAddress
    
    指定者:
    
    doBind 在类中 AbstractChannel
    
    抛出:
    
    java.lang.Exception
  - doConnect
```
protected boolean doConnect(java.net.SocketAddress remoteAddress,
                            java.net.SocketAddress localAddress)
                     throws java.lang.Exception
```
    从类复制的说明: AbstractNioChannel
    
    Connect to the remote peer
    
    指定者:
    
    doConnect 在类中 AbstractNioChannel
    
    抛出:
    
    java.lang.Exception
  - doFinishConnect
```
protected void doFinishConnect()
                        throws java.lang.Exception
```
    从类复制的说明: AbstractNioChannel
    
    Finish the connect
    
    指定者:
    
    doFinishConnect 在类中 AbstractNioChannel
    
    抛出:
    
    java.lang.Exception
  - doDisconnect
```
protected void doDisconnect()
                     throws java.lang.Exception
```
    从类复制的说明: AbstractChannel
    
    Disconnect this Channel from its remote peer
    
    指定者:
    
    doDisconnect 在类中 AbstractChannel
    
    抛出:
    
    java.lang.Exception
  - doClose
```
protected void doClose()
                throws java.lang.Exception
```
    从类复制的说明: AbstractChannel
    
    Close the Channel
    
    覆盖:
    
    doClose 在类中 AbstractNioChannel
    
    抛出:
    
    java.lang.Exception
  - doReadBytes
```
protected int doReadBytes(ByteBuf byteBuf)
                   throws java.lang.Exception
```
    从类复制的说明: AbstractNioByteChannel
    
    Read bytes into the given ByteBuf and return the amount.
    
    指定者:
    
    doReadBytes 在类中 AbstractNioByteChannel
    
    抛出:
    
    java.lang.Exception
  - doWriteBytes
```
protected int doWriteBytes(ByteBuf buf)
                    throws java.lang.Exception
```
    从类复制的说明: AbstractNioByteChannel
    
    Write bytes form the given ByteBuf to the underlying Channel.
    
    指定者:
    
    doWriteBytes 在类中 AbstractNioByteChannel
    
    参数:
    
    buf - the ByteBuf from which the bytes should be written
    
    返回:
    
    amount the amount of written bytes
    
    抛出:
    
    java.lang.Exception
  - doWriteFileRegion
```
protected long doWriteFileRegion(FileRegion region)
                          throws java.lang.Exception
```
    从类复制的说明: AbstractNioByteChannel
    
    Write a FileRegion
    
    指定者:
    
    doWriteFileRegion 在类中 AbstractNioByteChannel
    
    参数:
    
    region - the FileRegion from which the bytes should be written
    
    返回:
    
    amount the amount of written bytes
    
    抛出:
    
    java.lang.Exception
  - doWrite
```
protected void doWrite(ChannelOutboundBuffer in)
                throws java.lang.Exception
```
    从类复制的说明: AbstractChannel
    
    Flush the content of the given buffer to the remote peer.
    
    覆盖:
    
    doWrite 在类中 AbstractNioByteChannel
    
    抛出:
    
    java.lang.Exception
  - newUnsafe
```
protected AbstractNioChannel.AbstractNioUnsafe newUnsafe()
```
    从类复制的说明: AbstractChannel
    
    Create a new AbstractChannel.AbstractUnsafe instance which will be used for the life-time of the Channel
    
    覆盖:
    
    newUnsafe 在类中 AbstractNioByteChannel

类 NioSocketChannel

嵌套类概要

从类继承的嵌套类/接口 io.netty.channel.nio.AbstractNioByteChannel

从类继承的嵌套类/接口 io.netty.channel.nio.AbstractNioChannel

从类继承的嵌套类/接口 io.netty.channel.AbstractChannel

从接口继承的嵌套类/接口 io.netty.channel.Channel

字段概要

从类继承的字段 io.netty.channel.nio.AbstractNioChannel

构造器概要

方法概要

从类继承的方法 io.netty.channel.nio.AbstractNioByteChannel

从类继承的方法 io.netty.channel.nio.AbstractNioChannel

从类继承的方法 io.netty.channel.AbstractChannel

从类继承的方法 io.netty.util.DefaultAttributeMap

从类继承的方法 java.lang.Object

从接口继承的方法 io.netty.channel.Channel

从接口继承的方法 io.netty.util.AttributeMap

从接口继承的方法 io.netty.channel.ChannelOutboundInvoker

从接口继承的方法 java.lang.Comparable

构造器详细资料

NioSocketChannel

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