This is used to iteratively transform or process a frame into one or more other frames. When a frame is ready to be processed onFrame(Frame, Callback, boolean) is called. Subsequent calls to transform(Callback) are made on each callback success until one of these calls returns true to indicate they are done processing the frame and are ready to receive a new one. The Callback passed in to both these method must be succeeded in order to continue processing.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private class	TransformingFlusher.Flusher

Field Summary

Modifier and Type	Field and Description
private final Queue<FrameEntry>	entries
private Throwable	failure
private boolean	finished
private final IteratingCallback	flusher
private final AutoLock	lock
private final Logger	log
private static final Throwable	SENTINEL_CLOSE_EXCEPTION

Access	Constructor and Description
public	TransformingFlusher()

Method Summary

Modifier and Type	Method and Description
public void	closeFlusher() Used to close this flusher when there is no explicit failure.
public void	failFlusher(Throwable the failure. t) Used to fail this flusher possibly from an external event such as a callback.
private void	notifyCallbackFailure(Callback callback, Throwable failure)
private void	notifyCallbackSuccess(Callback callback)
private void	onFailure(Throwable t)
protected abstract boolean	Returns: true to indicate that you have finished transforming this frame. onFrame(Frame the frame to transform. frame, Callback used to signal to start processing again. callback, boolean whether this frame can be batched. batch) Called when a frame is ready to be transformed.
private FrameEntry	pollEntry()
public final void	sendFrame(Frame frame, Callback callback, boolean batch)
protected abstract boolean	Returns: true to indicate that you have finished transforming this frame. transform(Callback used to signal to start processing again. callback) Called to transform the frame given in `TransformingFlusher#onFrame(Frame, Callback, boolean)`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

entries	back to summary
private final Queue<FrameEntry> entries

failure	back to summary
private Throwable failure

finished	back to summary
private boolean finished

flusher	back to summary
private final IteratingCallback flusher

lock	back to summary
private final AutoLock lock

log	back to summary
private final Logger log

SENTINEL_CLOSE_EXCEPTION	back to summary
private static final Throwable SENTINEL_CLOSE_EXCEPTION

TransformingFlusher	back to summary
public TransformingFlusher()

Method Detail

closeFlusher	back to summary
public void closeFlusher() Used to close this flusher when there is no explicit failure.

failFlusher	back to summary
public void failFlusher(Throwable t) Used to fail this flusher possibly from an external event such as a callback. Parameters t:Throwable the failure.

failFlusher

back to summary

public void failFlusher(Throwable t)

Used to fail this flusher possibly from an external event such as a callback.

Parameters

t:Throwable: the failure.

notifyCallbackFailure	back to summary
private void notifyCallbackFailure(Callback callback, Throwable failure)

notifyCallbackSuccess	back to summary
private void notifyCallbackSuccess(Callback callback)

onFailure	back to summary
private void onFailure(Throwable t)

onFrame	back to summary
protected abstract boolean onFrame(Frame frame, Callback callback, boolean batch) Called when a frame is ready to be transformed. Parameters frame:Frame the frame to transform. callback:Callback used to signal to start processing again. batch:boolean whether this frame can be batched. Returns:boolean true to indicate that you have finished transforming this frame.

onFrame

back to summary

protected abstract boolean onFrame(Frame frame, Callback callback, boolean batch)

Called when a frame is ready to be transformed.

Parameters

frame:Frame: the frame to transform.
callback:Callback: used to signal to start processing again.
batch:boolean: whether this frame can be batched.

Returns:boolean

true to indicate that you have finished transforming this frame.

pollEntry	back to summary
private FrameEntry pollEntry()

sendFrame	back to summary
public final void sendFrame(Frame frame, Callback callback, boolean batch)

transform back to summary

transform	back to summary
protected abstract boolean transform(Callback callback) Called to transform the frame given in `TransformingFlusher#onFrame(Frame, Callback, boolean)`. This method is called on each callback success until it returns true. If the call to `onFrame(Frame, Callback, boolean)` returns true then this method will not be called. Parameters callback:Callback used to signal to start processing again. Returns:boolean true to indicate that you have finished transforming this frame.

protected abstract boolean transform(Callback callback)

Called to transform the frame given in TransformingFlusher#onFrame(Frame, Callback, boolean). This method is called on each callback success until it returns true. If the call to onFrame(Frame, Callback, boolean) returns true then this method will not be called.

Parameters

callback:Callback: used to signal to start processing again.

Returns:boolean

true to indicate that you have finished transforming this frame.

org.eclipse.jetty.websocket.core.util back to summary

private Class TransformingFlusher.Flusher

Class Inheritance

extends IteratingCallback
implements Callback

java.lang.Object
org.eclipse.jetty.util.IteratingCallback
org.eclipse.jetty.websocket.core.util.TransformingFlusher.Flusher

All Implemented Interfaces

org.eclipse.jetty.util.Callback, org.eclipse.jetty.util.thread.Invocable

Field Summary

Modifier and Type	Field and Description
private FrameEntry	current

Constructor Summary

Access	Constructor and Description
private	Flusher()

Method Summary

Modifier and Type	Method and Description
protected void	onCompleteFailure(Throwable the throwable to indicate cause of failure t) Overrides org.eclipse.jetty.util.IteratingCallback.onCompleteFailure. Invoked when the overall task has completed with a failure.
protected IteratingCallback.Action	process() Implements abstract org.eclipse.jetty.util.IteratingCallback.process. Method called by `iterate()` to process the asynchronous sub-task.

Inherited from org.eclipse.jetty.util.IteratingCallback:: abort close failed isAborted isClosed isFailed isSucceeded iterate onCompleteSuccess reset succeeded toString

Field Detail

current	back to summary
private FrameEntry current

Constructor Detail

Flusher	back to summary
private Flusher()

Method Detail

onCompleteFailure	back to summary
protected void onCompleteFailure(Throwable t) Overrides org.eclipse.jetty.util.IteratingCallback.onCompleteFailure. Doc from org.eclipse.jetty.util.IteratingCallback.onCompleteFailure. Invoked when the overall task has completed with a failure. Parameters t:Throwable the throwable to indicate cause of failure Annotations @Override

onCompleteFailure

back to summary

protected void onCompleteFailure(Throwable t)

Overrides org.eclipse.jetty.util.IteratingCallback.onCompleteFailure.

Doc from org.eclipse.jetty.util.IteratingCallback.onCompleteFailure.

Invoked when the overall task has completed with a failure.

Parameters

t:Throwable: the throwable to indicate cause of failure

Annotations

@Override

process back to summary

process	back to summary
protected IteratingCallback.Action process() throws Throwable Implements abstract org.eclipse.jetty.util.IteratingCallback.process. Doc from org.eclipse.jetty.util.IteratingCallback.process. Method called by `iterate()` to process the asynchronous sub-task. Implementations must initiate the asynchronous execution of the sub-task (if any) and return an appropriate action: `Action#IDLE` when no sub tasks are available for execution but the overall job is not completed yet `Action#SCHEDULED` when the sub task asynchronous execution has been started `Action#SUCCEEDED` when the overall job is completed Returns:IteratingCallback.Action the appropriate Action Annotations @Override Exceptions Throwable: if the sub-task processing throws

protected IteratingCallback.Action process() throws Throwable

Implements abstract org.eclipse.jetty.util.IteratingCallback.process.

Doc from org.eclipse.jetty.util.IteratingCallback.process.

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

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

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

Returns:IteratingCallback.Action

the appropriate Action

Annotations

@Override

Exceptions

Throwable:: if the sub-task processing throws

public abstract Class TransformingFlusher

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class TransformingFlusher.Flusher

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail