Package org.eclipse.jetty.websocket.core.internal

Class FrameFlusher

java.lang.Object

org.eclipse.jetty.util.IteratingCallback

org.eclipse.jetty.websocket.core.internal.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, Invocable.ReadyTask, Invocable.Task

Field Summary

Fields

Modifier and Type	Field	Description
static final Frame	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, Scheduler scheduler, Generator generator, EndPoint endPoint, int bufferSize, int maxGather)

Method Summary

Modifier and Type	Method	Description
boolean	enqueue(Frame frame, Callback callback, boolean batch)	Enqueue a Frame to be written to the endpoint.
long	getBytesOut()
long	getIdleTimeout()
long	getMessagesOut()
boolean	isUseDirectByteBuffers()
protected void	notifyCallbackFailure(Callback callback, Throwable failure)
protected void	notifyCallbackSuccess(Callback callback)
void	onClose(Throwable cause)
void	onCompleteFailure(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	setIdleTimeout(long idleTimeout)
void	setUseDirectByteBuffers(boolean useDirectByteBuffers)
void	timeoutExpired()
String	toString()

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

close, failed, isClosed, isFailed, isSucceeded, iterate, 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

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

getInvocationType

Field Details

FLUSH_FRAME

public static final Frame FLUSH_FRAME

Constructor Details

FrameFlusher

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

Method Details

isUseDirectByteBuffers

public boolean isUseDirectByteBuffers()

setUseDirectByteBuffers

public void setUseDirectByteBuffers(boolean useDirectByteBuffers)

enqueue

public boolean enqueue(Frame frame,
 Callback callback,
 boolean batch)

Enqueue a Frame to be written to the endpoint.

Parameters:

frame - The frame to queue

callback - The callback to call once the frame is sent

batch - True if batch mode is to be used

Returns:

returns true if the frame was enqueued and iterate needs to be called, returns false if the FrameFlusher was closed

onClose

public void onClose(Throwable cause)

process

protected IteratingCallback.Action process()
                                    throws 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:

Throwable - if the sub-task processing throws

timeoutExpired

public void timeoutExpired()

onCompleteFailure

public void onCompleteFailure(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(Callback callback)

notifyCallbackFailure

protected void notifyCallbackFailure(Callback callback,
 Throwable failure)

setIdleTimeout

public void setIdleTimeout(long idleTimeout)

getIdleTimeout

public long getIdleTimeout()

getMessagesOut

public long getMessagesOut()

getBytesOut

public long getBytesOut()

toString

public String toString()

Overrides:

toString in class IteratingCallback