org.eclipse.jetty.websocket.common.extensions.compress

Class PerMessageDeflateExtension

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

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

org.eclipse.jetty.websocket.common.extensions.compress.CompressExtension

org.eclipse.jetty.websocket.common.extensions.compress.PerMessageDeflateExtension

All Implemented Interfaces:

Container, Destroyable, Dumpable, LifeCycle, Extension, IncomingFrames, OutgoingFrames

public class PerMessageDeflateExtension
extends CompressExtension

Per Message Deflate Compression extension for WebSocket.

Attempts to follow draft-ietf-hybi-permessage-compression-12

Nested Class Summary

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

AbstractLifeCycle.AbstractLifeCycleListener

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

Container.InheritedListener, Container.Listener

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

LifeCycle.Listener

Field Summary

Fields inherited from class org.eclipse.jetty.websocket.common.extensions.compress.CompressExtension

RSV_USE_ALWAYS, RSV_USE_ONLY_FIRST, TAIL_BYTES, TAIL_DROP_ALWAYS, TAIL_DROP_FIN_ONLY, TAIL_DROP_NEVER

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

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Constructor Summary

Constructors

Constructor and Description
PerMessageDeflateExtension()

Method Summary

Methods

Modifier and Type	Method and Description
String	getName() The Sec-WebSocket-Extensions name for this extension.
void	incomingFrame(Frame frame) Process the incoming frame.
protected void	nextIncomingFrame(Frame frame)
protected void	nextOutgoingFrame(Frame frame, WriteCallback callback, BatchMode batchMode)
void	setConfig(ExtensionConfig config)
String	toString()

Methods inherited from class org.eclipse.jetty.websocket.common.extensions.compress.CompressExtension

decompress, forwardIncoming, getDeflater, getInflater, isRsv1User, notifyCallbackFailure, notifyCallbackSuccess, outgoingFrame

Methods inherited from class org.eclipse.jetty.websocket.common.extensions.AbstractExtension

dump, dumpWithHeading, getBufferPool, getConfig, getConnection, getNextIncoming, getNextOutgoing, getPolicy, incomingError, isRsv2User, isRsv3User, nextIncomingError, setBufferPool, setConnection, setNextIncomingFrames, setNextOutgoingFrames, setPolicy

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

addBean, addBean, addBean, addEventListener, addManaged, contains, destroy, doStart, doStop, dump, dump, dump, dump, dumpBeans, dumpObject, dumpStdErr, dumpThis, getBean, getBeans, getBeans, isManaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, updateBean, updateBeans

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

PerMessageDeflateExtension

public PerMessageDeflateExtension()

Method Detail

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

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

nextIncomingFrame

protected void nextIncomingFrame(Frame frame)

Overrides:

nextIncomingFrame in class AbstractExtension

nextOutgoingFrame

protected void nextOutgoingFrame(Frame frame,
                     WriteCallback callback,
                     BatchMode batchMode)

Overrides:

nextOutgoingFrame in class AbstractExtension

setConfig

public void setConfig(ExtensionConfig config)

Overrides:

setConfig in class AbstractExtension

toString

public String toString()

Overrides:

toString in class CompressExtension