Package org.eclipse.jetty.websocket.core.util

Class FragmentingFlusher

java.lang.Object

org.eclipse.jetty.websocket.core.util.TransformingFlusher

org.eclipse.jetty.websocket.core.util.FragmentingFlusher

public abstract class FragmentingFlusher
extends TransformingFlusher

Used to split large data frames into multiple frames below the maxFrameSize. Control frames and dataFrames smaller than the maxFrameSize will be forwarded directly to forwardFrame(Frame, Callback, boolean).

Constructor Summary

Constructors

Constructor	Description
FragmentingFlusher(Configuration configuration)

Method Summary

Modifier and Type	Method	Description
protected abstract void	forwardFrame(Frame frame, Callback callback, boolean batch)
protected boolean	onFrame(Frame frame, Callback callback, boolean batch)	Called when a frame is ready to be transformed.
protected boolean	transform(Callback callback)	Called to transform the frame given in TransformingFlusher.onFrame(Frame, Callback, boolean).

Methods inherited from class org.eclipse.jetty.websocket.core.util.TransformingFlusher

closeFlusher, failFlusher, sendFrame

Methods inherited from class java.lang.Object

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

Constructor Details

FragmentingFlusher

public FragmentingFlusher(Configuration configuration)

Method Details

forwardFrame

protected abstract void forwardFrame(Frame frame,
 Callback callback,
 boolean batch)

onFrame

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

Description copied from class: TransformingFlusher

Called when a frame is ready to be transformed.

Specified by:

onFrame in class TransformingFlusher

Parameters:

frame - the frame to transform.

callback - used to signal to start processing again.

batch - whether this frame can be batched.

Returns:

true to indicate that you have finished transforming this frame.

transform

protected boolean transform(Callback callback)

Description copied from class: TransformingFlusher

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 TransformingFlusher.onFrame(Frame, Callback, boolean) returns true then this method will not be called.

Specified by:

transform in class TransformingFlusher

Parameters:

callback - used to signal to start processing again.

Returns:

true to indicate that you have finished transforming this frame.