OioSocketChannel (Netty 4.0.56.Final API文档

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

所有已实现的接口:

Channel, DuplexChannel, SocketChannel, AttributeMap, java.lang.Comparable<Channel>
```
public class OioSocketChannel
extends OioByteStreamChannel
implements SocketChannel
```
A SocketChannel which is using Old-Blocking-IO

嵌套类概要
- 从类继承的嵌套类/接口 io.netty.channel.AbstractChannel
  AbstractChannel.AbstractUnsafe
- 从接口继承的嵌套类/接口 io.netty.channel.Channel
  Channel.Unsafe

字段概要
- 从类继承的字段 io.netty.channel.oio.AbstractOioChannel
  SO_TIMEOUT

构造器概要

构造器
构造器和说明
`OioSocketChannel()` Create a new instance with an new `Socket`
`OioSocketChannel(Channel parent, java.net.Socket socket)` Create a new instance from the given `Socket`
`OioSocketChannel(java.net.Socket socket)` Create a new instance from the given `Socket`

方法概要

方法
限定符和类型	方法和说明
`protected boolean`	`checkInputShutdown()` Check if the input was shutdown and if so return `true`.
`OioSocketChannelConfig`	`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 void`	`doConnect(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress)` Connect to the remote peer using the given localAddress if one is specified or `null` otherwise.
`protected void`	`doDisconnect()` Disconnect this `Channel` from its remote peer
`protected int`	`doReadBytes(ByteBuf buf)` Read bytes from the underlying Socket.
`protected void`	`doShutdownOutput()` Called when conditions justify shutting down the output portion of the channel.
`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.
`boolean`	`isOpen()` Returns `true` if the `Channel` is open and may get active later
`boolean`	`isOutputShutdown()`
`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.
`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.
`protected void`	`setReadPending(boolean readPending)`
`ChannelFuture`	`shutdownOutput()`
`ChannelFuture`	`shutdownOutput(ChannelPromise promise)`

从类继承的方法 io.netty.channel.oio.OioByteStreamChannel
activate, available, doWriteBytes, doWriteFileRegion

从类继承的方法 io.netty.channel.oio.AbstractOioByteChannel
doRead, doWrite, filterOutboundMessage, metadata

从类继承的方法 io.netty.channel.oio.AbstractOioChannel
doBeginRead, isCompatible, isReadPending, newUnsafe

从类继承的方法 io.netty.channel.AbstractChannel
alloc, bind, bind, close, close, closeFuture, compareTo, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, doDeregister, doRegister, equals, eventLoop, flush, hashCode, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, newChannelPipeline, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, pipeline, read, toString, unsafe, voidPromise, write, write, writeAndFlush, writeAndFlush

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

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

从接口继承的方法 io.netty.channel.Channel
alloc, bind, bind, close, close, closeFuture, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, eventLoop, flush, isRegistered, isWritable, metadata, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, pipeline, read, unsafe, voidPromise, write, write, writeAndFlush, writeAndFlush

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

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

- 构造器详细资料
  - OioSocketChannel
```
public OioSocketChannel()
```
    Create a new instance with an new Socket
  - OioSocketChannel
```
public OioSocketChannel(java.net.Socket socket)
```
    Create a new instance from the given Socket
    
    参数:
    socket - the Socket which is used by this instance
  - OioSocketChannel
```
public OioSocketChannel(Channel parent,
                java.net.Socket socket)
```
    Create a new instance from the given Socket
    
    参数:
    parent - the parent Channel which was used to create this instance. This can be null if the has no parent as it was created by your self.
    socket - the Socket which is used by this instance
- 方法详细资料
  - 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 OioSocketChannelConfig config()
```
    从接口复制的说明: Channel
    
    Returns the configuration of this channel.
    
    指定者:
    
    config 在接口中 Channel
    
    指定者:
    
    config 在接口中 SocketChannel
  - isOpen
```
public boolean isOpen()
```
    从接口复制的说明: Channel
    
    Returns true if the Channel is open and may get active later
    
    指定者:
    
    isOpen 在接口中 Channel
  - isActive
```
public boolean isActive()
```
    从接口复制的说明: Channel
    
    Return true if the Channel is active and so connected.
    
    指定者:
    
    isActive 在接口中 Channel
    
    覆盖:
    
    isActive 在类中 OioByteStreamChannel
  - 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
    
    覆盖:
    
    isInputShutdown 在类中 AbstractOioByteChannel
  - isOutputShutdown
```
public boolean isOutputShutdown()
```
    指定者:
    
    isOutputShutdown 在接口中 DuplexChannel
    
    另请参阅:
    Socket.isOutputShutdown()
  - 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()
  - doReadBytes
```
protected int doReadBytes(ByteBuf buf)
                   throws java.lang.Exception
```
    从类复制的说明: AbstractOioByteChannel
    
    Read bytes from the underlying Socket.
    
    覆盖:
    
    doReadBytes 在类中 OioByteStreamChannel
    
    参数:
    buf - the ByteBuf into which the read bytes will be written
    
    返回:
    amount the number of bytes read. This may return a negative amount if the underlying Socket was closed
    
    抛出:
    
    java.lang.Exception - is thrown if an error occurred
  - shutdownOutput
```
public ChannelFuture shutdownOutput(ChannelPromise promise)
```
    指定者:
    
    shutdownOutput 在接口中 DuplexChannel
    
    另请参阅:
    Will notify the given {@link ChannelPromise}
  - 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.
  - 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 void doConnect(java.net.SocketAddress remoteAddress,
             java.net.SocketAddress localAddress)
                  throws java.lang.Exception
```
    从类复制的说明: AbstractOioChannel
    
    Connect to the remote peer using the given localAddress if one is specified or null otherwise.
    
    指定者:
    
    doConnect 在类中 AbstractOioChannel
    
    抛出:
    
    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 在类中 OioByteStreamChannel
    
    抛出:
    
    java.lang.Exception
  - checkInputShutdown
```
protected boolean checkInputShutdown()
```
    从类复制的说明: AbstractOioByteChannel
    
    Check if the input was shutdown and if so return true. The default implementation sleeps also for AbstractOioChannel.SO_TIMEOUT milliseconds to simulate some blocking.
    
    覆盖:
    
    checkInputShutdown 在类中 AbstractOioByteChannel
  - setReadPending
```
protected void setReadPending(boolean readPending)
```
    覆盖:
    
    setReadPending 在类中 AbstractOioChannel

类 OioSocketChannel

嵌套类概要

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

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

字段概要

从类继承的字段 io.netty.channel.oio.AbstractOioChannel

构造器概要

方法概要

从类继承的方法 io.netty.channel.oio.OioByteStreamChannel

从类继承的方法 io.netty.channel.oio.AbstractOioByteChannel

从类继承的方法 io.netty.channel.oio.AbstractOioChannel

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

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

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

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

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

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

构造器详细资料

OioSocketChannel

OioSocketChannel

OioSocketChannel

方法详细资料

parent

config

isOpen

isActive

isInputShutdown

isOutputShutdown

doShutdownOutput

shutdownOutput

doReadBytes

shutdownOutput

localAddress

remoteAddress

localAddress0

remoteAddress0

doBind

doConnect

doDisconnect

doClose

checkInputShutdown

setReadPending