Package io.netty.channel
Class PendingWriteQueue
- java.lang.Object
-
- io.netty.channel.PendingWriteQueue
-
public final class PendingWriteQueue extends java.lang.ObjectA queue of write operations which are pending for later execution. It also updates the writability of the associatedChannel, 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 classPendingWriteQueue.PendingWriteHolds all meta-data and construct the linked-list structure.
-
Field Summary
Fields Modifier and Type Field Description private longbytesprivate ChannelHandlerContextctxprivate PendingWriteQueue.PendingWriteheadprivate static InternalLoggerloggerprivate static intPENDING_WRITE_OVERHEADprivate intsizeprivate PendingWriteQueue.PendingWritetailprivate PendingBytesTrackertracker
-
Constructor Summary
Constructors Constructor Description PendingWriteQueue(ChannelHandlerContext ctx)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidadd(java.lang.Object msg, ChannelPromise promise)Add the givenmsgandChannelPromise.private voidassertEmpty()longbytes()Returns the total number of bytes that are pending because of pending messages.java.lang.Objectcurrent()Return the current message ornullif empty.booleanisEmpty()Returnstrueif there are no pending write operations left in this queue.private voidrecycle(PendingWriteQueue.PendingWrite write, boolean update)ChannelPromiseremove()Removes a pending write operation and release it's message viaReferenceCountUtil.safeRelease(Object).voidremoveAndFail(java.lang.Throwable cause)Remove a pending write operation and fail it with the givenThrowable.voidremoveAndFailAll(java.lang.Throwable cause)Remove all pending write operation and fail them with the givenThrowable.ChannelFutureremoveAndWrite()Removes a pending write operation and performs it viaChannelOutboundInvoker.write(Object, ChannelPromise).ChannelFutureremoveAndWriteAll()Remove all pending write operation and performs them viaChannelOutboundInvoker.write(Object, ChannelPromise).private static voidsafeFail(ChannelPromise promise, java.lang.Throwable cause)intsize()Returns the number of pending write operations.private intsize(java.lang.Object msg)
-
-
-
Field Detail
-
logger
private static final InternalLogger logger
-
PENDING_WRITE_OVERHEAD
private static final int PENDING_WRITE_OVERHEAD
-
ctx
private final ChannelHandlerContext ctx
-
tracker
private final PendingBytesTracker tracker
-
head
private PendingWriteQueue.PendingWrite head
-
tail
private PendingWriteQueue.PendingWrite tail
-
size
private int size
-
bytes
private long bytes
-
-
Constructor Detail
-
PendingWriteQueue
public PendingWriteQueue(ChannelHandlerContext ctx)
-
-
Method Detail
-
isEmpty
public boolean isEmpty()
Returnstrueif 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(java.lang.Object msg)
-
add
public void add(java.lang.Object msg, ChannelPromise promise)Add the givenmsgandChannelPromise.
-
removeAndWriteAll
public ChannelFuture removeAndWriteAll()
Remove all pending write operation and performs them viaChannelOutboundInvoker.write(Object, ChannelPromise).- Returns:
ChannelFutureif something was written andnullif thePendingWriteQueueis empty.
-
removeAndFailAll
public void removeAndFailAll(java.lang.Throwable cause)
Remove all pending write operation and fail them with the givenThrowable. The message will be released viaReferenceCountUtil.safeRelease(Object).
-
removeAndFail
public void removeAndFail(java.lang.Throwable cause)
Remove a pending write operation and fail it with the givenThrowable. The message will be released viaReferenceCountUtil.safeRelease(Object).
-
assertEmpty
private void assertEmpty()
-
removeAndWrite
public ChannelFuture removeAndWrite()
Removes a pending write operation and performs it viaChannelOutboundInvoker.write(Object, ChannelPromise).- Returns:
ChannelFutureif something was written andnullif thePendingWriteQueueis empty.
-
remove
public ChannelPromise remove()
Removes a pending write operation and release it's message viaReferenceCountUtil.safeRelease(Object).- Returns:
ChannelPromiseof the pending write ornullif the queue is empty.
-
current
public java.lang.Object current()
Return the current message ornullif empty.
-
recycle
private void recycle(PendingWriteQueue.PendingWrite write, boolean update)
-
safeFail
private static void safeFail(ChannelPromise promise, java.lang.Throwable cause)
-
-