Package io.netty.channel

Class AbstractCoalescingBufferQueue

java.lang.Object

io.netty.channel.AbstractCoalescingBufferQueue

Direct Known Subclasses:

CoalescingBufferQueue

@UnstableApi
public abstract class AbstractCoalescingBufferQueue
extends java.lang.Object

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractCoalescingBufferQueue(Channel channel, int initSize)	Create a new instance.

Method Summary

Modifier and Type	Method	Description
void	add(ByteBuf buf)	Add a buffer to the end of the queue.
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.
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.
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 abstract ByteBuf	compose(ByteBufAllocator alloc, ByteBuf cumulation, ByteBuf next)	Calculate the result of current + next.
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 compose(ByteBufAllocator, ByteBuf, ByteBuf).
protected ByteBuf	composeIntoComposite(ByteBufAllocator alloc, ByteBuf cumulation, ByteBuf next)	Compose cumulation and next into a new CompositeByteBuf.
protected ByteBuf	copyAndCompose(ByteBufAllocator alloc, ByteBuf cumulation, ByteBuf next)	Compose cumulation and next into a new ByteBufAllocator.ioBuffer().
void	copyTo(AbstractCoalescingBufferQueue dest)	Copy all pending entries in this queue into the destination queue.
boolean	isEmpty()	Are there pending buffers in the queue.
int	readableBytes()	The number of readable bytes.
void	releaseAndFailAll(ChannelOutboundInvoker invoker, java.lang.Throwable cause)	Release all buffers in the queue and complete all listeners and promises.
ByteBuf	remove(ByteBufAllocator alloc, int bytes, ChannelPromise aggregatePromise)	Remove a ByteBuf from the queue with the specified number of bytes.
protected abstract ByteBuf	removeEmptyValue()	The value to return when remove(ByteBufAllocator, int, ChannelPromise) is called but the queue is empty.
ByteBuf	removeFirst(ChannelPromise aggregatePromise)	Remove the first ByteBuf from the queue.
protected int	size()	Get the number of elements in this queue added via one of the add(ByteBuf) methods.
java.lang.String	toString()
void	writeAndRemoveAll(ChannelHandlerContext ctx)	Writes all remaining elements in this queue.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCoalescingBufferQueue

protected AbstractCoalescingBufferQueue(Channel channel,
                                        int initSize)

Create a new instance.

Parameters:

channel - the Channel which will have the Channel.isWritable() reflect the amount of queued buffers or null if there is no writability state updated.

initSize - the initial size of the underlying queue.

Method Detail

addFirst

public 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.

Parameters:

buf - to add to the head of the queue

promise - to complete when all the bytes have been consumed and written, can be void.

add

public final void add(ByteBuf buf)

Add a buffer to the end of the queue.

add

public 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.

Parameters:

buf - to add to the tail of the queue

promise - to complete when all the bytes have been consumed and written, can be void.

add

public 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.

Parameters:

buf - to add to the tail of the queue

listener - to notify when all the bytes have been consumed and written, can be null.

removeFirst

public final ByteBuf removeFirst(ChannelPromise aggregatePromise)

Remove the first ByteBuf from the queue.

Parameters:

aggregatePromise - used to aggregate the promises and listeners for the returned buffer.

Returns:

the first ByteBuf from the queue.

remove

public final ByteBuf remove(ByteBufAllocator alloc,
                            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:

alloc - The allocator used if a new ByteBuf is generated during the aggregation process.

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

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

Returns:

a ByteBuf composed of the enqueued buffers.

readableBytes

public final int readableBytes()

The number of readable bytes.

isEmpty

public final boolean isEmpty()

Are there pending buffers in the queue.

releaseAndFailAll

public final void releaseAndFailAll(ChannelOutboundInvoker invoker,
                                    java.lang.Throwable cause)

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

copyTo

public final void copyTo(AbstractCoalescingBufferQueue dest)

Copy all pending entries in this queue into the destination queue.

Parameters:

dest - to copy pending buffers to.

writeAndRemoveAll

public final void writeAndRemoveAll(ChannelHandlerContext ctx)

Writes all remaining elements in this queue.

Parameters:

ctx - The context to write all elements to.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compose

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

Calculate the result of current + next.

composeIntoComposite

protected final ByteBuf composeIntoComposite(ByteBufAllocator alloc,
                                             ByteBuf cumulation,
                                             ByteBuf next)

Compose cumulation and next into a new CompositeByteBuf.

copyAndCompose

protected final ByteBuf copyAndCompose(ByteBufAllocator alloc,
                                       ByteBuf cumulation,
                                       ByteBuf next)

Compose cumulation and next into a new ByteBufAllocator.ioBuffer().

Parameters:

alloc - The allocator to use to allocate the new buffer.

cumulation - The current cumulation.

next - The next buffer.

Returns:

The result of cumulation + next.

composeFirst

protected ByteBuf composeFirst(ByteBufAllocator allocator,
                               ByteBuf first,
                               int bufferSize)

Calculate the first ByteBuf which will be used in subsequent calls to compose(ByteBufAllocator, ByteBuf, ByteBuf).

Parameters:

bufferSize - the optimal size of the buffer needed for cumulation

Returns:

the first buffer

composeFirst

@Deprecated
protected ByteBuf composeFirst(ByteBufAllocator allocator,
                               ByteBuf first)

Deprecated.

Use {AbstractCoalescingBufferQueue#composeFirst(ByteBufAllocator, ByteBuf, int)}

Calculate the first ByteBuf which will be used in subsequent calls to compose(ByteBufAllocator, ByteBuf, ByteBuf). This method is deprecated and will be removed in the future. Implementing classes should override composeFirst(ByteBufAllocator, ByteBuf, int) instead.

removeEmptyValue

protected abstract ByteBuf removeEmptyValue()

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

Returns:

the ByteBuf which represents an empty queue.

size

protected final int size()

Get the number of elements in this queue added via one of the add(ByteBuf) methods.

Returns:

the number of elements in this queue.