Module io.netty5.transport

Package io.netty5.channel

Class PendingWriteQueue

java.lang.Object

io.netty5.channel.PendingWriteQueue

public final class PendingWriteQueue
extends Object

A queue of write operations which are pending for later execution.

Constructor Summary

Constructors

Constructor	Description
PendingWriteQueue(EventExecutor executor, MessageSizeEstimator.Handle handle)

Method Summary

Modifier and Type	Method	Description
void	add(Object msg, Promise<Void> promise)	Add the given msg and Promise.
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.
Promise<Void>	remove()	Removes a pending write operation and release its message via Resource.dispose(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.
Future<Void>	removeAndTransfer(Function<Object,Future<Void>> transferFunc)	Removes a pending write operation and performs it via Function.apply(Object).
Future<Void>	removeAndTransferAll(Function<Object,Future<Void>> transferFunc)	Remove all pending write operation and performs them via Function.apply(Object).
int	size()	Returns the number of pending write operations.

Methods inherited from class java.lang.Object

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

Constructor Detail

PendingWriteQueue

public PendingWriteQueue(EventExecutor executor,
                         MessageSizeEstimator.Handle handle)

Method Detail

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,
                Promise<Void> promise)

Add the given msg and Promise.

removeAndTransferAll

public Future<Void> removeAndTransferAll(Function<Object,Future<Void>> transferFunc)

Remove all pending write operation and performs them via Function.apply(Object).

Returns:

Future if something was transferred 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 Resource.dispose(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 Resource.dispose(Object).

removeAndTransfer

public Future<Void> removeAndTransfer(Function<Object,Future<Void>> transferFunc)

Removes a pending write operation and performs it via Function.apply(Object).

Returns:

Future if something was transfered and null if the PendingWriteQueue is empty.

remove

public Promise<Void> remove()

Removes a pending write operation and release its message via Resource.dispose(Object).

Returns:

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

current

public Object current()

Return the current message or null if empty.