Module io.netty5.transport

Package io.netty5.channel

Class AbstractChannel.WriteSink

java.lang.Object

io.netty5.channel.AbstractChannel.WriteSink

Enclosing class:

AbstractChannel<P extends Channel,L extends SocketAddress,R extends SocketAddress>

protected final class AbstractChannel.WriteSink
extends Object

Sink that will be used by #doWriteNow(WriteSink) implementations.

Method Summary

Modifier and Type	Method	Description
void	complete(long attemptedBytesWrite, long actualBytesWrite, int messagesWritten, boolean mightContinueWriting)	Notify of the last write operation and its result.
void	complete(long attemptedBytesWrite, Throwable cause, boolean mightContinueWriting)	Notify of the last write operation and its result.
Object	currentFlushedMessage()	Return the current message that should be written.
long	estimatedMaxBytesPerGatheringWrite()	Return the estimated maximum number of bytes that can be written with one gathering write operation.
void	forEachFlushedMessage(Predicate<Object> processor)	Call Predicate.test(Object) for each message that is flushed until Predicate.test(Object) returns false or there are no more flushed messages.
int	numFlushedMessages()	The number of flushed messages that are ready to be written.
int	updateBufferReaderOffsets(long writtenBytes)	Update the Buffer.readerOffset() of each buffer and return the number of completely written Buffers.

Methods inherited from class java.lang.Object

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

Method Detail

updateBufferReaderOffsets

public int updateBufferReaderOffsets(long writtenBytes)

Update the Buffer.readerOffset() of each buffer and return the number of completely written Buffers.

Parameters:

writtenBytes - the number of written bytes.

Returns:

the number of completely written buffers.

estimatedMaxBytesPerGatheringWrite

public long estimatedMaxBytesPerGatheringWrite()

Return the estimated maximum number of bytes that can be written with one gathering write operation.

Returns:

number of bytes.

numFlushedMessages

public int numFlushedMessages()

The number of flushed messages that are ready to be written. The messages can be accessed by either calling currentFlushedMessage() or forEachFlushedMessage(Predicate).

Returns:

the number of messages.

currentFlushedMessage

public Object currentFlushedMessage()

Return the current message that should be written.

Returns:

the first flushed message.

forEachFlushedMessage

public void forEachFlushedMessage(Predicate<Object> processor)

Call Predicate.test(Object) for each message that is flushed until Predicate.test(Object) returns false or there are no more flushed messages.

Parameters:

processor - the Function to use.

Throws:

IllegalStateException - if called after complete(long, long, int, boolean) or complete(long, Throwable, boolean) was called.

complete

public void complete(long attemptedBytesWrite,
                     long actualBytesWrite,
                     int messagesWritten,
                     boolean mightContinueWriting)

Notify of the last write operation and its result.

Parameters:

attemptedBytesWrite - The number of bytes the write operation did attempt to write.

actualBytesWrite - The number of bytes from the previous write operation. This may be negative if a write error occurs.

messagesWritten - The number of written messages, this can never be greater than numFlushedMessages().

mightContinueWriting - true if the write loop might continue writing messages, false otherwise

Throws:

IllegalStateException - if called after complete(long, long, int, boolean) or complete(long, Throwable, boolean) was called.

complete

public void complete(long attemptedBytesWrite,
                     Throwable cause,
                     boolean mightContinueWriting)

Notify of the last write operation and its result.

Parameters:

attemptedBytesWrite - The number of bytes the write operation did attempt to write.

cause - The error that happened during the write operation and can be recovered.

mightContinueWriting - true if the write loop might continue writing messages, false otherwise.

Throws:

IllegalStateException - if called after complete(long, long, int, boolean) or complete(long, Throwable, boolean) was called.