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

Class PerMessageDeflateExtension

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

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:

LifeCycle, Extension, IncomingFrames, OutgoingFrames

public class PerMessageDeflateExtension
extends CompressExtension

Per Message Deflate Compression extension for WebSocket.

Attempts to follow Compression Extensions for WebSocket

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.LifeCycle

LifeCycle.Listener

Field Summary

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

decompressCount, INFLATE_BUFFER_SIZE, INPUT_MAX_BUFFER_SIZE, RSV_USE_ALWAYS, RSV_USE_ONLY_FIRST, TAIL_BYTES, TAIL_BYTES_BUF, 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	Description
PerMessageDeflateExtension()

Method Summary

Modifier and Type	Method	Description
java.lang.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)
java.lang.String	toString()

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

decompress, doStop, endsWithTail, forwardIncoming, getDeflater, getInflater, isRsv1User, newByteAccumulator, notifyCallbackFailure, notifyCallbackSuccess, outgoingFrame, setDeflaterPool, setInflaterPool

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

getBufferPool, getConfig, getConnection, getNextIncoming, getNextOutgoing, getPolicy, init, init, isRsv2User, isRsv3User, setBufferPool, setConnection, setNextIncomingFrames, setNextOutgoingFrames, setPolicy

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

addLifeCycleListener, doStart, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, setStopTimeout, 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 java.lang.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

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 java.lang.String toString()

Overrides:

toString in class CompressExtension