io.netty.channel

类 CoalescingBufferQueue

java.lang.Object

io.netty.channel.AbstractCoalescingBufferQueue

io.netty.channel.CoalescingBufferQueue

public final class CoalescingBufferQueue
extends AbstractCoalescingBufferQueue

A FIFO queue of bytes where producers add bytes by repeatedly adding ByteBuf and consumers take bytes in arbitrary lengths. This allows producers to add lots of small buffers and the consumer to take all the bytes out in a single buffer. Conversely the producer may add larger buffers and the consumer could take the bytes in many small buffers.

Bytes are added and removed with promises. If the last byte of a buffer added with a promise is removed then that promise will complete when the promise passed to remove(int, io.netty.channel.ChannelPromise) completes.

This functionality is useful for aggregating or partitioning writes into fixed size buffers for framing protocols such as HTTP2.

构造器概要

构造器

构造器和说明
CoalescingBufferQueue(Channel channel)
CoalescingBufferQueue(Channel channel, int initSize)
CoalescingBufferQueue(Channel channel, int initSize, boolean updateWritability)

方法概要

限定符和类型	方法和说明
protected ByteBuf	compose(ByteBufAllocator alloc, ByteBuf cumulation, ByteBuf next) Calculate the result of current + next.
void	releaseAndFailAll(java.lang.Throwable cause) Release all buffers in the queue and complete all listeners and promises.
ByteBuf	remove(int bytes, ChannelPromise aggregatePromise) Remove a ByteBuf from the queue with the specified number of bytes.
protected ByteBuf	removeEmptyValue() The value to return when AbstractCoalescingBufferQueue.remove(ByteBufAllocator, int, ChannelPromise) is called but the queue is empty.

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

add, add, add, addFirst, composeFirst, composeIntoComposite, copyAndCompose, copyTo, isEmpty, readableBytes, releaseAndFailAll, remove, removeFirst, size, toString, writeAndRemoveAll

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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)

Remove a ByteBuf from the queue with the specified number of bytes. Any added buffer who's bytes are fully consumed during removal will have it's promise completed when the passed aggregate ChannelPromise completes.

参数:

bytes - the maximum number of readable bytes in the returned ByteBuf, if bytes is greater than AbstractCoalescingBufferQueue.readableBytes then a buffer of length AbstractCoalescingBufferQueue.readableBytes is returned.

aggregatePromise - used to aggregate the promises and listeners for the constituent buffers.

返回:

a ByteBuf composed of the enqueued buffers.

releaseAndFailAll

public void releaseAndFailAll(java.lang.Throwable cause)

Release all buffers in the queue and complete all listeners and promises.

compose

protected ByteBuf compose(ByteBufAllocator alloc,
                          ByteBuf cumulation,
                          ByteBuf next)

从类复制的说明: AbstractCoalescingBufferQueue

Calculate the result of current + next.

指定者:

compose 在类中 AbstractCoalescingBufferQueue

removeEmptyValue

protected ByteBuf removeEmptyValue()

从类复制的说明: AbstractCoalescingBufferQueue

The value to return when AbstractCoalescingBufferQueue.remove(ByteBufAllocator, int, ChannelPromise) is called but the queue is empty.

指定者:

removeEmptyValue 在类中 AbstractCoalescingBufferQueue

返回:

the ByteBuf which represents an empty queue.