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 interface org.eclipse.jetty.util.Callback

Callback.Completable, Callback.Completing, Callback.InvocableCallback, Callback.Nested

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

Invocable.InvocationType

Field Summary

Fields

Modifier and Type	Field and 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 and Description
FrameFlusher(ByteBufferPool bufferPool, Generator generator, EndPoint endPoint, int bufferSize, int maxGather)

Method Summary

Modifier and Type	Method and Description
boolean	enqueue(Frame frame, WriteCallback callback, BatchMode batchMode)
long	getBytesOut()
long	getMessagesOut()
void	onCompleteFailure(Throwable failure) Invoked when the overall task has completed with a failure.
void	succeeded() Invoked when the sub task succeeds.
String	toString()

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

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

combine, from, from, from, from, from, from

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

combine, getInvocationType, getInvocationType, invokeNonBlocking, isNonBlockingInvocation

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)

succeeded

public void succeeded()

Description copied from class: IteratingCallback

Invoked when the 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(Throwable failure)

Description copied from class: IteratingCallback

Invoked when the overall task has completed with a failure.

Parameters:

failure - the throwable to indicate cause of failure

See Also:

IteratingCallback.onCompleteSuccess()

getMessagesOut

public long getMessagesOut()

getBytesOut

public long getBytesOut()

toString

public String toString()

Overrides:

toString in class IteratingCallback