Class ControlFlusher

java.lang.Object

org.eclipse.jetty.util.IteratingCallback

org.eclipse.jetty.http3.ControlFlusher

All Implemented Interfaces:

Callback, Invocable

public class ControlFlusher
extends IteratingCallback

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jetty.util.IteratingCallback

IteratingCallback.Action

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.Callback

Callback.Combination, Callback.Completable, Callback.Completing, Callback.Nested

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.thread.Invocable

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

Field Summary

Fields inherited from interface org.eclipse.jetty.util.Callback

NOOP, NOT_CALLED

Fields inherited from interface org.eclipse.jetty.util.thread.Invocable

__nonBlocking

Constructor Summary

Constructors

Constructor	Description
ControlFlusher(ByteBufferPool byteBufferPool, StreamEndPoint endPoint, boolean useDirectByteBuffers)

Method Summary

Modifier and Type	Method	Description
Invocable.InvocationType	getInvocationType()
boolean	offer(Frame frame, Callback callback)
protected void	onCompleteFailure(Throwable cause)	Invoked when the overall task has completed with a failure.
protected void	onFailure(Throwable failure)	Invoked when the overall task has been aborted or failed.
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.
String	toString()

Methods inherited from class org.eclipse.jetty.util.IteratingCallback

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jetty.util.Callback

completeWith

Constructor Details

ControlFlusher

public ControlFlusher(ByteBufferPool byteBufferPool,
 StreamEndPoint endPoint,
 boolean useDirectByteBuffers)

Method Details

offer

public boolean offer(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

onFailure

protected void onFailure(Throwable failure)

Description copied from class: IteratingCallback

Invoked when the overall task has been aborted or failed.

Calls to this method are serialized with respect to IteratingCallback.onAborted(Throwable), IteratingCallback.process(), IteratingCallback.onCompleteFailure(Throwable) and IteratingCallback.onCompleted(Throwable).

Because onFailure can be called due to an IteratingCallback.abort(Throwable) or IteratingCallback.close() operation, it is possible that any resources passed to a IteratingCallback.Action.SCHEDULED operation may still be in use, and thus should not be recycled by this call. For example any buffers passed to a write operation should not be returned to a buffer pool by implementations of onFailure. Such resources may be discarded here, or safely recycled in a subsequent call to IteratingCallback.onCompleted(Throwable) or IteratingCallback.onCompleteFailure(Throwable), when the IteratingCallback.Action.SCHEDULED operation has completed.

Overrides:

onFailure in class IteratingCallback

Parameters:

failure - The cause of the failure or abort

See Also:

• IteratingCallback.onCompleted(Throwable)
• IteratingCallback.onCompleteFailure(Throwable)

onCompleteFailure

protected void onCompleteFailure(Throwable cause)

Description copied from class: IteratingCallback

Invoked when the overall task has completed with a failure.

Calls to this method are serialized with respect to IteratingCallback.process(), IteratingCallback.onAborted(Throwable) and IteratingCallback.onCompleted(Throwable). If this method is called, then IteratingCallback.onCompleteSuccess() will never be called.

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

toString

public String toString()

Overrides:

toString in class IteratingCallback