FlushConsolidationHandler (Netty API Reference (4.1.22.Final))

java.lang.Object
- io.netty.channel.ChannelHandlerAdapter
- - io.netty.channel.ChannelInboundHandlerAdapter
  - - io.netty.channel.ChannelDuplexHandler
    - - io.netty.handler.flush.FlushConsolidationHandler

All Implemented Interfaces:

ChannelHandler ， ChannelInboundHandler ， ChannelOutboundHandler
```
public class FlushConsolidationHandler
extends ChannelDuplexHandler
```
ChannelDuplexHandler能够综合八十二万六千二百四十四亿三千四百八十三万三千八百四十一 / 八十二万六千二百四十四亿三千四百八十三万九千三百六十七操作（其也包括八二六二四四三四八四六零七八 / 八二六二四四三四八五二七八九和ChannelOutboundInvoker.writeAndFlush(Object) / 八二六二四四三四八六七七九○ ）。
冲洗操作一般来说非常昂贵，因为这些操作可能触发传送级别上的系统调用。因此，在大多数情况下（写延迟可以与吞吐量进行交易）是一个好主意，尽可能地尽量减少刷新操作。

如果读取循环当前正在进行， flush(ChannelHandlerContext)将不会被传递到ChannelPipeline中的下一个ChannelOutboundHandler ，因为当channelReadComplete(ChannelHandlerContext)被触发时，它将拾取任何未决的刷新。如果没有读循环正在进行，则行为取决于consolidateWhenNoReadInProgress构造函数参数：
- 如果false ，刷新直接传递给下一个处理程序;
- 如果true ，则将下一个处理程序的调用作为事件循环中的单独任务提交。在高吞吐量下，这使得有机会在任务执行之前处理其他冲洗，从而将多次冲洗分配到一个冲洗中。
如果达到explicitFlushAfterFlushes则也会转发刷新（无论是在读取循环中，还是在读取循环外进行批处理时）。
如果Channel变得不可写，它也会尝试执行任何挂起的刷新操作。

FlushConsolidationHandler应该放在ChannelPipeline的第一个ChannelHandler以获得最佳效果。

Nested Class Summary
- Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler
  ChannelHandler.Sharable

构造方法摘要

构造方法
Constructor and Description
`FlushConsolidationHandler()` 创建新的实例，在最新的256个挂起的刷新操作后显式刷新。
`FlushConsolidationHandler(int explicitFlushAfterFlushes)` 在没有正在读取的情况下，创建不巩固刷新的新实例。
`FlushConsolidationHandler(int explicitFlushAfterFlushes, boolean consolidateWhenNoReadInProgress)` 创建新的实例。

方法摘要

所有方法接口方法具体的方法
Modifier and Type	Method and Description
`void`	`channelRead(ChannelHandlerContext ctx, java.lang.Object msg)` 致电`ChannelHandlerContext.fireChannelRead(Object)`转发到82624435035014中的下一个`ChannelInboundHandler` 。
`void`	`channelReadComplete(ChannelHandlerContext ctx)` 致电`ChannelHandlerContext.fireChannelReadComplete()`转发到`ChannelPipeline`中的下一个`ChannelInboundHandler` 。
`void`	`channelWritabilityChanged(ChannelHandlerContext ctx)` 致电`ChannelHandlerContext.fireChannelWritabilityChanged()`转发到`ChannelPipeline`中的下一个`ChannelInboundHandler` 。
`void`	`close(ChannelHandlerContext ctx, ChannelPromise promise)` 致电`ChannelOutboundInvoker.close(ChannelPromise)`转发到`ChannelPipeline`中的下一个`ChannelOutboundHandler` 。
`void`	`disconnect(ChannelHandlerContext ctx, ChannelPromise promise)` 致电`ChannelOutboundInvoker.disconnect(ChannelPromise)`转发到`ChannelPipeline`中的下一个`ChannelOutboundHandler` 。
`void`	`exceptionCaught(ChannelHandlerContext ctx, java.lang.Throwable cause)` 致电`ChannelHandlerContext.fireExceptionCaught(Throwable)`转发到`ChannelPipeline`中的下一个`ChannelHandler` 。
`void`	`flush(ChannelHandlerContext ctx)` 致电`ChannelHandlerContext.flush()`转发到`ChannelPipeline`中的下一个`ChannelOutboundHandler` 。
`void`	`handlerAdded(ChannelHandlerContext ctx)` 子类可以忽略这个方法。
`void`	`handlerRemoved(ChannelHandlerContext ctx)` 子类可以忽略这个方法。

Methods inherited from class io.netty.channel.ChannelDuplexHandler
bind, connect, deregister, read, write

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter
channelActive, channelInactive, channelRegistered, channelUnregistered, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter
ensureNotSharable, isSharable

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造方法详细信息
  - FlushConsolidationHandler
```
public FlushConsolidationHandler()
```
    创建新的实例，在最新的256个挂起的刷新操作后显式刷新。
  - FlushConsolidationHandler
```
public FlushConsolidationHandler(int explicitFlushAfterFlushes)
```
    在没有正在读取的情况下，创建不巩固刷新的新实例。
    
    参数
    
    explicitFlushAfterFlushes - 在完成显式刷新之后的刷新次数。
  - FlushConsolidationHandler
```
public FlushConsolidationHandler(int explicitFlushAfterFlushes,
                                 boolean consolidateWhenNoReadInProgress)
```
    创建新的实例。
    
    参数
    
    explicitFlushAfterFlushes - 在完成显式刷新之后的刷新次数。
    
    consolidateWhenNoReadInProgress - 即使当前没有读取循环正在进行时是否合并冲洗。
- 方法详细信息
  - handlerAdded
```
public void handlerAdded(ChannelHandlerContext ctx)
                  throws java.lang.Exception
```
    从类复制的描述： ChannelHandlerAdapter
    
    子类可以忽略这个方法。
    
    Specified by:
    
    handlerAdded在界面 ChannelHandler
    
    重写：
    
    handlerAdded在课堂上 ChannelHandlerAdapter
    
    异常
    
    java.lang.Exception
  - flush
```
public void flush(ChannelHandlerContext ctx)
           throws java.lang.Exception
```
    从类复制的描述： ChannelDuplexHandler
    
    致电ChannelHandlerContext.flush()转发到ChannelPipeline中的下一个ChannelOutboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    flush在界面 ChannelOutboundHandler
    
    重写：
    
    flush在课堂上 ChannelDuplexHandler
    
    参数
    
    ctx - 进行刷新操作的ChannelHandlerContext
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - channelReadComplete
```
public void channelReadComplete(ChannelHandlerContext ctx)
                         throws java.lang.Exception
```
    从类复制的描述： ChannelInboundHandlerAdapter
    
    致电ChannelHandlerContext.fireChannelReadComplete()转发至ChannelPipeline中的下一个ChannelInboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    channelReadComplete在界面 ChannelInboundHandler
    
    重写：
    
    channelReadComplete在课堂上 ChannelInboundHandlerAdapter
    
    异常
    
    java.lang.Exception
  - channelRead
```
public void channelRead(ChannelHandlerContext ctx,
                        java.lang.Object msg)
                 throws java.lang.Exception
```
    从类复制的描述： ChannelInboundHandlerAdapter
    
    致电ChannelHandlerContext.fireChannelRead(Object)转发到ChannelPipeline中的下一个ChannelInboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    channelRead在界面 ChannelInboundHandler
    
    重写：
    
    channelRead在课堂上 ChannelInboundHandlerAdapter
    
    异常
    
    java.lang.Exception
  - exceptionCaught
```
public void exceptionCaught(ChannelHandlerContext ctx,
                            java.lang.Throwable cause)
                     throws java.lang.Exception
```
    从类复制的描述： ChannelInboundHandlerAdapter
    
    致电ChannelHandlerContext.fireExceptionCaught(Throwable)转发到ChannelPipeline中的下一个ChannelHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    exceptionCaught在界面 ChannelHandler
    
    Specified by:
    
    exceptionCaught在界面 ChannelInboundHandler
    
    重写：
    
    exceptionCaught在课堂 ChannelInboundHandlerAdapter
    
    异常
    
    java.lang.Exception
  - disconnect
```
public void disconnect(ChannelHandlerContext ctx,
                       ChannelPromise promise)
                throws java.lang.Exception
```
    从类复制的描述： ChannelDuplexHandler
    
    请致电ChannelOutboundInvoker.disconnect(ChannelPromise)转发至ChannelPipeline中的下一个ChannelOutboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    disconnect在界面 ChannelOutboundHandler
    
    重写：
    
    disconnect在课堂上 ChannelDuplexHandler
    
    参数
    
    ctx - 为其进行断开操作的ChannelHandlerContext
    
    promise - 操作完成后通知ChannelPromise
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - close
```
public void close(ChannelHandlerContext ctx,
                  ChannelPromise promise)
           throws java.lang.Exception
```
    从类复制的描述： ChannelDuplexHandler
    
    致电ChannelOutboundInvoker.close(ChannelPromise)转发到ChannelPipeline中的下一个ChannelOutboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    close接口 ChannelOutboundHandler
    
    重写：
    
    close在课堂上 ChannelDuplexHandler
    
    参数
    
    ctx - ChannelHandlerContext进行关闭操作
    
    promise - 在操作完成后通知ChannelPromise
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - channelWritabilityChanged
```
public void channelWritabilityChanged(ChannelHandlerContext ctx)
                               throws java.lang.Exception
```
    从类复制的描述： ChannelInboundHandlerAdapter
    
    致电ChannelHandlerContext.fireChannelWritabilityChanged()转发到ChannelPipeline中的下一个ChannelInboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    channelWritabilityChanged在界面 ChannelInboundHandler
    
    重写：
    
    channelWritabilityChanged在课堂 ChannelInboundHandlerAdapter
    
    异常
    
    java.lang.Exception
  - handlerRemoved
```
public void handlerRemoved(ChannelHandlerContext ctx)
                    throws java.lang.Exception
```
    从类复制的描述： ChannelHandlerAdapter
    
    子类可以忽略这个方法。
    
    Specified by:
    
    handlerRemoved接口 ChannelHandler
    
    重写：
    
    handlerRemoved在课堂上 ChannelHandlerAdapter
    
    异常
    
    java.lang.Exception

Class FlushConsolidationHandler

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

构造方法摘要

方法摘要

Methods inherited from class io.netty.channel.ChannelDuplexHandler

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

Methods inherited from class java.lang.Object

构造方法详细信息

FlushConsolidationHandler

FlushConsolidationHandler

FlushConsolidationHandler

方法详细信息

handlerAdded

flush

channelReadComplete

channelRead

exceptionCaught

disconnect

close

channelWritabilityChanged

handlerRemoved