EpollServerSocketChannel (Netty 4.0.56.Final API文档

java.lang.Object
- io.netty.util.DefaultAttributeMap
- - io.netty.channel.AbstractChannel
  - - io.netty.channel.epoll.AbstractEpollServerChannel
    - - io.netty.channel.epoll.EpollServerSocketChannel

所有已实现的接口:

Channel, ServerChannel, ServerSocketChannel, UnixChannel, AttributeMap, java.lang.Comparable<Channel>
```
public final class EpollServerSocketChannel
extends AbstractEpollServerChannel
implements ServerSocketChannel
```
ServerSocketChannel implementation that uses linux EPOLL Edge-Triggered Mode for maximal performance.

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

字段概要

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

protected boolean active

protected int flags

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

构造器概要

构造器
构造器和说明
`EpollServerSocketChannel()`
`EpollServerSocketChannel(FileDescriptor fd)` 已过时。 Use `EpollServerSocketChannel(Socket, boolean)`. Creates a new `EpollServerSocketChannel` from an existing `FileDescriptor`.
`EpollServerSocketChannel(Socket fd)` 已过时。 Use `EpollServerSocketChannel(Socket, boolean)`. Creates a new `EpollServerSocketChannel` from an existing `Socket`.
`EpollServerSocketChannel(Socket fd, boolean active)`

方法概要

方法
限定符和类型	方法和说明
`protected static void`	`checkResolvable(java.net.InetSocketAddress addr)`
`EpollServerSocketChannelConfig`	`config()` Returns the configuration of this channel.
`protected void`	`doBeginRead()` Schedule a read operation.
`protected void`	`doBind(java.net.SocketAddress localAddress)` Bind the `Channel` to the `SocketAddress`
`protected void`	`doClose()` Close the `Channel`
`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(ByteBuf buf, int writeSpinCount)`
`Socket`	`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.
`ChannelMetadata`	`metadata()` Return the `ChannelMetadata` of the `Channel` which describe the nature of the `Channel`.
`protected Channel`	`newChildChannel(int fd, byte[] address, int offset, int len)`
`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.
`java.net.InetSocketAddress`	`remoteAddress()` Returns the remote address where this channel is connected to.

从类继承的方法 io.netty.channel.epoll.AbstractEpollServerChannel
doConnect, doWrite, filterOutboundMessage, newUnsafe, remoteAddress0

从类继承的方法 io.netty.channel.AbstractChannel
alloc, bind, bind, close, close, closeFuture, compareTo, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, doShutdownOutput, equals, eventLoop, flush, hashCode, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, newChannelPipeline, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, parent, 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, isActive, isOpen, isRegistered, isWritable, metadata, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, unsafe, voidPromise, write, write, writeAndFlush, writeAndFlush

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

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

- 字段详细资料
  - flags
```
protected int flags
```
  - active
```
protected volatile boolean active
```
- 构造器详细资料
  - EpollServerSocketChannel
```
public EpollServerSocketChannel()
```
  - EpollServerSocketChannel
```
@Deprecated
public EpollServerSocketChannel(FileDescriptor fd)
```
    已过时。 Use EpollServerSocketChannel(Socket, boolean). Creates a new EpollServerSocketChannel from an existing FileDescriptor.
  - EpollServerSocketChannel
```
@Deprecated
public EpollServerSocketChannel(Socket fd)
```
    已过时。 Use EpollServerSocketChannel(Socket, boolean). Creates a new EpollServerSocketChannel from an existing Socket.
  - EpollServerSocketChannel
```
public EpollServerSocketChannel(Socket fd,
                        boolean active)
```
- 方法详细资料
  - isCompatible
```
protected boolean isCompatible(EventLoop loop)
```
    从类复制的说明: AbstractChannel
    
    Return true if the given EventLoop is compatible with this instance.
    
    覆盖:
    
    isCompatible 在类中 AbstractEpollServerChannel
  - doBind
```
protected void doBind(java.net.SocketAddress localAddress)
               throws java.lang.Exception
```
    从类复制的说明: AbstractChannel
    
    Bind the Channel to the SocketAddress
    
    抛出:
    
    java.lang.Exception
  - 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 在接口中 ServerSocketChannel
    
    覆盖:
    
    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 在接口中 ServerSocketChannel
    
    覆盖:
    
    localAddress 在类中 AbstractChannel
    
    返回:
    the local address of this channel. null if this channel is not bound.
  - config
```
public EpollServerSocketChannelConfig config()
```
    从接口复制的说明: Channel
    
    Returns the configuration of this channel.
    
    指定者:
    
    config 在接口中 Channel
    
    指定者:
    
    config 在接口中 ServerSocketChannel
  - newChildChannel
```
protected Channel newChildChannel(int fd,
                      byte[] address,
                      int offset,
                      int len)
                           throws java.lang.Exception
```
    抛出:
    
    java.lang.Exception
  - fd
```
public final Socket 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
  - metadata
```
public ChannelMetadata metadata()
```
    从接口复制的说明: Channel
    
    Return the ChannelMetadata of the Channel which describe the nature of the Channel.
    
    指定者:
    
    metadata 在接口中 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
  - 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 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(ByteBuf buf,
               int writeSpinCount)
                          throws java.lang.Exception
```
    抛出:
    
    java.lang.Exception
  - localAddress0
```
protected java.net.SocketAddress localAddress0()
```
    从类复制的说明: AbstractChannel
    
    Returns the SocketAddress which is bound locally.
    
    指定者:
    
    localAddress0 在类中 AbstractChannel

类 EpollServerSocketChannel

嵌套类概要

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

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

字段概要

构造器概要

方法概要

从类继承的方法 io.netty.channel.epoll.AbstractEpollServerChannel

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

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

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

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

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

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

字段详细资料

flags

active

构造器详细资料

EpollServerSocketChannel

EpollServerSocketChannel

EpollServerSocketChannel

EpollServerSocketChannel

方法详细资料

isCompatible

doBind

remoteAddress

localAddress

config

newChildChannel

fd

isActive

metadata

doClose

doDisconnect

isOpen

doDeregister

doBeginRead

doRegister

newDirectBuffer

newDirectBuffer

checkResolvable

doReadBytes

doWriteBytes

localAddress0