AbstractEpollStreamChannel (Netty API Reference (4.1.22.Final))

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

All Implemented Interfaces:

Channel ， ChannelOutboundInvoker ， DuplexChannel ， UnixChannel ， AttributeMap ，java.lang.Comparable的< Channel >

已知直接子类：

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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`AbstractEpollStreamChannel.SpliceInTask`

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
Modifier and Type	Field and Description
`protected boolean`	`active`
`protected int`	`flags`

构造方法摘要

构造方法
Modifier	Constructor and Description
`protected`	`AbstractEpollStreamChannel(Channel parent, int fd)`
`protected`	`AbstractEpollStreamChannel(int fd)`
`protected`	`AbstractEpollStreamChannel(io.netty.channel.epoll.LinuxSocket fd, boolean active)`

方法摘要

所有方法静态方法接口方法抽象方法具体的方法
Modifier and Type	Method and Description
`protected static void`	`checkResolvable(java.net.InetSocketAddress addr)`
`abstract EpollChannelConfig`	`config()` 返回此频道的配置。
`protected void`	`doBeginRead()` 安排读取操作。
`protected void`	`doBind(java.net.SocketAddress local)` 将`Channel`绑定到`SocketAddress`
`protected void`	`doClose()` 关闭`Channel`
`protected boolean`	`doConnect(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress)` 连接到远程对等
`protected void`	`doDeregister()` 注销`Channel`从`EventLoop` 。
`protected void`	`doDisconnect()` 将此`Channel`从其远程对等方断开
`protected int`	`doReadBytes(ByteBuf byteBuf)` 将字节读入给定的`ByteBuf`并返回金额。
`protected void`	`doRegister()` 之后，被称为`Channel`与其注册`EventLoop`作为注册过程的一部分。
`protected void`	`doShutdownOutput()` 当条件证明关闭通道的输出部分时调用。
`protected void`	`doWrite(ChannelOutboundBuffer in)` 将给定缓冲区的内容刷新到远程对等体。
`protected int`	`doWriteBytes(ChannelOutboundBuffer in, ByteBuf buf)`
`protected int`	`doWriteSingle(ChannelOutboundBuffer in)` 尝试编写单个对象。
`FileDescriptor`	`fd()` 返回此`Channel`使用的`FileDescriptor` 。
`protected java.lang.Object`	`filterOutboundMessage(java.lang.Object msg)` 在将新消息添加到此`AbstractChannel`的`ChannelOutboundBuffer`时调用，以便`Channel`实现将消息转换为另一个消息。
`boolean`	`isActive()` 如果`Channel`处于活动状态并已连接，则返回`true` 。
`protected boolean`	`isCompatible(EventLoop loop)` 如果给定的`EventLoop`与此实例兼容，则返回`true` 。
`boolean`	`isInputShutdown()` 返回 `true`当且仅当远程节点关闭其输出，以便从此通道接收不到更多数据时。
`boolean`	`isOpen()` 如果`Channel`已打开并且稍后可能会激活，则返回`true`
`boolean`	`isOutputShutdown()`
`boolean`	`isShutdown()` 确定此通道的输入和输出是否都已关闭。
`protected java.net.SocketAddress`	`localAddress0()` 返回本地绑定的 `SocketAddress` 。
`ChannelMetadata`	`metadata()` 返回`ChannelMetadata`的的`Channel`其描述的性质`Channel` 。
`protected ByteBuf`	`newDirectBuffer(ByteBuf buf)` 返回指定的`ByteBuf`的堆外副本，并释放原始副本。
`protected ByteBuf`	`newDirectBuffer(java.lang.Object holder, ByteBuf buf)` 返回指定的`ByteBuf`的堆外副本，并释放指定的持有者。
`protected io.netty.channel.epoll.AbstractEpollChannel.AbstractEpollUnsafe`	`newUnsafe()` 创建一个新的`AbstractChannel.AbstractUnsafe`实例，该实例将用于`Channel`的生命周期
`protected java.net.SocketAddress`	`remoteAddress0()` 返回`SocketAddress`其中`Channel`被连接到。
`ChannelFuture`	`shutdown()` 将关闭此通道的输入和输出端。
`ChannelFuture`	`shutdown(ChannelPromise promise)` 将关闭此通道的输入和输出端。
`ChannelFuture`	`shutdownInput()`
`ChannelFuture`	`shutdownInput(ChannelPromise promise)` 将关闭输入并通知`ChannelPromise` 。
`ChannelFuture`	`shutdownOutput()`
`ChannelFuture`	`shutdownOutput(ChannelPromise promise)` 将关闭输出并通知`ChannelPromise` 。
`ChannelFuture`	`spliceTo(AbstractEpollStreamChannel ch, int len)` 从此`AbstractEpollStreamChannel`转接到另一个`AbstractEpollStreamChannel` 。
`ChannelFuture`	`spliceTo(AbstractEpollStreamChannel ch, int len, ChannelPromise promise)` 将此`AbstractEpollStreamChannel`从另一个`AbstractEpollStreamChannel`接合起来。
`ChannelFuture`	`spliceTo(FileDescriptor ch, int offset, int len)` 将此`AbstractEpollStreamChannel`拼接到另一个`FileDescriptor` 。
`ChannelFuture`	`spliceTo(FileDescriptor ch, int offset, int len, ChannelPromise promise)` 将此`AbstractEpollStreamChannel`从另一个`FileDescriptor`拼接起来。

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, equals, eventLoop, flush, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, localAddress, newChannelPipeline, newFailedFuture, newId, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, remoteAddress, 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, config, eventLoop, flush, id, isActive, isOpen, isRegistered, isWritable, localAddress, parent, pipeline, read, remoteAddress, 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

- 字段详细信息
  - flags
```
protected int flags
```
  - active
```
protected volatile boolean active
```
- 构造方法详细信息
  - AbstractEpollStreamChannel
```
protected AbstractEpollStreamChannel(Channel parent,
                                     int fd)
```
  - AbstractEpollStreamChannel
```
protected AbstractEpollStreamChannel(int fd)
```
  - AbstractEpollStreamChannel
```
protected AbstractEpollStreamChannel(io.netty.channel.epoll.LinuxSocket fd,
                                     boolean active)
```
- 方法详细信息
  - newUnsafe
```
protected io.netty.channel.epoll.AbstractEpollChannel.AbstractEpollUnsafe newUnsafe()
```
    从类复制的描述： AbstractChannel
    
    创建一个新的AbstractChannel.AbstractUnsafe实例，该实例将用于Channel的生命周期
  - metadata
```
public ChannelMetadata metadata()
```
    从界面复制的描述： Channel
    
    返回ChannelMetadata的的Channel其描述的性质Channel 。
    
    Specified by:
    
    metadata接口 Channel
  - spliceTo
```
public final ChannelFuture spliceTo(AbstractEpollStreamChannel ch,
                                    int len)
```
    从此AbstractEpollStreamChannel拼接到另一个AbstractEpollStreamChannel 。 len是要拼接的字节数。如果使用Integer.MAX_VALUE它将拼接，直到ChannelFuture被取消或失败。请注意：
    - 两个通道都需要注册到相同的EventLoop ，否则会引发IllegalArgumentException 。
    - EpollChannelConfig.getEpollMode()必须是EpollMode.LEVEL_TRIGGERED为此和目标AbstractEpollStreamChannel
  - spliceTo
```
public final ChannelFuture spliceTo(AbstractEpollStreamChannel ch,
                                    int len,
                                    ChannelPromise promise)
```
    将此AbstractEpollStreamChannel拼接到另一个AbstractEpollStreamChannel 。 len是要拼接的字节数。如果使用Integer.MAX_VALUE ，它将拼接，直到ChannelFuture被取消或失败。请注意：
    - 两个频道都需要注册到相同的EventLoop ，否则会引发IllegalArgumentException 。
    - EpollChannelConfig.getEpollMode()必须是EpollMode.LEVEL_TRIGGERED这个和目标AbstractEpollStreamChannel
  - spliceTo
```
public final ChannelFuture spliceTo(FileDescriptor ch,
                                    int offset,
                                    int len)
```
    从AbstractEpollStreamChannel拼接到另一个FileDescriptor 。该offset针对偏移FileDescriptor和len是字节拼接的数量。如果使用Integer.MAX_VALUE它将拼接，直到ChannelFuture被取消或失败。请注意：
    - EpollChannelConfig.getEpollMode()必须是EpollMode.LEVEL_TRIGGERED这个AbstractEpollStreamChannel
    - ChannelFuture通知后， FileDescriptor将不会关闭
    - 此通道必须注册到事件循环或IllegalStateException将被抛出。
  - spliceTo
```
public final ChannelFuture spliceTo(FileDescriptor ch,
                                    int offset,
                                    int len,
                                    ChannelPromise promise)
```
    将此AbstractEpollStreamChannel与另一个FileDescriptor拼接。该offset针对偏移FileDescriptor和len是字节拼接的数量。如果使用Integer.MAX_VALUE ，它将拼接，直到ChannelFuture被取消或失败。请注意：
    - EpollChannelConfig.getEpollMode()必须EpollMode.LEVEL_TRIGGERED这个AbstractEpollStreamChannel
    - 在FileDescriptor后不会被关闭ChannelPromise通知
    - 此通道必须注册到事件循环或IllegalStateException将被抛出。
  - doWrite
```
protected void doWrite(ChannelOutboundBuffer in)
                throws java.lang.Exception
```
    从类复制的描述： AbstractChannel
    
    将给定缓冲区的内容刷新到远程对等体。
    
    Specified by:
    
    doWrite在课堂上 AbstractChannel
    
    异常
    
    java.lang.Exception
  - doWriteSingle
```
protected int doWriteSingle(ChannelOutboundBuffer in)
                     throws java.lang.Exception
```
    尝试编写单个对象。
    参数
    
    in - 包含要写入对象的集合。
    
    结果
    应该从ChannelConfig.getWriteSpinCount()开始的写入量值递减的值。典型的用例如下：
    
    0 - 如果没有尝试写入。如果遇到空的ByteBuf （或其他空的内容），这是适当的
    
    1 - 如果向OS写入数据的单个调用
    
    ChannelUtils.WRITE_STATUS_SNDBUF_FULL - 如果尝试向操作系统写入数据，但未接受任何数据
    异常
    
    java.lang.Exception - 如果发生I / O错误。
  - filterOutboundMessage
```
protected java.lang.Object filterOutboundMessage(java.lang.Object msg)
```
    从类复制的描述： AbstractChannel
    
    在将新消息添加到此AbstractChannel的ChannelOutboundBuffer时调用，以便Channel实现将消息转换为另一个消息。（例如堆缓冲区 - >直接缓冲区）
    
    重写：
    
    filterOutboundMessage类 AbstractChannel
  - doShutdownOutput
```
@UnstableApi
protected final void doShutdownOutput()
                                            throws java.lang.Exception
```
    从类复制的描述： AbstractChannel
    
    当条件证明关闭通道的输出部分时调用。如果写入操作抛出异常，则可能会发生这种情况。
    
    重写：
    
    doShutdownOutput在课程 AbstractChannel
    
    异常
    
    java.lang.Exception
  - isOutputShutdown
```
public boolean isOutputShutdown()
```
    Specified by:
    
    isOutputShutdown在界面 DuplexChannel
    
    另请参见：
    
    Socket.isOutputShutdown()
  - isInputShutdown
```
public boolean isInputShutdown()
```
    从接口DuplexChannel复制的描述
    
    返回true当且仅当远程节点关闭其输出，以便从此通道接收不到更多数据时。请注意，此方法的语义不同于Socket.shutdownInput()和Socket.isInputShutdown() 。
    
    Specified by:
    
    isInputShutdown接口 DuplexChannel
  - isShutdown
```
public boolean isShutdown()
```
    从接口DuplexChannel复制的描述
    
    确定此通道的输入和输出是否都已关闭。
    
    Specified by:
    
    isShutdown在界面 DuplexChannel
  - shutdownOutput
```
public ChannelFuture shutdownOutput()
```
    Specified by:
    
    shutdownOutput在界面 DuplexChannel
    
    另请参见：
    
    Socket.shutdownOutput()
  - shutdownOutput
```
public ChannelFuture shutdownOutput(ChannelPromise promise)
```
    从接口复制的描述： DuplexChannel
    
    将关闭输出并通知ChannelPromise 。
    
    Specified by:
    
    shutdownOutput接口 DuplexChannel
    
    另请参见：
    
    Socket.shutdownOutput()
  - shutdownInput
```
public ChannelFuture shutdownInput()
```
    Specified by:
    
    shutdownInput在界面 DuplexChannel
    
    另请参见：
    
    Socket.shutdownInput()
  - shutdownInput
```
public ChannelFuture shutdownInput(ChannelPromise promise)
```
    从界面复制的描述： DuplexChannel
    
    将关闭输入并通知ChannelPromise 。
    
    Specified by:
    
    shutdownInput在界面 DuplexChannel
    
    另请参见：
    
    Socket.shutdownInput()
  - shutdown
```
public ChannelFuture shutdown()
```
    从接口复制的描述： DuplexChannel
    
    将关闭此通道的输入和输出端。
    
    Specified by:
    
    shutdown在界面 DuplexChannel
    
    结果
    
    将在两次关机操作完成时完成。
  - shutdown
```
public ChannelFuture shutdown(ChannelPromise promise)
```
    从接口DuplexChannel复制的描述
    
    将关闭此通道的输入和输出端。
    
    Specified by:
    
    shutdown在界面 DuplexChannel
    
    参数
    
    promise - 将在两次关机操作完成时完成。
    
    结果
    
    将在两次关机操作完成时完成。
  - doClose
```
protected void doClose()
                throws java.lang.Exception
```
    从类复制的描述： AbstractChannel
    
    关闭Channel
    
    异常
    
    java.lang.Exception
  - fd
```
public final FileDescriptor fd()
```
    从接口UnixChannel复制的描述
    
    返回此Channel使用的FileDescriptor 。
    
    Specified by:
    
    fd在界面 UnixChannel
  - config
```
public abstract EpollChannelConfig config()
```
    从接口Channel复制的描述
    
    返回此频道的配置。
    
    Specified by:
    
    config在界面 Channel
  - isActive
```
public boolean isActive()
```
    从接口复制的描述： Channel
    
    如果Channel处于活动状态且已连接，则返回true 。
    
    Specified by:
    
    isActive在界面 Channel
  - doDisconnect
```
protected void doDisconnect()
                     throws java.lang.Exception
```
    从类复制的描述： AbstractChannel
    
    将此Channel从其远程对等方断开
    
    Specified by:
    
    doDisconnect在课堂上 AbstractChannel
    
    异常
    
    java.lang.Exception
  - isCompatible
```
protected boolean isCompatible(EventLoop loop)
```
    从类复制的描述： AbstractChannel
    
    如果给定的EventLoop与此实例兼容，则返回true 。
    
    Specified by:
    
    isCompatible在课堂上 AbstractChannel
  - isOpen
```
public boolean isOpen()
```
    从接口Channel复制的描述
    
    如果Channel已打开并且稍后可能会激活，则返回true
    
    Specified by:
    
    isOpen在界面 Channel
  - doDeregister
```
protected void doDeregister()
                     throws java.lang.Exception
```
    从类复制的描述： AbstractChannel
    
    注销Channel从EventLoop 。子类可能会覆盖此方法
    
    重写：
    
    doDeregister在课堂上 AbstractChannel
    
    异常
    
    java.lang.Exception
  - doBeginRead
```
protected final void doBeginRead()
                          throws java.lang.Exception
```
    从类复制的描述： AbstractChannel
    
    安排读取操作。
    
    Specified by:
    
    doBeginRead在课堂上 AbstractChannel
    
    异常
    
    java.lang.Exception
  - doRegister
```
protected void doRegister()
                   throws java.lang.Exception
```
    从类复制的描述： AbstractChannel
    
    之后，被称为Channel与其注册EventLoop作为注册过程的一部分。子类可能会覆盖此方法
    
    重写：
    
    doRegister在课堂上 AbstractChannel
    
    异常
    
    java.lang.Exception
  - newDirectBuffer
```
protected final ByteBuf newDirectBuffer(ByteBuf buf)
```
    返回指定ByteBuf的堆外副本，并释放原始副本。
  - newDirectBuffer
```
protected final ByteBuf newDirectBuffer(java.lang.Object holder,
                                        ByteBuf buf)
```
    返回指定的ByteBuf的堆外副本，并释放指定的持有者。呼叫者必须确保持有人在通过此方法释放持有人时释放原始ByteBuf 。
  - checkResolvable
```
protected static void checkResolvable(java.net.InetSocketAddress addr)
```
  - doReadBytes
```
protected final int doReadBytes(ByteBuf byteBuf)
                         throws java.lang.Exception
```
    将字节读入给定的ByteBuf并返回金额。
    
    异常
    
    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
    
    将Channel绑定到SocketAddress
    
    Specified by:
    
    doBind的 AbstractChannel
    
    异常
    
    java.lang.Exception
  - doConnect
```
protected boolean doConnect(java.net.SocketAddress remoteAddress,
                            java.net.SocketAddress localAddress)
                     throws java.lang.Exception
```
    连接到远程对等
    
    异常
    
    java.lang.Exception
  - localAddress0
```
protected java.net.SocketAddress localAddress0()
```
    从类复制的描述： AbstractChannel
    
    返回本地绑定的 SocketAddress 。
    
    Specified by:
    
    localAddress0在课堂上 AbstractChannel
  - remoteAddress0
```
protected java.net.SocketAddress remoteAddress0()
```
    从类复制的描述： AbstractChannel
    
    返回SocketAddress其中Channel被连接到。
    
    Specified by:
    
    remoteAddress0 in class AbstractChannel

Class AbstractEpollStreamChannel

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

构造方法摘要

方法摘要

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

字段详细信息

flags

active

构造方法详细信息

AbstractEpollStreamChannel

AbstractEpollStreamChannel

AbstractEpollStreamChannel

方法详细信息

newUnsafe

metadata

spliceTo

spliceTo

spliceTo

spliceTo

doWrite

doWriteSingle

filterOutboundMessage

doShutdownOutput

isOutputShutdown

isInputShutdown

isShutdown

shutdownOutput

shutdownOutput

shutdownInput

shutdownInput

shutdown

shutdown

doClose

fd

config

isActive

doDisconnect

isCompatible

isOpen

doDeregister

doBeginRead

doRegister

newDirectBuffer

newDirectBuffer

checkResolvable

doReadBytes

doWriteBytes

doBind

doConnect

localAddress0

remoteAddress0