Modifier and Type	Class and Description
pack-priv static class	ChannelOutboundBuffer.Entry
public static interface	ChannelOutboundBuffer.MessageProcessor

Modifier and Type	Field and Description
private final Channel	channel
pack-priv static final int	CHANNEL_OUTBOUND_BUFFER_ENTRY_OVERHEAD
private volatile Runnable	fireChannelWritabilityChangedTask
private int	flushed
private ChannelOutboundBuffer.Entry	flushedEntry
private boolean	inFail
private static final InternalLogger	logger
private static final FastThreadLocal<ByteBuffer[]>	NIO_BUFFERS
private int	nioBufferCount
private long	nioBufferSize
private ChannelOutboundBuffer.Entry	tailEntry
private static final AtomicLongFieldUpdater<ChannelOutboundBuffer>	TOTAL_PENDING_SIZE_UPDATER
private volatile long	totalPendingSize
private ChannelOutboundBuffer.Entry	unflushedEntry
private volatile int	unwritable
private static final AtomicIntegerFieldUpdater<ChannelOutboundBuffer>	UNWRITABLE_UPDATER

Access	Constructor and Description
pack-priv	ChannelOutboundBuffer(AbstractChannel channel)

Method Summary

Modifier and Type	Method and Description
public void	addFlush() Add a flush to this `ChannelOutboundBuffer`.
public void	addMessage(Object msg, int size, ChannelPromise promise) Add given message to this `ChannelOutboundBuffer`.
public long	bytesBeforeUnwritable() Get how many bytes can be written until `isWritable()` returns `false`.
public long	bytesBeforeWritable() Get how many bytes must be drained from the underlying buffer until `isWritable()` returns `true`.
private void	clearNioBuffers()
private void	clearUserDefinedWritability(int index)
pack-priv void	close(final Throwable cause, final boolean allowChannelOpen)
pack-priv void	close(ClosedChannelException cause)
public Object	current() Return the current message to write or `null` if nothing was flushed before and so is ready to be written.
public long	Returns: `0` if nothing was flushed before for the current message or there is no current message currentProgress() Return the current message flush progress.
pack-priv void	decrementPendingOutboundBytes(long size) Decrement the pending bytes which will be written at some point.
private void	decrementPendingOutboundBytes(long size, boolean invokeLater, boolean notifyWritability)
private static ByteBuffer[]	expandNioBufferArray(ByteBuffer[] array, int neededSpace, int size)
pack-priv void	failFlushed(Throwable cause, boolean notify)
private void	fireChannelWritabilityChanged(boolean invokeLater)
public void	forEachFlushedMessage(ChannelOutboundBuffer.MessageProcessor processor) Call `MessageProcessor#processMessage(Object)` for each flushed message in this `ChannelOutboundBuffer` until `MessageProcessor#processMessage(Object)` returns `false` or there are no more flushed messages to process.
public boolean	getUserDefinedWritability(int index) Returns `true` if and only if the user-defined writability flag at the specified index is set to `true`.
pack-priv void	incrementPendingOutboundBytes(long size) Increment the pending bytes which will be written at some point.
private void	incrementPendingOutboundBytes(long size, boolean invokeLater)
public boolean	isEmpty() Returns `true` if there are flushed messages in this `ChannelOutboundBuffer` or `false` otherwise.
private boolean	isFlushedEntry(ChannelOutboundBuffer.Entry e)
public boolean	isWritable() Returns `true` if and only if the total number of pending bytes did not exceed the write watermark of the `Channel` and no user-defined writability flag has been set to `false`.
public int	nioBufferCount() Returns the number of `ByteBuffer` that can be written out of the `ByteBuffer` array that was obtained via `nioBuffers()`.
public ByteBuffer[]	nioBuffers() Returns an array of direct NIO buffers if the currently pending messages are made of `ByteBuf` only.
public ByteBuffer[]	nioBuffers(int The maximum amount of buffers that will be added to the return value. maxCount, long A hint toward the maximum number of bytes to include as part of the return value. Note that this value maybe exceeded because we make a best effort to include at least 1 `ByteBuffer` in the return value to ensure write progress is made. maxBytes) Returns an array of direct NIO buffers if the currently pending messages are made of `ByteBuf` only.
private static int	nioBuffers(ChannelOutboundBuffer.Entry entry, ByteBuf buf, ByteBuffer[] nioBuffers, int nioBufferCount, int maxCount)
public long	nioBufferSize() Returns the number of bytes that can be written out of the `ByteBuffer` array that was obtained via `nioBuffers()`.
public void	progress(long amount) Notify the `ChannelPromise` of the current message about writing progress.
public void	recycle() Deprecated
public boolean	remove() Will remove the current message, mark its `ChannelPromise` as success and return `true`.
public boolean	remove(Throwable cause) Will remove the current message, mark its `ChannelPromise` as failure using the given `Throwable` and return `true`.
private boolean	remove0(Throwable cause, boolean notifyWritability)
public void	removeBytes(long writtenBytes) Removes the fully written entries and update the reader index of the partially written entry.
private void	removeEntry(ChannelOutboundBuffer.Entry e)
private static void	safeFail(ChannelPromise promise, Throwable cause)
private static void	safeSuccess(ChannelPromise promise)
private void	setUnwritable(boolean invokeLater)
public void	setUserDefinedWritability(int index, boolean writable) Sets a user-defined writability flag at the specified index.
private void	setUserDefinedWritability(int index)
private void	setWritable(boolean invokeLater)
public int	size() Returns the number of flushed messages in this `ChannelOutboundBuffer`.
private static long	total(Object msg)
public long	totalPendingWriteBytes()
private static int	writabilityMask(int index)

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

Field Detail

channel	back to summary
private final Channel channel

CHANNEL_OUTBOUND_BUFFER_ENTRY_OVERHEAD	back to summary
pack-priv static final int CHANNEL_OUTBOUND_BUFFER_ENTRY_OVERHEAD

fireChannelWritabilityChangedTask	back to summary
private volatile Runnable fireChannelWritabilityChangedTask

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

NIO_BUFFERS	back to summary
private static final FastThreadLocal<ByteBuffer[]> NIO_BUFFERS

nioBufferCount	back to summary
private int nioBufferCount

nioBufferSize	back to summary
private long nioBufferSize

tailEntry	back to summary
private ChannelOutboundBuffer.Entry tailEntry

TOTAL_PENDING_SIZE_UPDATER	back to summary
private static final AtomicLongFieldUpdater<ChannelOutboundBuffer> TOTAL_PENDING_SIZE_UPDATER

totalPendingSize	back to summary
private volatile long totalPendingSize Annotations @SuppressWarnings:UnusedDeclaration

unflushedEntry	back to summary
private ChannelOutboundBuffer.Entry unflushedEntry

unwritable	back to summary
private volatile int unwritable Annotations @SuppressWarnings:UnusedDeclaration

UNWRITABLE_UPDATER	back to summary
private static final AtomicIntegerFieldUpdater<ChannelOutboundBuffer> UNWRITABLE_UPDATER

Constructor Detail

ChannelOutboundBuffer	back to summary
pack-priv ChannelOutboundBuffer(AbstractChannel channel)

Method Detail

addFlush	back to summary
public 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
public void addMessage(Object msg, int size, ChannelPromise promise) Add given message to this `ChannelOutboundBuffer`. The given `ChannelPromise` will be notified once the message was written.

bytesBeforeUnwritable	back to summary
public long bytesBeforeUnwritable() Get how many bytes can be written until `isWritable()` returns `false`. This quantity will always be non-negative. If `isWritable()` is `false` then 0.

bytesBeforeWritable	back to summary
public long bytesBeforeWritable() Get how many bytes must be drained from the underlying buffer until `isWritable()` returns `true`. This quantity will always be non-negative. If `isWritable()` is `true` then 0.

clearNioBuffers	back to summary
private void clearNioBuffers()

clearUserDefinedWritability	back to summary
private void clearUserDefinedWritability(int index)

close	back to summary
pack-priv void close(final Throwable cause, final boolean allowChannelOpen)

close	back to summary
pack-priv void close(ClosedChannelException cause)

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

currentProgress back to summary

currentProgress	back to summary
public long currentProgress() Return the current message flush progress. Returns:long `0` if nothing was flushed before for the current message or there is no current message

public long currentProgress()

Return the current message flush progress.

Returns:long: 0 if nothing was flushed before for the current message or there is no current message

decrementPendingOutboundBytes	back to summary
pack-priv void decrementPendingOutboundBytes(long size) Decrement the pending bytes which will be written at some point. This method is thread-safe!

decrementPendingOutboundBytes	back to summary
private void decrementPendingOutboundBytes(long size, boolean invokeLater, boolean notifyWritability)

expandNioBufferArray	back to summary
private static ByteBuffer[] expandNioBufferArray(ByteBuffer[] array, int neededSpace, int size)

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

fireChannelWritabilityChanged	back to summary
private void fireChannelWritabilityChanged(boolean invokeLater)

forEachFlushedMessage	back to summary
public void forEachFlushedMessage(ChannelOutboundBuffer.MessageProcessor processor) throws Exception Call `MessageProcessor#processMessage(Object)` for each flushed message in this `ChannelOutboundBuffer` until `MessageProcessor#processMessage(Object)` returns `false` or there are no more flushed messages to process.

getUserDefinedWritability	back to summary
public boolean getUserDefinedWritability(int index) Returns `true` if and only if the user-defined writability flag at the specified index is set to `true`.

incrementPendingOutboundBytes	back to summary
pack-priv void incrementPendingOutboundBytes(long size) Increment the pending bytes which will be written at some point. This method is thread-safe!

incrementPendingOutboundBytes	back to summary
private void incrementPendingOutboundBytes(long size, boolean invokeLater)

isEmpty	back to summary
public 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)

isWritable	back to summary
public boolean isWritable() Returns `true` if and only if the total number of pending bytes did not exceed the write watermark of the `Channel` and no user-defined writability flag has been set to `false`.

nioBufferCount	back to summary
public int nioBufferCount() Returns the number of `ByteBuffer` that can be written out of the `ByteBuffer` array that was obtained via `nioBuffers()`. This method MUST be called after `nioBuffers()` was called.

nioBuffers back to summary

nioBuffers	back to summary
public ByteBuffer[] nioBuffers() Returns an array of direct NIO buffers if the currently pending messages are made of `ByteBuf` only. `nioBufferCount()` and `nioBufferSize()` will return the number of NIO buffers in the returned array and the total number of readable bytes of the NIO buffers respectively. Note that the returned array is reused and thus should not escape `AbstractChannel#doWrite(ChannelOutboundBuffer)`. Refer to `NioSocketChannel#doWrite(ChannelOutboundBuffer)` for an example.

public ByteBuffer[] nioBuffers()

Returns an array of direct NIO buffers if the currently pending messages are made of ByteBuf only. nioBufferCount() and nioBufferSize() will return the number of NIO buffers in the returned array and the total number of readable bytes of the NIO buffers respectively.

Note that the returned array is reused and thus should not escape AbstractChannel#doWrite(ChannelOutboundBuffer). Refer to NioSocketChannel#doWrite(ChannelOutboundBuffer) for an example.

nioBuffers back to summary

nioBuffers	back to summary
public ByteBuffer[] nioBuffers(int maxCount, long maxBytes) Returns an array of direct NIO buffers if the currently pending messages are made of `ByteBuf` only. `nioBufferCount()` and `nioBufferSize()` will return the number of NIO buffers in the returned array and the total number of readable bytes of the NIO buffers respectively. Note that the returned array is reused and thus should not escape `AbstractChannel#doWrite(ChannelOutboundBuffer)`. Refer to `NioSocketChannel#doWrite(ChannelOutboundBuffer)` for an example. Parameters maxCount:int The maximum amount of buffers that will be added to the return value. maxBytes:long A hint toward the maximum number of bytes to include as part of the return value. Note that this value maybe exceeded because we make a best effort to include at least 1 `ByteBuffer` in the return value to ensure write progress is made.

public ByteBuffer[] nioBuffers(int maxCount, long maxBytes)

Note that the returned array is reused and thus should not escape AbstractChannel#doWrite(ChannelOutboundBuffer). Refer to NioSocketChannel#doWrite(ChannelOutboundBuffer) for an example.

Parameters

maxCount:int: The maximum amount of buffers that will be added to the return value.
maxBytes:long: A hint toward the maximum number of bytes to include as part of the return value. Note that this value maybe exceeded because we make a best effort to include at least 1 ByteBuffer in the return value to ensure write progress is made.

nioBuffers	back to summary
private static int nioBuffers(ChannelOutboundBuffer.Entry entry, ByteBuf buf, ByteBuffer[] nioBuffers, int nioBufferCount, int maxCount)

nioBufferSize	back to summary
public long nioBufferSize() Returns the number of bytes that can be written out of the `ByteBuffer` array that was obtained via `nioBuffers()`. This method MUST be called after `nioBuffers()` was called.

progress	back to summary
public void progress(long amount) Notify the `ChannelPromise` of the current message about writing progress.

recycle	back to summary
public void recycle() Deprecated Annotations @Deprecated

remove	back to summary
public boolean remove() Will remove the current message, mark its `ChannelPromise` 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
public boolean remove(Throwable cause) Will remove the current message, mark its `ChannelPromise` 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, boolean notifyWritability)

removeBytes	back to summary
public void removeBytes(long writtenBytes) Removes the fully written entries and update the reader index of the partially written entry. This operation assumes all messages in this buffer is `ByteBuf`.

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

safeFail	back to summary
private static void safeFail(ChannelPromise promise, Throwable cause)

safeSuccess	back to summary
private static void safeSuccess(ChannelPromise promise)

setUnwritable	back to summary
private void setUnwritable(boolean invokeLater)

setUserDefinedWritability	back to summary
public void setUserDefinedWritability(int index, boolean writable) Sets a user-defined writability flag at the specified index.

setUserDefinedWritability	back to summary
private void setUserDefinedWritability(int index)

setWritable	back to summary
private void setWritable(boolean invokeLater)

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

total	back to summary
private static long total(Object msg)

totalPendingWriteBytes	back to summary
public long totalPendingWriteBytes()

writabilityMask	back to summary
private static int writabilityMask(int index)

io.netty.channel back to summary

pack-priv final Class ChannelOutboundBuffer.Entry

Class Inheritance

extends Object

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

Field Summary

Modifier and Type	Field and Description
pack-priv ByteBuffer	buf
pack-priv ByteBuffer[]	bufs
pack-priv boolean	cancelled
pack-priv int	count
private final Recycler.EnhancedHandle<ChannelOutboundBuffer.Entry>	handle
pack-priv Object	msg
pack-priv ChannelOutboundBuffer.Entry	next
pack-priv int	pendingSize
pack-priv long	progress
pack-priv ChannelPromise	promise
private static final ObjectPool<ChannelOutboundBuffer.Entry>	RECYCLER
pack-priv long	total

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, long total, ChannelPromise promise)
pack-priv void	unguardedRecycle()
pack-priv ChannelOutboundBuffer.Entry	unguardedRecycleAndGetNext()

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

Field Detail

buf	back to summary
pack-priv ByteBuffer buf

bufs	back to summary
pack-priv ByteBuffer[] bufs

cancelled	back to summary
pack-priv boolean cancelled

count	back to summary
pack-priv int count

handle	back to summary
private final Recycler.EnhancedHandle<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

progress	back to summary
pack-priv long progress

promise	back to summary
pack-priv ChannelPromise promise

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

total	back to summary
pack-priv long total

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, long total, ChannelPromise promise)

unguardedRecycle	back to summary
pack-priv void unguardedRecycle()

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

public final Class ChannelOutboundBuffer

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class ChannelOutboundBuffer.Entry

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface ChannelOutboundBuffer.MessageProcessor

Method Summary

Method Detail