Top Description Inners Fields Constructors Methods

io.netty5.channel

pack-priv final Class ChannelOutboundBuffer

Class Inheritance

extends Object

java.lang.Object
io.netty5.channel.ChannelOutboundBuffer

Imports

io.netty5.util.concurrent.EventExecutor, .Promise, io.netty5.util.internal.ObjectPool, .ObjectPool.Handle, .PromiseNotificationUtil, .SilentDispose, .SystemPropertyUtil, io.netty5.util.internal.logging.InternalLogger, .InternalLoggerFactory, java.util.function.Function, .Predicate

(Transport implementors only) an internal data structure used by AbstractChannel to store its pending outbound write requests.

All methods must be called by a transport implementation from an I/O thread, except the following ones:

totalPendingWriteBytes()

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	ChannelOutboundBuffer.Entry

Field Summary

Modifier and Type	Field and Description
pack-priv static final int	CHANNEL_OUTBOUND_BUFFER_ENTRY_OVERHEAD
private boolean	closed
private final EventExecutor	executor
private int	flushed
private ChannelOutboundBuffer.Entry	flushedEntry
private boolean	inFail
private static final InternalLogger	logger
private ChannelOutboundBuffer.Entry	tailEntry
private volatile long	totalPendingSize
private ChannelOutboundBuffer.Entry	unflushedEntry

Constructor Summary

Access	Constructor and Description
pack-priv	ChannelOutboundBuffer(EventExecutor executor)

Method Summary

Modifier and Type	Method and Description
pack-priv void	addFlush() Add a flush to this `ChannelOutboundBuffer`.
pack-priv void	addMessage(Object msg, int size, Promise<Void> promise) Add given message to this `ChannelOutboundBuffer`.
private void	close(final Throwable cause)
pack-priv Object	current() Return the current message to write or `null` if nothing was flushed before and so is ready to be written.
private void	decrementPendingOutboundBytes(long size)
pack-priv void	failFlushed(Throwable cause)
pack-priv void	failFlushedAndClose(Throwable failCause, Throwable closeCause)
pack-priv void	forEachFlushedMessage(Predicate<Object> processor) Call `Function#apply(Object)` for each flushed message in this `ChannelOutboundBuffer` until `Function#apply(Object)` returns `Boolean#FALSE` or there are no more flushed messages to process.
private void	incrementPendingOutboundBytes(long size)
pack-priv boolean	isEmpty() Returns `true` if there are flushed messages in this `ChannelOutboundBuffer` or `false` otherwise.
private boolean	isFlushedEntry(ChannelOutboundBuffer.Entry e)
pack-priv boolean	remove() Will remove the current message, mark its `Promise` as success and return `true`.
pack-priv boolean	remove(Throwable cause) Will remove the current message, mark its `Promise` as failure using the given `Throwable` and return `true`.
private boolean	remove0(Throwable cause)
private void	removeEntry(ChannelOutboundBuffer.Entry e)
private static void	safeFail(Promise<Void> promise, Throwable cause)
private static void	safeSuccess(Promise<Void> promise)
pack-priv int	size() Returns the number of flushed messages in this `ChannelOutboundBuffer`.
pack-priv long	totalPendingWriteBytes()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

CHANNEL_OUTBOUND_BUFFER_ENTRY_OVERHEAD	back to summary
pack-priv static final int CHANNEL_OUTBOUND_BUFFER_ENTRY_OVERHEAD

closed	back to summary
private boolean closed

executor	back to summary
private final EventExecutor executor

flushed	back to summary
private int flushed

flushedEntry	back to summary
private ChannelOutboundBuffer.Entry flushedEntry

inFail	back to summary
private boolean inFail

logger	back to summary
private static final InternalLogger logger

tailEntry	back to summary
private ChannelOutboundBuffer.Entry tailEntry

totalPendingSize	back to summary
private volatile long totalPendingSize

unflushedEntry	back to summary
private ChannelOutboundBuffer.Entry unflushedEntry

Constructor Detail

ChannelOutboundBuffer	back to summary
pack-priv ChannelOutboundBuffer(EventExecutor executor) Annotations @SuppressWarnings:UnusedDeclaration

Method Detail

addFlush	back to summary
pack-priv void addFlush() Add a flush to this `ChannelOutboundBuffer`. This means all previous added messages are marked as flushed and so you will be able to handle them.

addMessage	back to summary
pack-priv void addMessage(Object msg, int size, Promise<Void> promise) Add given message to this `ChannelOutboundBuffer`. The given `Promise` will be notified once the message was written.

close	back to summary
private void close(final Throwable cause)

current	back to summary
pack-priv Object current() Return the current message to write or `null` if nothing was flushed before and so is ready to be written.

decrementPendingOutboundBytes	back to summary
private void decrementPendingOutboundBytes(long size)

failFlushed	back to summary
pack-priv void failFlushed(Throwable cause)

failFlushedAndClose	back to summary
pack-priv void failFlushedAndClose(Throwable failCause, Throwable closeCause)

forEachFlushedMessage	back to summary
pack-priv void forEachFlushedMessage(Predicate<Object> processor) Call `Function#apply(Object)` for each flushed message in this `ChannelOutboundBuffer` until `Function#apply(Object)` returns `Boolean#FALSE` or there are no more flushed messages to process.

incrementPendingOutboundBytes	back to summary
private void incrementPendingOutboundBytes(long size)

isEmpty	back to summary
pack-priv boolean isEmpty() Returns `true` if there are flushed messages in this `ChannelOutboundBuffer` or `false` otherwise.

isFlushedEntry	back to summary
private boolean isFlushedEntry(ChannelOutboundBuffer.Entry e)

remove	back to summary
pack-priv boolean remove() Will remove the current message, mark its `Promise` as success and return `true`. If no flushed message exists at the time this method is called it will return `false` to signal that no more messages are ready to be handled.

remove	back to summary
pack-priv boolean remove(Throwable cause) Will remove the current message, mark its `Promise` as failure using the given `Throwable` and return `true`. If no flushed message exists at the time this method is called it will return `false` to signal that no more messages are ready to be handled.

remove0	back to summary
private boolean remove0(Throwable cause)

removeEntry	back to summary
private void removeEntry(ChannelOutboundBuffer.Entry e)

safeFail	back to summary
private static void safeFail(Promise<Void> promise, Throwable cause)

safeSuccess	back to summary
private static void safeSuccess(Promise<Void> promise)

size	back to summary
pack-priv int size() Returns the number of flushed messages in this `ChannelOutboundBuffer`.

totalPendingWriteBytes	back to summary
pack-priv long totalPendingWriteBytes()

io.netty5.channel back to summary

private final Class ChannelOutboundBuffer.Entry

Class Inheritance

extends Object

java.lang.Object
io.netty5.channel.ChannelOutboundBuffer.Entry

Field Summary

Modifier and Type	Field and Description
pack-priv boolean	cancelled
private final ObjectPool.Handle<ChannelOutboundBuffer.Entry>	handle
pack-priv Object	msg
pack-priv ChannelOutboundBuffer.Entry	next
pack-priv int	pendingSize
pack-priv Promise<Void>	promise
private static final ObjectPool<ChannelOutboundBuffer.Entry>	RECYCLER

Constructor Summary

Access	Constructor and Description
private	Entry(ObjectPool.Handle<ChannelOutboundBuffer.Entry> handle)

Method Summary

Modifier and Type	Method and Description
pack-priv int	cancel()
pack-priv static ChannelOutboundBuffer.Entry	newInstance(Object msg, int size, Promise<Void> promise)
pack-priv void	recycle()
pack-priv ChannelOutboundBuffer.Entry	recycleAndGetNext()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

cancelled	back to summary
pack-priv boolean cancelled

handle	back to summary
private final ObjectPool.Handle<ChannelOutboundBuffer.Entry> handle

msg	back to summary
pack-priv Object msg

next	back to summary
pack-priv ChannelOutboundBuffer.Entry next

pendingSize	back to summary
pack-priv int pendingSize

promise	back to summary
pack-priv Promise<Void> promise

RECYCLER	back to summary
private static final ObjectPool<ChannelOutboundBuffer.Entry> RECYCLER

Constructor Detail

Entry	back to summary
private Entry(ObjectPool.Handle<ChannelOutboundBuffer.Entry> handle)

Method Detail

cancel	back to summary
pack-priv int cancel()

newInstance	back to summary
pack-priv static ChannelOutboundBuffer.Entry newInstance(Object msg, int size, Promise<Void> promise)

recycle	back to summary
pack-priv void recycle()

recycleAndGetNext	back to summary
pack-priv ChannelOutboundBuffer.Entry recycleAndGetNext()