Class FragmentExtension

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.websocket.common.extensions.AbstractExtension

org.eclipse.jetty.websocket.common.extensions.fragment.FragmentExtension

All Implemented Interfaces:

org.eclipse.jetty.util.component.LifeCycle, Extension, IncomingFrames, OutgoingFrames

public class FragmentExtension
extends AbstractExtension

Fragment Extension

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	FragmentExtension.Flusher
private static class	FragmentExtension.FrameEntry

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

org.eclipse.jetty.util.component.LifeCycle.Listener

Field Summary

Fields

Modifier and Type	Field	Description
private final Queue<FragmentExtension.FrameEntry>	entries
private final org.eclipse.jetty.util.IteratingCallback	flusher
private static final org.eclipse.jetty.util.log.Logger	LOG
private int	maxLength

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Constructor Summary

Constructors

Constructor	Description
FragmentExtension()

Method Summary

Modifier and Type	Method	Description
String	getName()	The Sec-WebSocket-Extensions name for this extension.
void	incomingFrame(Frame frame)	Process the incoming frame.
private void	offerEntry(FragmentExtension.FrameEntry entry)
void	outgoingFrame(Frame frame, WriteCallback callback, BatchMode batchMode)	A frame, and optional callback, intended for the network layer.
private FragmentExtension.FrameEntry	pollEntry()
void	setConfig(ExtensionConfig config)

Methods inherited from class AbstractExtension

getBufferPool, getConfig, getConnection, getNextIncoming, getNextOutgoing, getPolicy, init, init, isRsv1User, isRsv2User, isRsv3User, nextIncomingFrame, nextOutgoingFrame, setBufferPool, setConnection, setNextIncomingFrames, setNextOutgoingFrames, setPolicy, toString

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

addLifeCycleListener, doStart, doStop, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, setStopTimeout, start, stop

Methods inherited from class Object

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

Field Details

LOG

private static final org.eclipse.jetty.util.log.Logger LOG

entries

private final Queue<FragmentExtension.FrameEntry> entries

flusher

private final org.eclipse.jetty.util.IteratingCallback flusher

maxLength

private int maxLength

Constructor Details

FragmentExtension

public FragmentExtension()

Method Details

getName

public String getName()

Description copied from interface: Extension

The Sec-WebSocket-Extensions name for this extension.

Also known as the extension-token per Section 9.1. Negotiating Extensions.

Specified by:

getName in interface Extension

Overrides:

getName in class AbstractExtension

Returns:

the name of the extension

incomingFrame

public void incomingFrame(Frame frame)

Description copied from interface: IncomingFrames

Process the incoming frame.

Note: if you need to hang onto any information from the frame, be sure to copy it, as the information contained in the Frame will be released and/or reused by the implementation.

Parameters:

frame - the frame to process

outgoingFrame

public void outgoingFrame(Frame frame,
 WriteCallback callback,
 BatchMode batchMode)

Description copied from interface: OutgoingFrames

A frame, and optional callback, intended for the network layer.

Note: the frame can undergo many transformations in the various layers and extensions present in the implementation.

If you are implementing a mutation, you are obliged to handle the incoming WriteCallback appropriately.

Parameters:

frame - the frame to eventually write to the network layer.

callback - the callback to notify when the frame is written.

batchMode - the batch mode requested by the sender.

setConfig

public void setConfig(ExtensionConfig config)

Overrides:

setConfig in class AbstractExtension

offerEntry

private void offerEntry(FragmentExtension.FrameEntry entry)

pollEntry

private FragmentExtension.FrameEntry pollEntry()