Class MessageFlusher

java.lang.Object

org.eclipse.jetty.util.IteratingCallback

org.eclipse.jetty.http3.MessageFlusher

All Implemented Interfaces:

Callback, Invocable

public class MessageFlusher
extends IteratingCallback

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MessageFlusher.FlushFrame

Nested classes/interfaces inherited from class IteratingCallback

IteratingCallback.Action

Nested classes/interfaces inherited from interface Callback

Callback.Completable, Callback.Completing, Callback.Nested

Nested classes/interfaces inherited from interface Invocable

Invocable.Callable, Invocable.InvocationType, Invocable.ReadyTask, Invocable.Task

Field Summary

Fields inherited from interface Callback

NOOP

Fields inherited from interface Invocable

__nonBlocking

Constructor Summary

Constructors

Constructor	Description
MessageFlusher(ByteBufferPool bufferPool, QpackEncoder encoder, boolean useDirectByteBuffers)

Method Summary

Modifier and Type	Method	Description
Invocable.InvocationType	getInvocationType()
boolean	offer(QuicStreamEndPoint endPoint, Frame frame, Callback callback)
protected void	onCompleteFailure(Throwable cause)	Invoked when the overall task has completed with a failure.
protected void	onSuccess()	Invoked when one task has completed successfully, either by the caller thread or by the processing thread.
protected IteratingCallback.Action	process()	Method called by IteratingCallback.iterate() to process the asynchronous sub-task.

Methods inherited from class IteratingCallback

abort, close, failed, isAborted, isClosed, isFailed, isSucceeded, iterate, onCompleteSuccess, reset, succeeded, toString

Methods inherited from class Object

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

Methods inherited from interface Callback

completeWith

Constructor Details

MessageFlusher

public MessageFlusher(ByteBufferPool bufferPool,
 QpackEncoder encoder,
 boolean useDirectByteBuffers)

Method Details

offer

public boolean offer(QuicStreamEndPoint endPoint,
 Frame frame,
 Callback callback)

process

protected IteratingCallback.Action process()

Description copied from class: IteratingCallback

Method called by IteratingCallback.iterate() to process the asynchronous sub-task.

Implementations must initiate the asynchronous execution of the sub-task (if any) and return an appropriate action:

• IteratingCallback.Action.IDLE when no sub tasks are available for execution but the overall job is not completed yet
• IteratingCallback.Action.SCHEDULED when the sub task asynchronous execution has been started
• IteratingCallback.Action.SUCCEEDED when the overall job is completed

Specified by:

process in class IteratingCallback

Returns:

the appropriate Action

onSuccess

protected void onSuccess()

Description copied from class: IteratingCallback

Invoked when one task has completed successfully, either by the caller thread or by the processing thread. This invocation is always serialized w.r.t the execution of IteratingCallback.process().

This method is not invoked when a call to IteratingCallback.abort(Throwable) is made before the IteratingCallback.succeeded() callback happens.

Overrides:

onSuccess in class IteratingCallback

onCompleteFailure

protected void onCompleteFailure(Throwable cause)

Description copied from class: IteratingCallback

Invoked when the overall task has completed with a failure.

Overrides:

onCompleteFailure in class IteratingCallback

Parameters:

cause - the throwable to indicate cause of failure

See Also:

• IteratingCallback.onCompleteSuccess()

getInvocationType

public Invocable.InvocationType getInvocationType()

Returns:

The InvocationType of this object