Package org.eclipse.jetty.websocket.common.io

Class FrameFlusher

java.lang.Object

org.eclipse.jetty.util.IteratingCallback

org.eclipse.jetty.websocket.common.io.FrameFlusher

All Implemented Interfaces:

Callback, Invocable

public class FrameFlusher
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.Completable, Callback.Completing, Callback.Nested

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

Invocable.InvocationType

Field Summary

Fields

Modifier and Type	Field	Description
static BinaryFrame	FLUSH_FRAME

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

NOOP

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

__nonBlocking

Constructor Summary

Constructors

Constructor	Description
FrameFlusher(ByteBufferPool bufferPool, Generator generator, EndPoint endPoint, int bufferSize, int maxGather)

Method Summary

Modifier and Type	Method	Description
boolean	enqueue(Frame frame, WriteCallback callback, BatchMode batchMode)
long	getBytesOut()
long	getMessagesOut()
protected void	notifyCallbackFailure(WriteCallback callback, java.lang.Throwable failure)
protected void	notifyCallbackSuccess(WriteCallback callback)
void	onCompleteFailure(java.lang.Throwable failure)	Invoked when the overall task has completed with a failure.
protected IteratingCallback.Action	process()	Method called by IteratingCallback.iterate() to process the asynchronous sub-task.
void	succeeded()	Method to invoke when the asynchronous sub-task succeeds.
java.lang.String	toString()

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

close, failed, isClosed, isFailed, isSucceeded, iterate, onCompleteSuccess, reset

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.thread.Invocable

getInvocationType

Field Detail

FLUSH_FRAME

public static final BinaryFrame FLUSH_FRAME

Constructor Detail

FrameFlusher

public FrameFlusher(ByteBufferPool bufferPool,
                    Generator generator,
                    EndPoint endPoint,
                    int bufferSize,
                    int maxGather)

Method Detail

enqueue

public boolean enqueue(Frame frame,
                       WriteCallback callback,
                       BatchMode batchMode)

process

protected IteratingCallback.Action process()
                                    throws java.lang.Throwable

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

Throws:

java.lang.Throwable - if the sub-task processing throws

succeeded

public void succeeded()

Description copied from class: IteratingCallback

Method to invoke when the asynchronous sub-task succeeds.

Subclasses that override this method must always remember to call super.succeeded().

Specified by:

succeeded in interface Callback

Overrides:

succeeded in class IteratingCallback

See Also:

Callback.failed(Throwable)

onCompleteFailure

public void onCompleteFailure(java.lang.Throwable failure)

Description copied from class: IteratingCallback

Invoked when the overall task has completed with a failure.

Overrides:

onCompleteFailure in class IteratingCallback

Parameters:

failure - the throwable to indicate cause of failure

See Also:

IteratingCallback.onCompleteSuccess()

notifyCallbackSuccess

protected void notifyCallbackSuccess(WriteCallback callback)

notifyCallbackFailure

protected void notifyCallbackFailure(WriteCallback callback,
                                     java.lang.Throwable failure)

getMessagesOut

public long getMessagesOut()

getBytesOut

public long getBytesOut()

toString

public java.lang.String toString()

Overrides:

toString in class IteratingCallback