CoalescingBufferQueue (Netty API Reference (4.1.22.Final))

java.lang.Object
- io.netty.channel.AbstractCoalescingBufferQueue
- - io.netty.channel.CoalescingBufferQueue

```
public final class CoalescingBufferQueue
extends AbstractCoalescingBufferQueue
```
生产者通过反复添加ByteBuf添加字节的FIFO队列，消费者以任意长度获取字节。这允许生产者添加大量的小缓冲区，消费者可以将所有的字节放在一个缓冲区中。相反，生产者可以添加更大的缓冲区，并且消费者可以在许多小缓冲区中获取字节。
字节通过承诺添加和删除。如果添加了promise的缓冲区的最后一个字节被删除，那么当承诺传递到remove(int, io.netty.channel.ChannelPromise)完成时，该承诺将完成。

此功能对将聚合或划分写入固定大小的缓冲区以便组帧等协议（如HTTP2）很有用。

构造方法摘要

构造方法
Constructor and Description
`CoalescingBufferQueue(Channel channel)`
`CoalescingBufferQueue(Channel channel, int initSize)`
`CoalescingBufferQueue(Channel channel, int initSize, boolean updateWritability)`

方法摘要

所有方法接口方法具体的方法
Modifier and Type	Method and Description
`protected ByteBuf`	`compose(ByteBufAllocator alloc, ByteBuf cumulation, ByteBuf next)` 计算 `current + next`的结果。
`void`	`releaseAndFailAll(java.lang.Throwable cause)` 释放队列中的所有缓冲区并完成所有侦听器和承诺。
`ByteBuf`	`remove(int bytes, ChannelPromise aggregatePromise)` 用指定的字节数从队列中删除`ByteBuf` 。
`protected ByteBuf`	`removeEmptyValue()` 调用 `AbstractCoalescingBufferQueue.remove(ByteBufAllocator, int, ChannelPromise)`时返回的值，但队列为空。

Methods inherited from class io.netty.channel.AbstractCoalescingBufferQueue
add, add, add, addFirst, composeFirst, composeIntoComposite, copyAndCompose, copyTo, isEmpty, readableBytes, releaseAndFailAll, remove, removeFirst, size, writeAndRemoveAll

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

- 构造方法详细信息
  - CoalescingBufferQueue
```
public CoalescingBufferQueue(Channel channel)
```
  - CoalescingBufferQueue
```
public CoalescingBufferQueue(Channel channel,
                             int initSize)
```
  - CoalescingBufferQueue
```
public CoalescingBufferQueue(Channel channel,
                             int initSize,
                             boolean updateWritability)
```
- 方法详细信息
  - remove
```
public ByteBuf remove(int bytes,
                      ChannelPromise aggregatePromise)
```
    从队列中删除具有指定字节数的ByteBuf 。任何添加的缓冲区字节在删除过程中将被完全消耗，它会在传递的聚合ChannelPromise完成时承诺完成。
    
    参数
    
    bytes -返回可读的最大字节数ByteBuf ，如果bytes大于AbstractCoalescingBufferQueue.readableBytes接着长度的缓冲器AbstractCoalescingBufferQueue.readableBytes被返回。
    
    aggregatePromise - 用于聚合组成缓冲区的承诺和侦听器。
    
    结果
    
    由排队缓冲区组成的ByteBuf 。
  - releaseAndFailAll
```
public void releaseAndFailAll(java.lang.Throwable cause)
```
    释放队列中的所有缓冲区并完成所有侦听器和承诺。
  - compose
```
protected ByteBuf compose(ByteBufAllocator alloc,
                          ByteBuf cumulation,
                          ByteBuf next)
```
    从类复制的描述： AbstractCoalescingBufferQueue
    
    计算结果 current + next 。
    
    Specified by:
    
    compose在课堂上 AbstractCoalescingBufferQueue
  - removeEmptyValue
```
protected ByteBuf removeEmptyValue()
```
    从类复制的描述： AbstractCoalescingBufferQueue
    
    调用 AbstractCoalescingBufferQueue.remove(ByteBufAllocator, int, ChannelPromise)时返回的值，但队列为空。
    
    Specified by:
    
    removeEmptyValue在课堂上 AbstractCoalescingBufferQueue
    
    结果
    
    代表一个空队列的ByteBuf 。

Class CoalescingBufferQueue

构造方法摘要

方法摘要

Methods inherited from class io.netty.channel.AbstractCoalescingBufferQueue

Methods inherited from class java.lang.Object

构造方法详细信息

CoalescingBufferQueue

CoalescingBufferQueue

CoalescingBufferQueue

方法详细信息

remove

releaseAndFailAll

compose

removeEmptyValue