AbstractEpollStreamChannel (Netty 4.1.109.Final API文档

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

所有已实现的接口:

Channel, ChannelOutboundInvoker, DuplexChannel, UnixChannel, AttributeMap, java.lang.Comparable<Channel>

直接已知子类:

EpollDomainSocketChannel, EpollSocketChannel
```
public abstract class AbstractEpollStreamChannel
extends AbstractChannel
implements DuplexChannel
```

嵌套类概要

嵌套类
限定符和类型类和说明

protected class AbstractEpollStreamChannel.SpliceInTask
- 从类继承的嵌套类/接口 io.netty.channel.AbstractChannel
  AbstractChannel.AbstractUnsafe
- 从接口继承的嵌套类/接口 io.netty.channel.Channel
  Channel.Unsafe

嵌套类
限定符和类型	类和说明
`protected class`	`AbstractEpollStreamChannel.SpliceInTask`

字段概要

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

protected boolean active

protected int flags

protected LinuxSocket socket

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

构造器概要

构造器
限定符	构造器和说明
`protected`	`AbstractEpollStreamChannel(Channel parent, int fd)`
`protected`	`AbstractEpollStreamChannel(Channel parent, LinuxSocket fd, java.net.SocketAddress remote)`
`protected`	`AbstractEpollStreamChannel(int fd)`
`protected`	`AbstractEpollStreamChannel(LinuxSocket fd, boolean active)`

方法概要

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
限定符和类型	方法和说明
`protected static void`	`checkResolvable(java.net.InetSocketAddress addr)`
`abstract EpollChannelConfig`	`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 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 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(ChannelOutboundBuffer in, ByteBuf buf)`
`protected int`	`doWriteSingle(ChannelOutboundBuffer in)` Attempt to write a single object.
`FileDescriptor`	`fd()` Returns the `FileDescriptor` that is used by this `Channel`.
`protected java.lang.Object`	`filterOutboundMessage(java.lang.Object msg)` Invoked when a new message is added to a `ChannelOutboundBuffer` of this `AbstractChannel`, so that the `Channel` implementation converts the message to another.
`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`	`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()`
`boolean`	`isShutdown()` Determine if both the input and output of this channel have been shutdown.
`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 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.epoll.AbstractEpollChannel.AbstractEpollUnsafe`	`newUnsafe()` Create a new `AbstractChannel.AbstractUnsafe` instance which will be used for the life-time of the `Channel`
`protected java.net.SocketAddress`	`remoteAddress0()` Return the `SocketAddress` which the `Channel` is connected to.
`protected void`	`setFlag(int flag)`
`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()`
`ChannelFuture`	`shutdownInput(ChannelPromise promise)` Will shutdown the input and notify `ChannelPromise`.
`ChannelFuture`	`shutdownOutput()`
`ChannelFuture`	`shutdownOutput(ChannelPromise promise)` Will shutdown the output and notify `ChannelPromise`.
`ChannelFuture`	`spliceTo(AbstractEpollStreamChannel ch, int len)` Splice from this `AbstractEpollStreamChannel` to another `AbstractEpollStreamChannel`.
`ChannelFuture`	`spliceTo(AbstractEpollStreamChannel ch, int len, ChannelPromise promise)` Splice from this `AbstractEpollStreamChannel` to another `AbstractEpollStreamChannel`.
`ChannelFuture`	`spliceTo(FileDescriptor ch, int offset, int len)` Splice from this `AbstractEpollStreamChannel` to another `FileDescriptor`.
`ChannelFuture`	`spliceTo(FileDescriptor ch, int offset, int len, ChannelPromise promise)` Splice from this `AbstractEpollStreamChannel` to another `FileDescriptor`.

从类继承的方法 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, localAddress, maxMessagesPerWrite, newChannelPipeline, newFailedFuture, newId, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, remoteAddress, 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.Channel
alloc, bytesBeforeUnwritable, bytesBeforeWritable, closeFuture, config, eventLoop, flush, id, isActive, isOpen, isRegistered, isWritable, localAddress, parent, pipeline, read, remoteAddress, 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

- 字段详细资料
  - socket
```
protected final LinuxSocket socket
```
  - flags
```
protected int flags
```
  - active
```
protected volatile boolean active
```
- 构造器详细资料
  - AbstractEpollStreamChannel
```
protected AbstractEpollStreamChannel(Channel parent,
                                     int fd)
```
  - AbstractEpollStreamChannel
```
protected AbstractEpollStreamChannel(int fd)
```
  - AbstractEpollStreamChannel
```
protected AbstractEpollStreamChannel(Channel parent,
                                     LinuxSocket fd,
                                     java.net.SocketAddress remote)
```
  - AbstractEpollStreamChannel
```
protected AbstractEpollStreamChannel(LinuxSocket fd,
                                     boolean active)
```
- 方法详细资料
  - newUnsafe
```
protected io.netty.channel.epoll.AbstractEpollChannel.AbstractEpollUnsafe newUnsafe()
```
    从类复制的说明: AbstractChannel
    
    Create a new AbstractChannel.AbstractUnsafe instance which will be used for the life-time of the Channel
  - metadata
```
public ChannelMetadata metadata()
```
    从接口复制的说明: Channel
    
    Return the ChannelMetadata of the Channel which describe the nature of the Channel.
    
    指定者:
    
    metadata 在接口中 Channel
  - spliceTo
```
public final ChannelFuture spliceTo(AbstractEpollStreamChannel ch,
                                    int len)
```
    Splice from this AbstractEpollStreamChannel to another AbstractEpollStreamChannel. The len is the number of bytes to splice. If using Integer.MAX_VALUE it will splice until the ChannelFuture was canceled or it was failed. Please note:
    - both channels need to be registered to the same EventLoop, otherwise an IllegalArgumentException is thrown.
    - EpollChannelConfig.getEpollMode() must be EpollMode.LEVEL_TRIGGERED for this and the target AbstractEpollStreamChannel
  - spliceTo
```
public final ChannelFuture spliceTo(AbstractEpollStreamChannel ch,
                                    int len,
                                    ChannelPromise promise)
```
    Splice from this AbstractEpollStreamChannel to another AbstractEpollStreamChannel. The len is the number of bytes to splice. If using Integer.MAX_VALUE it will splice until the ChannelFuture was canceled or it was failed. Please note:
    - both channels need to be registered to the same EventLoop, otherwise an IllegalArgumentException is thrown.
    - EpollChannelConfig.getEpollMode() must be EpollMode.LEVEL_TRIGGERED for this and the target AbstractEpollStreamChannel
  - spliceTo
```
public final ChannelFuture spliceTo(FileDescriptor ch,
                                    int offset,
                                    int len)
```
    Splice from this AbstractEpollStreamChannel to another FileDescriptor. The offset is the offset for the FileDescriptor and len is the number of bytes to splice. If using Integer.MAX_VALUE it will splice until the ChannelFuture was canceled or it was failed. Please note:
    - EpollChannelConfig.getEpollMode() must be EpollMode.LEVEL_TRIGGERED for this AbstractEpollStreamChannel
    - the FileDescriptor will not be closed after the ChannelFuture is notified
    - this channel must be registered to an event loop or IllegalStateException will be thrown.
  - spliceTo
```
public final ChannelFuture spliceTo(FileDescriptor ch,
                                    int offset,
                                    int len,
                                    ChannelPromise promise)
```
    Splice from this AbstractEpollStreamChannel to another FileDescriptor. The offset is the offset for the FileDescriptor and len is the number of bytes to splice. If using Integer.MAX_VALUE it will splice until the ChannelFuture was canceled or it was failed. Please note:
    - EpollChannelConfig.getEpollMode() must be EpollMode.LEVEL_TRIGGERED for this AbstractEpollStreamChannel
    - the FileDescriptor will not be closed after the ChannelPromise is notified
    - this channel must be registered to an event loop or IllegalStateException will be thrown.
  - doWrite
```
protected void doWrite(ChannelOutboundBuffer in)
                throws java.lang.Exception
```
    从类复制的说明: AbstractChannel
    
    Flush the content of the given buffer to the remote peer.
    
    指定者:
    
    doWrite 在类中 AbstractChannel
    
    抛出:
    
    java.lang.Exception
  - doWriteSingle
```
protected int doWriteSingle(ChannelOutboundBuffer in)
                     throws java.lang.Exception
```
    Attempt to write a single object.
    参数:
    
    in - the collection which contains objects to write.
    
    返回:
    The value that should be decremented from the write quantum which starts at ChannelConfig.getWriteSpinCount(). The typical use cases are as follows:
    
    0 - if no write was attempted. This is appropriate if an empty ByteBuf (or other empty content) is encountered
    
    1 - if a single call to write data was made to the OS
    
    ChannelUtils.WRITE_STATUS_SNDBUF_FULL - if an attempt to write data was made to the OS, but no data was accepted
    抛出:
    
    java.lang.Exception - If an I/O error occurs.
  - filterOutboundMessage
```
protected java.lang.Object filterOutboundMessage(java.lang.Object msg)
```
    从类复制的说明: AbstractChannel
    
    Invoked when a new message is added to a ChannelOutboundBuffer of this AbstractChannel, so that the Channel implementation converts the message to another. (e.g. heap buffer -> direct buffer)
    
    覆盖:
    
    filterOutboundMessage 在类中 AbstractChannel
  - 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
  - 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
  - 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()
```
    指定者:
    
    shutdownInput 在接口中 DuplexChannel
    
    另请参阅:
    
    Socket.shutdownInput()
  - 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.
  - doClose
```
protected void doClose()
                throws java.lang.Exception
```
    从类复制的说明: AbstractChannel
    
    Close the Channel
    
    抛出:
    
    java.lang.Exception
  - setFlag
```
protected void setFlag(int flag)
                throws java.io.IOException
```
    抛出:
    
    java.io.IOException
  - fd
```
public final FileDescriptor fd()
```
    从接口复制的说明: UnixChannel
    
    Returns the FileDescriptor that is used by this Channel.
    
    指定者:
    
    fd 在接口中 UnixChannel
  - config
```
public abstract EpollChannelConfig config()
```
    从接口复制的说明: Channel
    
    Returns the configuration of this channel.
    
    指定者:
    
    config 在接口中 Channel
  - isActive
```
public boolean isActive()
```
    从接口复制的说明: Channel
    
    Return true if the Channel is active and so connected.
    
    指定者:
    
    isActive 在接口中 Channel
  - 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

类 AbstractEpollStreamChannel

嵌套类概要

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

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

字段概要

构造器概要

方法概要

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

字段详细资料

socket

flags

active

构造器详细资料

AbstractEpollStreamChannel

AbstractEpollStreamChannel

AbstractEpollStreamChannel

AbstractEpollStreamChannel

方法详细资料

newUnsafe

metadata

spliceTo

spliceTo

spliceTo

spliceTo

doWrite

doWriteSingle

filterOutboundMessage

doShutdownOutput

isOutputShutdown

isInputShutdown

isShutdown

shutdownOutput

shutdownOutput

shutdownInput

shutdownInput

shutdown

shutdown

doClose

setFlag

fd

config

isActive

doDisconnect

isCompatible

isOpen

doDeregister

doBeginRead

doRegister

newDirectBuffer

newDirectBuffer

checkResolvable

doReadBytes

doWriteBytes

doBind

doConnect

localAddress0

remoteAddress0