Package io.netty.channel

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static final class	PendingWriteQueue.PendingWrite	Holds all meta-data and construct the linked-list structure.

Field Summary

Fields

Modifier and Type	Field	Description
private long	bytes
private final EventExecutor	executor
private PendingWriteQueue.PendingWrite	head
private final ChannelOutboundInvoker	invoker
private static final InternalLogger	logger
private static final int	PENDING_WRITE_OVERHEAD
private int	size
private PendingWriteQueue.PendingWrite	tail
private final PendingBytesTracker	tracker

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.
private void	assertEmpty()
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.
private void	recycle(PendingWriteQueue.PendingWrite write, boolean update)
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).
private static void	safeFail(ChannelPromise promise, Throwable cause)
int	size()	Returns the number of pending write operations.
private int	size(Object msg)

Methods inherited from class java.lang.Object

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

Field Details

logger

private static final InternalLogger logger

PENDING_WRITE_OVERHEAD

private static final int PENDING_WRITE_OVERHEAD

invoker

private final ChannelOutboundInvoker invoker

executor

private final EventExecutor executor

tracker

private final PendingBytesTracker tracker

head

private PendingWriteQueue.PendingWrite head

tail

private PendingWriteQueue.PendingWrite tail

size

private int size

bytes

private long bytes

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.

size

private int size(Object msg)

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

assertEmpty

private void assertEmpty()

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.

recycle

private void recycle(PendingWriteQueue.PendingWrite write,
 boolean update)

safeFail

private static void safeFail(ChannelPromise promise,
 Throwable cause)