Class 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, ChannelPromise) completes.

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

Constructor Summary

Constructors

Constructor	Description
CoalescingBufferQueue(Channel channel)
CoalescingBufferQueue(Channel channel, int initSize)
CoalescingBufferQueue(Channel channel, int initSize, boolean updateWritability)

Method Summary

Modifier and Type	Method	Description
protected ByteBuf	compose(ByteBufAllocator alloc, ByteBuf cumulation, ByteBuf next)	Calculate the result of current + next.
void	releaseAndFailAll(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.

Methods inherited from class AbstractCoalescingBufferQueue

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

Modifier and Type	Method	Description
final void	add(ByteBuf buf)	Add a buffer to the end of the queue.
final void	add(ByteBuf buf, ChannelFutureListener listener)	Add a buffer to the end of the queue and associate a listener with it that should be completed when all the buffers bytes have been consumed from the queue and written.
final void	add(ByteBuf buf, ChannelPromise promise)	Add a buffer to the end of the queue and associate a promise with it that should be completed when all the buffer's bytes have been consumed from the queue and written.
final void	addFirst(ByteBuf buf, ChannelPromise promise)	Add a buffer to the front of the queue and associate a promise with it that should be completed when all the buffer's bytes have been consumed from the queue and written.
protected ByteBuf	composeFirst(ByteBufAllocator allocator, ByteBuf first)	Deprecated. Use {AbstractCoalescingBufferQueue#composeFirst(ByteBufAllocator, ByteBuf, int)}
protected ByteBuf	composeFirst(ByteBufAllocator allocator, ByteBuf first, int bufferSize)	Calculate the first ByteBuf which will be used in subsequent calls to AbstractCoalescingBufferQueue.compose(ByteBufAllocator, ByteBuf, ByteBuf).
protected final ByteBuf	composeIntoComposite(ByteBufAllocator alloc, ByteBuf cumulation, ByteBuf next)	Compose cumulation and next into a new CompositeByteBuf.
protected final ByteBuf	copyAndCompose(ByteBufAllocator alloc, ByteBuf cumulation, ByteBuf next)	Compose cumulation and next into a new ByteBufAllocator.ioBuffer().
final void	copyTo(AbstractCoalescingBufferQueue dest)	Copy all pending entries in this queue into the destination queue.
final boolean	isEmpty()	Are there pending buffers in the queue.
final int	readableBytes()	The number of readable bytes.
final void	releaseAndFailAll(ChannelOutboundInvoker invoker, Throwable cause)	Release all buffers in the queue and complete all listeners and promises.
final ByteBuf	remove(ByteBufAllocator alloc, int bytes, ChannelPromise aggregatePromise)	Remove a ByteBuf from the queue with the specified number of bytes.
final ByteBuf	removeFirst(ChannelPromise aggregatePromise)	Remove the first ByteBuf from the queue.
protected final int	size()	Get the number of elements in this queue added via one of the AbstractCoalescingBufferQueue.add(ByteBuf) methods.
String	toString()
final void	writeAndRemoveAll(ChannelHandlerContext ctx)	Writes all remaining elements in this queue.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

CoalescingBufferQueue

public CoalescingBufferQueue(Channel channel)

CoalescingBufferQueue

public CoalescingBufferQueue(Channel channel,
 int initSize)

CoalescingBufferQueue

public CoalescingBufferQueue(Channel channel,
 int initSize,
 boolean updateWritability)

Method Details

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.

Parameters:

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.

Returns:

a ByteBuf composed of the enqueued buffers.

releaseAndFailAll

public void releaseAndFailAll(Throwable cause)

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

compose

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

Description copied from class: AbstractCoalescingBufferQueue

Calculate the result of current + next.

Specified by:

compose in class AbstractCoalescingBufferQueue

removeEmptyValue

protected ByteBuf removeEmptyValue()

Description copied from class: AbstractCoalescingBufferQueue

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

Specified by:

removeEmptyValue in class AbstractCoalescingBufferQueue

Returns:

the ByteBuf which represents an empty queue.