Package org.eclipse.jetty.io

Class WriteFlusher

java.lang.Object

org.eclipse.jetty.io.WriteFlusher

public abstract class WriteFlusher
extends Object

A Utility class to help implement EndPoint.write(Callback, ByteBuffer...) by calling EndPoint.flush(ByteBuffer...) until all content is written. The abstract method onIncompleteFlush() is called when not all content has been written after a call to flush and should organize for the completeWrite() method to be called when a subsequent call to flush should be able to make more progress.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WriteFlusher.Listener	Deprecated, for removal: This API element is subject to removal in a future version. functionality removed, no replacement

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WriteFlusher(EndPoint endPoint)

Method Summary

Modifier and Type	Method	Description
void	completeWrite()	Complete a write that has not completed and that called onIncompleteFlush() to request a call to this method when a call to EndPoint.flush(ByteBuffer...) is likely to be able to progress.
protected ByteBuffer[]	flush(SocketAddress address, ByteBuffer[] buffers)	Flushes the buffers iteratively until no progress is made.
Invocable.InvocationType	getCallbackInvocationType()
boolean	isPending()
void	onClose()
boolean	onFail(Throwable cause)	Notify the flusher of a failure
protected abstract void	onIncompleteFlush()	Abstract call to be implemented by specific WriteFlushers.
String	toStateString()
String	toString()
void	write(Callback callback, SocketAddress address, ByteBuffer... buffers)
void	write(Callback callback, ByteBuffer... buffers)	Tries to switch state to WRITING.

Methods inherited from class java.lang.Object

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

Constructor Details

WriteFlusher

protected WriteFlusher(EndPoint endPoint)

Method Details

getCallbackInvocationType

public Invocable.InvocationType getCallbackInvocationType()

onIncompleteFlush

protected abstract void onIncompleteFlush()

Abstract call to be implemented by specific WriteFlushers. It should schedule a call to completeWrite() or onFail(Throwable) when appropriate.

write

public void write(Callback callback,
 ByteBuffer... buffers)
           throws WritePendingException

Tries to switch state to WRITING. If successful it writes the given buffers to the EndPoint. If state transition fails it will fail the callback and leave the WriteFlusher in a terminal FAILED state. If not all buffers can be written in one go it creates a new PendingState object to preserve the state and then calls onIncompleteFlush(). The remaining buffers will be written in completeWrite(). If all buffers have been written it calls callback.complete().

Parameters:

callback - the callback to call on either failed or complete

buffers - the buffers to flush to the endpoint

Throws:

WritePendingException - if unable to write due to prior pending write

write

public void write(Callback callback,
 SocketAddress address,
 ByteBuffer... buffers)
           throws WritePendingException

Throws:

WritePendingException

completeWrite

public void completeWrite()

Complete a write that has not completed and that called onIncompleteFlush() to request a call to this method when a call to EndPoint.flush(ByteBuffer...) is likely to be able to progress. It tries to switch from PENDING to COMPLETING. If state transition fails, then it does nothing as the callback should have been already failed. That's because the only way to switch from PENDING outside this method is onFail(Throwable) or onClose()

flush

protected ByteBuffer[] flush(SocketAddress address,
 ByteBuffer[] buffers)
                      throws IOException

Flushes the buffers iteratively until no progress is made.

Parameters:

address - the datagram channel to send the buffers to (used by QUIC and HTTP/3)

buffers - The buffers to flush

Returns:

The unflushed buffers, or null if all flushed

Throws:

IOException - if unable to flush

onFail

public boolean onFail(Throwable cause)

Notify the flusher of a failure

Parameters:

cause - The cause of the failure

Returns:

true if the flusher passed the failure to a Callback instance

onClose

public void onClose()

isPending

public boolean isPending()

toStateString

public String toStateString()

toString

public String toString()

Overrides:

toString in class Object