KQueueSocketChannel (Netty 4.1.109.Final API文档

java.lang.Object
- io.netty.util.DefaultAttributeMap
- - io.netty.channel.AbstractChannel
  - - io.netty.channel.kqueue.AbstractKQueueStreamChannel
    - - io.netty.channel.kqueue.KQueueSocketChannel

所有已实现的接口:

Channel, ChannelOutboundInvoker, DuplexChannel, SocketChannel, UnixChannel, AttributeMap, java.lang.Comparable<Channel>
```
@UnstableApi
public final class KQueueSocketChannel
extends AbstractKQueueStreamChannel
implements SocketChannel
```

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

字段概要

字段
限定符和类型字段和说明

protected boolean active

字段
限定符和类型	字段和说明
`protected boolean`	`active`

构造器概要

构造器
构造器和说明

KQueueSocketChannel()

KQueueSocketChannel(int fd)

KQueueSocketChannel(InternetProtocolFamily protocol)

构造器
构造器和说明
`KQueueSocketChannel()`
`KQueueSocketChannel(int fd)`
`KQueueSocketChannel(InternetProtocolFamily protocol)`

方法概要

All Methods Static Methods Instance Methods Concrete Methods
限定符和类型	方法和说明
`protected static void`	`checkResolvable(java.net.InetSocketAddress addr)`
`KQueueSocketChannelConfig`	`config()` Returns the configuration of this channel.
`protected void`	`doBeginRead()` Schedule a read operation.
`protected void`	`doBind(java.net.SocketAddress local)` 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 boolean`	`doConnect0(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress)`
`protected void`	`doDeregister()` Deregister the `Channel` from its `EventLoop`.
`protected void`	`doDisconnect()` Disconnect this `Channel` from its remote peer
`protected int`	`doReadBytes(ByteBuf byteBuf)` Read bytes into the given `ByteBuf` and return the amount.
`protected void`	`doRegister()` Is called after the `Channel` is registered with its `EventLoop` as part of the register process.
`protected int`	`doWriteBytes(ChannelOutboundBuffer in, ByteBuf buf)`
`FileDescriptor`	`fd()` Returns the `FileDescriptor` that is used by this `Channel`.
`boolean`	`isActive()` Return `true` if the `Channel` is active and so connected.
`protected boolean`	`isCompatible(EventLoop loop)` Return `true` if the given `EventLoop` is compatible with this instance.
`boolean`	`isOpen()` Returns `true` if the `Channel` is open and may get active later
`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 ByteBuf`	`newDirectBuffer(ByteBuf buf)` Returns an off-heap copy of the specified `ByteBuf`, and releases the original one.
`protected ByteBuf`	`newDirectBuffer(java.lang.Object holder, ByteBuf buf)` Returns an off-heap copy of the specified `ByteBuf`, and releases the specified holder.
`protected io.netty.channel.kqueue.AbstractKQueueChannel.AbstractKQueueUnsafe`	`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.

从类继承的方法 io.netty.channel.kqueue.AbstractKQueueStreamChannel
doShutdownOutput, doWrite, doWriteSingle, filterOutboundMessage, isInputShutdown, isOutputShutdown, isShutdown, metadata, shutdown, shutdown, shutdownInput, shutdownInput, shutdownOutput, shutdownOutput

从类继承的方法 io.netty.channel.AbstractChannel
alloc, bind, bind, bytesBeforeUnwritable, bytesBeforeWritable, close, close, closeFuture, compareTo, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, equals, eventLoop, flush, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, maxMessagesPerWrite, newChannelPipeline, newFailedFuture, newId, newProgressivePromise, newPromise, newSucceededFuture, pipeline, read, toString, unsafe, 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.socket.DuplexChannel
isInputShutdown, isOutputShutdown, isShutdown, shutdown, shutdown, shutdownInput, shutdownInput, shutdownOutput, shutdownOutput

从接口继承的方法 io.netty.channel.Channel
alloc, bytesBeforeUnwritable, bytesBeforeWritable, closeFuture, eventLoop, flush, id, isActive, 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

- 字段详细资料
  - active
```
protected volatile boolean active
```
- 构造器详细资料
  - KQueueSocketChannel
```
public KQueueSocketChannel()
```
  - KQueueSocketChannel
```
public KQueueSocketChannel(InternetProtocolFamily protocol)
```
  - KQueueSocketChannel
```
public KQueueSocketChannel(int fd)
```
- 方法详细资料
  - 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.
  - 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.
  - config
```
public KQueueSocketChannelConfig config()
```
    从接口复制的说明: Channel
    
    Returns the configuration of this channel.
    
    指定者:
    
    config 在接口中 Channel
    
    指定者:
    
    config 在接口中 SocketChannel
  - 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.
  - doConnect0
```
protected boolean doConnect0(java.net.SocketAddress remoteAddress,
                             java.net.SocketAddress localAddress)
                      throws java.lang.Exception
```
    抛出:
    
    java.lang.Exception
  - newUnsafe
```
protected io.netty.channel.kqueue.AbstractKQueueChannel.AbstractKQueueUnsafe newUnsafe()
```
    从类复制的说明: AbstractChannel
    
    Create a new AbstractChannel.AbstractUnsafe instance which will be used for the life-time of the Channel
    
    覆盖:
    
    newUnsafe 在类中 AbstractKQueueStreamChannel
  - fd
```
public final FileDescriptor fd()
```
    从接口复制的说明: UnixChannel
    
    Returns the FileDescriptor that is used by this Channel.
    
    指定者:
    
    fd 在接口中 UnixChannel
  - isActive
```
public boolean isActive()
```
    从接口复制的说明: Channel
    
    Return true if the Channel is active and so connected.
    
    指定者:
    
    isActive 在接口中 Channel
  - doClose
```
protected void doClose()
                throws java.lang.Exception
```
    从类复制的说明: AbstractChannel
    
    Close the Channel
    
    指定者:
    
    doClose 在类中 AbstractChannel
    
    抛出:
    
    java.lang.Exception
  - doDisconnect
```
protected void doDisconnect()
                     throws java.lang.Exception
```
    从类复制的说明: AbstractChannel
    
    Disconnect this Channel from its remote peer
    
    指定者:
    
    doDisconnect 在类中 AbstractChannel
    
    抛出:
    
    java.lang.Exception
  - isCompatible
```
protected boolean isCompatible(EventLoop loop)
```
    从类复制的说明: AbstractChannel
    
    Return true if the given EventLoop is compatible with this instance.
    
    指定者:
    
    isCompatible 在类中 AbstractChannel
  - isOpen
```
public boolean isOpen()
```
    从接口复制的说明: Channel
    
    Returns true if the Channel is open and may get active later
    
    指定者:
    
    isOpen 在接口中 Channel
  - doDeregister
```
protected void doDeregister()
                     throws java.lang.Exception
```
    从类复制的说明: AbstractChannel
    
    Deregister the Channel from its EventLoop. Sub-classes may override this method
    
    覆盖:
    
    doDeregister 在类中 AbstractChannel
    
    抛出:
    
    java.lang.Exception
  - doBeginRead
```
protected final void doBeginRead()
                          throws java.lang.Exception
```
    从类复制的说明: AbstractChannel
    
    Schedule a read operation.
    
    指定者:
    
    doBeginRead 在类中 AbstractChannel
    
    抛出:
    
    java.lang.Exception
  - doRegister
```
protected void doRegister()
                   throws java.lang.Exception
```
    从类复制的说明: AbstractChannel
    
    Is called after the Channel is registered with its EventLoop as part of the register process. Sub-classes may override this method
    
    覆盖:
    
    doRegister 在类中 AbstractChannel
    
    抛出:
    
    java.lang.Exception
  - newDirectBuffer
```
protected final ByteBuf newDirectBuffer(ByteBuf buf)
```
    Returns an off-heap copy of the specified ByteBuf, and releases the original one.
  - newDirectBuffer
```
protected final ByteBuf newDirectBuffer(java.lang.Object holder,
                                        ByteBuf buf)
```
    Returns an off-heap copy of the specified ByteBuf, and releases the specified holder. The caller must ensure that the holder releases the original ByteBuf when the holder is released by this method.
  - checkResolvable
```
protected static void checkResolvable(java.net.InetSocketAddress addr)
```
  - doReadBytes
```
protected final int doReadBytes(ByteBuf byteBuf)
                         throws java.lang.Exception
```
    Read bytes into the given ByteBuf and return the amount.
    
    抛出:
    
    java.lang.Exception
  - doWriteBytes
```
protected final int doWriteBytes(ChannelOutboundBuffer in,
                                 ByteBuf buf)
                          throws java.lang.Exception
```
    抛出:
    
    java.lang.Exception
  - doBind
```
protected void doBind(java.net.SocketAddress local)
               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
```
    Connect to the remote peer
    
    抛出:
    
    java.lang.Exception
  - 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

类 KQueueSocketChannel

嵌套类概要

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

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

字段概要

构造器概要

方法概要

从类继承的方法 io.netty.channel.kqueue.AbstractKQueueStreamChannel

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

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

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

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

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

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

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

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

字段详细资料

active

构造器详细资料

KQueueSocketChannel

KQueueSocketChannel

KQueueSocketChannel

方法详细资料

remoteAddress

localAddress

config

parent

doConnect0

newUnsafe

fd

isActive

doClose

doDisconnect

isCompatible

isOpen

doDeregister

doBeginRead

doRegister

newDirectBuffer

newDirectBuffer

checkResolvable

doReadBytes

doWriteBytes

doBind

doConnect

localAddress0

remoteAddress0