Package io.netty.channel
Class ChannelOutboundBuffer
- java.lang.Object
-
- io.netty.channel.ChannelOutboundBuffer
-
public final class ChannelOutboundBuffer extends java.lang.Object
(Transport implementors only) an internal data structure used byAbstractChannel
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:
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ChannelOutboundBuffer.MessageProcessor
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addFlush()
Add a flush to thisChannelOutboundBuffer
.void
addMessage(java.lang.Object msg, int size, ChannelPromise promise)
Add given message to thisChannelOutboundBuffer
.long
bytesBeforeUnwritable()
Get how many bytes can be written untilisWritable()
returnsfalse
.long
bytesBeforeWritable()
Get how many bytes must be drained from the underlying buffer untilisWritable()
returnstrue
.java.lang.Object
current()
Return the current message to write ornull
if nothing was flushed before and so is ready to be written.long
currentProgress()
Return the current message flush progress.void
forEachFlushedMessage(ChannelOutboundBuffer.MessageProcessor processor)
CallChannelOutboundBuffer.MessageProcessor.processMessage(Object)
for each flushed message in thisChannelOutboundBuffer
untilChannelOutboundBuffer.MessageProcessor.processMessage(Object)
returnsfalse
or there are no more flushed messages to process.boolean
getUserDefinedWritability(int index)
Returnstrue
if and only if the user-defined writability flag at the specified index is set totrue
.boolean
isEmpty()
boolean
isWritable()
Returnstrue
if and only if the total number of pending bytes did not exceed the write watermark of theChannel
and no user-defined writability flag has been set tofalse
.int
nioBufferCount()
Returns the number ofByteBuffer
that can be written out of theByteBuffer
array that was obtained vianioBuffers()
.java.nio.ByteBuffer[]
nioBuffers()
Returns an array of direct NIO buffers if the currently pending messages are made ofByteBuf
only.java.nio.ByteBuffer[]
nioBuffers(int maxCount, long maxBytes)
Returns an array of direct NIO buffers if the currently pending messages are made ofByteBuf
only.long
nioBufferSize()
Returns the number of bytes that can be written out of theByteBuffer
array that was obtained vianioBuffers()
.void
progress(long amount)
Notify theChannelPromise
of the current message about writing progress.void
recycle()
Deprecated.boolean
remove()
Will remove the current message, mark itsChannelPromise
as success and returntrue
.boolean
remove(java.lang.Throwable cause)
Will remove the current message, mark itsChannelPromise
as failure using the givenThrowable
and returntrue
.void
removeBytes(long writtenBytes)
Removes the fully written entries and update the reader index of the partially written entry.void
setUserDefinedWritability(int index, boolean writable)
Sets a user-defined writability flag at the specified index.int
size()
Returns the number of flushed messages in thisChannelOutboundBuffer
.long
totalPendingWriteBytes()
-
-
-
Method Detail
-
addMessage
public void addMessage(java.lang.Object msg, int size, ChannelPromise promise)
Add given message to thisChannelOutboundBuffer
. The givenChannelPromise
will be notified once the message was written.
-
addFlush
public void addFlush()
Add a flush to thisChannelOutboundBuffer
. This means all previous added messages are marked as flushed and so you will be able to handle them.
-
current
public java.lang.Object current()
Return the current message to write ornull
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 theChannelPromise
of the current message about writing progress.
-
remove
public boolean remove()
Will remove the current message, mark itsChannelPromise
as success and returntrue
. If no flushed message exists at the time this method is called it will returnfalse
to signal that no more messages are ready to be handled.
-
remove
public boolean remove(java.lang.Throwable cause)
Will remove the current message, mark itsChannelPromise
as failure using the givenThrowable
and returntrue
. If no flushed message exists at the time this method is called it will returnfalse
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 isByteBuf
.
-
nioBuffers
public java.nio.ByteBuffer[] nioBuffers()
Returns an array of direct NIO buffers if the currently pending messages are made ofByteBuf
only.nioBufferCount()
andnioBufferSize()
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 toNioSocketChannel.doWrite(ChannelOutboundBuffer)
for an example.
-
nioBuffers
public java.nio.ByteBuffer[] nioBuffers(int maxCount, long maxBytes)
Returns an array of direct NIO buffers if the currently pending messages are made ofByteBuf
only.nioBufferCount()
andnioBufferSize()
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 toNioSocketChannel.doWrite(ChannelOutboundBuffer)
for an example.- 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 1ByteBuffer
in the return value to ensure write progress is made.
-
nioBufferCount
public int nioBufferCount()
Returns the number ofByteBuffer
that can be written out of theByteBuffer
array that was obtained vianioBuffers()
. This method MUST be called afternioBuffers()
was called.
-
nioBufferSize
public long nioBufferSize()
Returns the number of bytes that can be written out of theByteBuffer
array that was obtained vianioBuffers()
. This method MUST be called afternioBuffers()
was called.
-
isWritable
public boolean isWritable()
Returnstrue
if and only if the total number of pending bytes did not exceed the write watermark of theChannel
and no user-defined writability flag has been set tofalse
.
-
getUserDefinedWritability
public boolean getUserDefinedWritability(int index)
Returnstrue
if and only if the user-defined writability flag at the specified index is set totrue
.
-
setUserDefinedWritability
public void setUserDefinedWritability(int index, boolean writable)
Sets a user-defined writability flag at the specified index.
-
size
public int size()
Returns the number of flushed messages in thisChannelOutboundBuffer
.
-
isEmpty
public boolean isEmpty()
-
recycle
@Deprecated public void recycle()
Deprecated.
-
totalPendingWriteBytes
public long totalPendingWriteBytes()
-
bytesBeforeUnwritable
public long bytesBeforeUnwritable()
Get how many bytes can be written untilisWritable()
returnsfalse
. This quantity will always be non-negative. IfisWritable()
isfalse
then 0.
-
bytesBeforeWritable
public long bytesBeforeWritable()
Get how many bytes must be drained from the underlying buffer untilisWritable()
returnstrue
. This quantity will always be non-negative. IfisWritable()
istrue
then 0.
-
forEachFlushedMessage
public void forEachFlushedMessage(ChannelOutboundBuffer.MessageProcessor processor) throws java.lang.Exception
CallChannelOutboundBuffer.MessageProcessor.processMessage(Object)
for each flushed message in thisChannelOutboundBuffer
untilChannelOutboundBuffer.MessageProcessor.processMessage(Object)
returnsfalse
or there are no more flushed messages to process.- Throws:
java.lang.Exception
-
-