Class PendingWriteQueue

java.lang.Object

io.netty.channel.PendingWriteQueue

public final class PendingWriteQueue
extends Object

A queue of write operations which are pending for later execution. It also updates the writability of the associated Channel, so that the pending write operations are also considered to determine the writability.

Constructor Summary

Constructors

Constructor	Description
PendingWriteQueue(Channel channel)
PendingWriteQueue(ChannelHandlerContext ctx)

Method Summary

Modifier and Type	Method	Description
void	add(Object msg, ChannelPromise promise)	Add the given msg and ChannelPromise.
long	bytes()	Returns the total number of bytes that are pending because of pending messages.
Object	current()	Return the current message or null if empty.
boolean	isEmpty()	Returns true if there are no pending write operations left in this queue.
ChannelPromise	remove()	Removes a pending write operation and release it's message via ReferenceCountUtil.safeRelease(Object).
void	removeAndFail(Throwable cause)	Remove a pending write operation and fail it with the given Throwable.
void	removeAndFailAll(Throwable cause)	Remove all pending write operation and fail them with the given Throwable.
ChannelFuture	removeAndWrite()	Removes a pending write operation and performs it via ChannelOutboundInvoker.write(Object, ChannelPromise).
ChannelFuture	removeAndWriteAll()	Remove all pending write operation and performs them via ChannelOutboundInvoker.write(Object, ChannelPromise).
int	size()	Returns the number of pending write operations.

Methods inherited from class Object

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

Constructor Details

PendingWriteQueue

public PendingWriteQueue(ChannelHandlerContext ctx)

PendingWriteQueue

public PendingWriteQueue(Channel channel)

Method Details

isEmpty

public boolean isEmpty()

Returns true if there are no pending write operations left in this queue.

size

public int size()

Returns the number of pending write operations.

bytes

public long bytes()

Returns the total number of bytes that are pending because of pending messages. This is only an estimate so it should only be treated as a hint.

add

public void add(Object msg,
 ChannelPromise promise)

Add the given msg and ChannelPromise.

removeAndWriteAll

public ChannelFuture removeAndWriteAll()

Remove all pending write operation and performs them via ChannelOutboundInvoker.write(Object, ChannelPromise).

Returns:

ChannelFuture if something was written and null if the PendingWriteQueue is empty.

removeAndFailAll

public void removeAndFailAll(Throwable cause)

Remove all pending write operation and fail them with the given Throwable. The message will be released via ReferenceCountUtil.safeRelease(Object).

removeAndFail

public void removeAndFail(Throwable cause)

Remove a pending write operation and fail it with the given Throwable. The message will be released via ReferenceCountUtil.safeRelease(Object).

removeAndWrite

public ChannelFuture removeAndWrite()

Removes a pending write operation and performs it via ChannelOutboundInvoker.write(Object, ChannelPromise).

Returns:

ChannelFuture if something was written and null if the PendingWriteQueue is empty.

remove

public ChannelPromise remove()

Removes a pending write operation and release it's message via ReferenceCountUtil.safeRelease(Object).

Returns:

ChannelPromise of the pending write or null if the queue is empty.

current

public Object current()

Return the current message or null if empty.