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

Class DeflateFrameExtension

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

All Implemented Interfaces:

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

Direct Known Subclasses:

XWebkitDeflateFrameExtension

public class DeflateFrameExtension
extends CompressExtension

Implementation of the deflate-frame extension seen out in the wild.

Nested Class Summary

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 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
DeflateFrameExtension()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getName()	The Sec-WebSocket-Extensions name for this extension.
(package private) int	getRsvUseMode()	Return the mode of operation for RSV flag use in frames generate by compress (outgoing)
(package private) int	getTailDropMode()	Return the mode of operation for dropping (or keeping) tail bytes in frames generated by compress (outgoing)
void	incomingFrame(Frame frame)	Process the incoming frame.

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, toString

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

getBufferPool, getConfig, getConnection, getNextIncoming, getNextOutgoing, getPolicy, init, init, isRsv2User, isRsv3User, nextIncomingFrame, nextOutgoingFrame, setBufferPool, setConfig, 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

DeflateFrameExtension

public DeflateFrameExtension()

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

getRsvUseMode

int getRsvUseMode()

Description copied from class: CompressExtension

Return the mode of operation for RSV flag use in frames generate by compress (outgoing)

Specified by:

getRsvUseMode in class CompressExtension

Returns:

either CompressExtension.RSV_USE_ALWAYS or CompressExtension.RSV_USE_ONLY_FIRST

getTailDropMode

int getTailDropMode()

Description copied from class: CompressExtension

Return the mode of operation for dropping (or keeping) tail bytes in frames generated by compress (outgoing)

Specified by:

getTailDropMode in class CompressExtension

Returns:

either CompressExtension.TAIL_DROP_ALWAYS, CompressExtension.TAIL_DROP_FIN_ONLY, or CompressExtension.TAIL_DROP_NEVER

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