OioSocketChannel (Netty API Reference (4.1.22.Final))

java.lang.Object
- io.netty.util.DefaultAttributeMap
- - io.netty.channel.AbstractChannel
  - - io.netty.channel.oio.AbstractOioChannel
    - - io.netty.channel.oio.AbstractOioByteChannel
      - io.netty.channel.oio.OioByteStreamChannel
        
        io.netty.channel.socket.oio.OioSocketChannel

All Implemented Interfaces:

Channel ， ChannelOutboundInvoker ， DuplexChannel ， SocketChannel ， AttributeMap ，java.lang.Comparable的< Channel >
```
public class OioSocketChannel
extends OioByteStreamChannel
implements SocketChannel
```
一个使用Old-Blocking-IO的SocketChannel

Nested Class Summary
- 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.oio.AbstractOioChannel
  SO_TIMEOUT

构造方法摘要

构造方法
Constructor and Description
`OioSocketChannel()` 用新的 `Socket`创建一个新实例
`OioSocketChannel(Channel parent, java.net.Socket socket)` 从给定的 `Socket`创建一个新的实例
`OioSocketChannel(java.net.Socket socket)` 从给定的 `Socket`创建一个新实例

方法摘要

所有方法接口方法具体的方法弃用的方法
Modifier and Type	Method and Description
`protected boolean`	`checkInputShutdown()`
`OioSocketChannelConfig`	`config()` 返回此频道的配置。
`protected void`	`doBind(java.net.SocketAddress localAddress)` 将`Channel`绑定到`SocketAddress`
`protected void`	`doClose()` 关闭`Channel`
`protected void`	`doConnect(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress)` 如果指定了localAddress，则使用给定的localAddress连接到远程对等，否则连接到 `null` 。
`protected void`	`doDisconnect()` 断开这`Channel`从它的远程对等
`protected int`	`doReadBytes(ByteBuf buf)` 从底层套接字读取字节。
`protected void`	`doShutdownOutput()` 当条件证明关闭通道的输出部分时调用。
`boolean`	`isActive()` 如果`Channel`处于活动状态且已连接，则返回`true` 。
`boolean`	`isInputShutdown()` 确定此通道的输入端是否已关闭。
`boolean`	`isOpen()` 如果`Channel`已打开并且稍后可能会激活，则返回`true`
`boolean`	`isOutputShutdown()`
`boolean`	`isShutdown()` 确定此通道的输入和输出是否都已关闭。
`java.net.InetSocketAddress`	`localAddress()` 返回此通道绑定的本地地址。
`protected java.net.SocketAddress`	`localAddress0()` 返回本地绑定的 `SocketAddress` 。
`ServerSocketChannel`	`parent()` 返回此频道的父级。
`java.net.InetSocketAddress`	`remoteAddress()` 返回此通道连接到的远程地址。
`protected java.net.SocketAddress`	`remoteAddress0()` 返回`SocketAddress`其中`Channel`被连接到。
`protected void`	`setReadPending(boolean readPending)` 已过时。
`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.oio.OioByteStreamChannel
activate, available, doWriteBytes, doWriteFileRegion

Methods inherited from class io.netty.channel.oio.AbstractOioByteChannel
doRead, doWrite, filterOutboundMessage, metadata

Methods inherited from class io.netty.channel.oio.AbstractOioChannel
clearReadPending, doBeginRead, isCompatible, isReadPending, newUnsafe

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, doDeregister, doRegister, equals, eventLoop, flush, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, newChannelPipeline, newFailedFuture, newId, newProgressivePromise, newPromise, newSucceededFuture, pipeline, read, toString, unsafe, 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, 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

- 构造方法详细信息
  - OioSocketChannel
```
public OioSocketChannel()
```
    用新的 Socket创建一个新实例
  - OioSocketChannel
```
public OioSocketChannel(java.net.Socket socket)
```
    从给定的 Socket创建一个新实例
    
    参数
    
    socket - 此实例使用的 Socket
  - OioSocketChannel
```
public OioSocketChannel(Channel parent,
                        java.net.Socket socket)
```
    从给定的 Socket创建一个新的实例
    
    参数
    
    parent - 用于创建此实例的父级Channel 。如果没有父母，那么它可以为null，因为它是由你自己创建的。
    
    socket - 此实例使用的 Socket
- 方法详细信息
  - parent
```
public ServerSocketChannel parent()
```
    从界面复制的描述： Channel
    
    返回此频道的父级。
    
    Specified by:
    
    parent ，界面 Channel
    
    Specified by:
    
    parent在界面 SocketChannel
    
    重写：
    
    parent ，上课时间 AbstractChannel
    
    结果
    
    父频道。 null如果此频道没有父频道。
  - config
```
public OioSocketChannelConfig config()
```
    从接口复制的描述： Channel
    
    返回此频道的配置。
    
    Specified by:
    
    config在界面 Channel
    
    Specified by:
    
    config ，界面 SocketChannel
  - isOpen
```
public boolean isOpen()
```
    从接口Channel复制的描述
    
    如果Channel已打开并且稍后可能会激活，则返回true
    
    Specified by:
    
    isOpen在界面 Channel
  - isActive
```
public boolean isActive()
```
    从界面复制的描述： Channel
    
    如果Channel处于活动状态且已连接，则返回true 。
    
    Specified by:
    
    isActive在界面 Channel
    
    重写：
    
    isActive ，课时 OioByteStreamChannel
  - isOutputShutdown
```
public boolean isOutputShutdown()
```
    Specified by:
    
    isOutputShutdown在界面 DuplexChannel
    
    另请参见：
    
    Socket.isOutputShutdown()
  - isInputShutdown
```
public boolean isInputShutdown()
```
    从类复制的描述： AbstractOioByteChannel
    
    确定此通道的输入端是否已关闭。
    
    Specified by:
    
    isInputShutdown ，界面 DuplexChannel
    
    Specified by:
    
    isInputShutdown在课堂上 AbstractOioByteChannel
    
    结果
    
    true如果此通道的输入端已关闭。
  - isShutdown
```
public boolean isShutdown()
```
    从界面复制的描述： DuplexChannel
    
    确定此通道的输入和输出是否都已关闭。
    
    Specified by:
    
    isShutdown在界面 DuplexChannel
  - 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()
  - shutdownInput
```
public ChannelFuture shutdownInput()
```
    从类复制的描述： AbstractOioByteChannel
    
    关闭此通道的输入端。
    
    Specified by:
    
    shutdownInput在界面 DuplexChannel
    
    Specified by:
    
    shutdownInput在课堂 AbstractOioByteChannel
    
    结果
    
    将在关机完成时完成的频道未来。
    
    另请参见：
    
    Socket.shutdownInput()
  - shutdown
```
public ChannelFuture shutdown()
```
    从接口DuplexChannel复制的描述
    
    将关闭此通道的输入和输出端。
    
    Specified by:
    
    shutdown ，界面 DuplexChannel
    
    结果
    
    将在两次关机操作完成时完成。
  - doReadBytes
```
protected int doReadBytes(ByteBuf buf)
                   throws java.lang.Exception
```
    从类复制的描述： AbstractOioByteChannel
    
    从底层套接字读取字节。
    
    重写：
    
    doReadBytes在课堂上 OioByteStreamChannel
    
    参数
    
    buf - 写入读取字节的ByteBuf
    
    结果
    
    计算读取的字节数。如果底层Socket被关闭，这可能会返回一个负值
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - shutdownOutput
```
public ChannelFuture shutdownOutput(ChannelPromise promise)
```
    从接口DuplexChannel复制的描述
    
    将关闭输出并通知ChannelPromise 。
    
    Specified by:
    
    shutdownOutput在界面 DuplexChannel
    
    另请参见：
    
    Socket.shutdownOutput()
  - shutdownInput
```
public ChannelFuture shutdownInput(ChannelPromise promise)
```
    从接口DuplexChannel复制的描述
    
    将关闭输入并通知ChannelPromise 。
    
    Specified by:
    
    shutdownInput在界面 DuplexChannel
    
    另请参见：
    
    Socket.shutdownInput()
  - shutdown
```
public ChannelFuture shutdown(ChannelPromise promise)
```
    从界面复制的描述： DuplexChannel
    
    将关闭此通道的输入和输出端。
    
    Specified by:
    
    shutdown在界面 DuplexChannel
    
    参数
    
    promise - 将在两次关机操作完成时完成。
    
    结果
    
    将在两次关机操作完成时完成。
  - 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 。
  - 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 void doConnect(java.net.SocketAddress remoteAddress,
                         java.net.SocketAddress localAddress)
                  throws java.lang.Exception
```
    从类复制的描述： AbstractOioChannel
    
    如果指定了localAddress，则使用给定的localAddress连接到远程对等，否则连接到 null 。
    
    Specified by:
    
    doConnect在课堂上 AbstractOioChannel
    
    异常
    
    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在课堂上 OioByteStreamChannel
    
    异常
    
    java.lang.Exception
  - checkInputShutdown
```
protected boolean checkInputShutdown()
```
  - setReadPending
```
@Deprecated
protected void setReadPending(boolean readPending)
```
    已过时。
    
    重写：
    
    setReadPending在课堂上 AbstractOioChannel

Class OioSocketChannel

Nested Class Summary

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.oio.AbstractOioChannel

构造方法摘要

方法摘要

Methods inherited from class io.netty.channel.oio.OioByteStreamChannel

Methods inherited from class io.netty.channel.oio.AbstractOioByteChannel

Methods inherited from class io.netty.channel.oio.AbstractOioChannel

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

构造方法详细信息

OioSocketChannel

OioSocketChannel

OioSocketChannel

方法详细信息

parent

config

isOpen

isActive

isOutputShutdown

isInputShutdown

isShutdown

doShutdownOutput

shutdownOutput

shutdownInput

shutdown

doReadBytes

shutdownOutput

shutdownInput

shutdown

localAddress

remoteAddress

localAddress0

remoteAddress0

doBind

doConnect

doDisconnect

doClose

checkInputShutdown

setReadPending