Module io.netty5.transport

Package io.netty5.channel

Class ChannelOutboundBuffer

java.lang.Object

io.netty5.channel.ChannelOutboundBuffer

public final class ChannelOutboundBuffer
extends Object

(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 Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ChannelOutboundBuffer.MessageProcessor<T extends Exception>

Method Summary

Modifier and Type	Method	Description
void	addFlush()	Add a flush to this ChannelOutboundBuffer.
void	addMessage(Object msg, int size, Promise<Void> promise)	Add given message to this ChannelOutboundBuffer.
Object	current()	Return the current message to write or null if nothing was flushed before and so is ready to be written.
long	currentProgress()	Return the current message flush progress.
<T extends Exception> void	forEachFlushedMessage(ChannelOutboundBuffer.MessageProcessor<T> processor)	Call ChannelOutboundBuffer.MessageProcessor.processMessage(Object) for each flushed message in this ChannelOutboundBuffer until ChannelOutboundBuffer.MessageProcessor.processMessage(Object) returns false or there are no more flushed messages to process.
boolean	isEmpty()	Returns true if there are flushed messages in this ChannelOutboundBuffer or false otherwise.
int	nioBufferCount()	Returns the number of ByteBuffer that can be written out of the ByteBuffer array that was obtained via nioBuffers().
ByteBuffer[]	nioBuffers()	Returns an array of direct NIO buffers if the currently pending messages are made of Buffer only.
ByteBuffer[]	nioBuffers(int maxCount, long maxBytes)	Returns an array of direct NIO buffers if the currently pending messages are made of Buffer only.
long	nioBufferSize()	Returns the number of bytes that can be written out of the ByteBuffer array that was obtained via nioBuffers().
void	progress(long amount)	Notify the Promise of the current message about writing progress.
boolean	remove()	Will remove the current message, mark its Promise as success and return true.
boolean	remove(Throwable cause)	Will remove the current message, mark its Promise as failure using the given Throwable and return true.
void	removeBytes(long writtenBytes)	Removes the fully written entries and update the reader index of the partially written entry.
int	size()	Returns the number of flushed messages in this ChannelOutboundBuffer.
long	totalPendingWriteBytes()

Methods inherited from class java.lang.Object

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

Method Detail

addMessage

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

addFlush

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.

current

public Object current()

Return the current message to write or null if nothing was flushed before and so is ready to be written.

currentProgress

public long currentProgress()

Return the current message flush progress.

Returns:

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

progress

public void progress(long amount)

Notify the Promise of the current message about writing progress.

remove

public 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

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

removeBytes

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 are either Buffers or Buffers.

nioBuffers

public ByteBuffer[] nioBuffers()

Returns an array of direct NIO buffers if the currently pending messages are made of Buffer 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).

nioBuffers

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

Returns an array of direct NIO buffers if the currently pending messages are made of Buffer 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).

Parameters:

maxCount - The maximum amount of buffers that will be added to the return value.

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

nioBufferCount

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.

nioBufferSize

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.

size

public int size()

Returns the number of flushed messages in this ChannelOutboundBuffer.

isEmpty

public boolean isEmpty()

Returns true if there are flushed messages in this ChannelOutboundBuffer or false otherwise.

totalPendingWriteBytes

public long totalPendingWriteBytes()

forEachFlushedMessage

public <T extends Exception> void forEachFlushedMessage(ChannelOutboundBuffer.MessageProcessor<T> processor)
                                                 throws T extends Exception

Call ChannelOutboundBuffer.MessageProcessor.processMessage(Object) for each flushed message in this ChannelOutboundBuffer until ChannelOutboundBuffer.MessageProcessor.processMessage(Object) returns false or there are no more flushed messages to process.

Throws:

T extends Exception