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

Class CompressExtension

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

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

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

All Implemented Interfaces:

LifeCycle, Extension, IncomingFrames, OutgoingFrames

Direct Known Subclasses:

DeflateFrameExtension, PerMessageDeflateExtension

public abstract class CompressExtension
extends AbstractExtension

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

Modifier and Type	Field	Description
protected java.util.concurrent.atomic.AtomicInteger	decompressCount
protected static int	INFLATE_BUFFER_SIZE	Inflater / Decompressed Buffer Size
protected static int	INPUT_MAX_BUFFER_SIZE	Deflater / Inflater: Maximum Input Buffer Size
protected static int	RSV_USE_ALWAYS	Always set RSV flag, on all frame types
protected static int	RSV_USE_ONLY_FIRST	Only set RSV flag on first frame in multi-frame messages.
protected static byte[]	TAIL_BYTES
protected static java.nio.ByteBuffer	TAIL_BYTES_BUF
protected static int	TAIL_DROP_ALWAYS	Always drop tail bytes 0000FFFF, from all frame types
protected static int	TAIL_DROP_FIN_ONLY	Only drop tail bytes 0000FFFF, from fin==true frames
protected static int	TAIL_DROP_NEVER	Never drop tail bytes 0000FFFF, from any frame type

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

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CompressExtension()

Method Summary

Modifier and Type	Method	Description
protected void	decompress(ByteAccumulator accumulator, java.nio.ByteBuffer buf)
protected void	doStop()
static boolean	endsWithTail(java.nio.ByteBuffer buf)
protected void	forwardIncoming(Frame frame, ByteAccumulator accumulator)
java.util.zip.Deflater	getDeflater()
java.util.zip.Inflater	getInflater()
boolean	isRsv1User()	Indicates use of RSV1 flag for indicating deflation is in use.
protected ByteAccumulator	newByteAccumulator()
protected void	notifyCallbackFailure(WriteCallback callback, java.lang.Throwable failure)
protected void	notifyCallbackSuccess(WriteCallback callback)
void	outgoingFrame(Frame frame, WriteCallback callback, BatchMode batchMode)	A frame, and optional callback, intended for the network layer.
void	setDeflaterPool(DeflaterPool deflaterPool)
void	setInflaterPool(InflaterPool inflaterPool)
java.lang.String	toString()

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

getBufferPool, getConfig, getConnection, getName, 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

Methods inherited from interface org.eclipse.jetty.websocket.api.extensions.IncomingFrames

incomingFrame

Field Detail

TAIL_BYTES

protected static final byte[] TAIL_BYTES

TAIL_BYTES_BUF

protected static final java.nio.ByteBuffer TAIL_BYTES_BUF

TAIL_DROP_NEVER

protected static final int TAIL_DROP_NEVER

Never drop tail bytes 0000FFFF, from any frame type

See Also:

Constant Field Values

TAIL_DROP_ALWAYS

protected static final int TAIL_DROP_ALWAYS

Always drop tail bytes 0000FFFF, from all frame types

See Also:

Constant Field Values

TAIL_DROP_FIN_ONLY

protected static final int TAIL_DROP_FIN_ONLY

Only drop tail bytes 0000FFFF, from fin==true frames

See Also:

Constant Field Values

RSV_USE_ALWAYS

protected static final int RSV_USE_ALWAYS

Always set RSV flag, on all frame types

See Also:

Constant Field Values

RSV_USE_ONLY_FIRST

protected static final int RSV_USE_ONLY_FIRST

Only set RSV flag on first frame in multi-frame messages.

Note: this automatically means no-continuation frames have the RSV bit set

See Also:

Constant Field Values

INFLATE_BUFFER_SIZE

protected static final int INFLATE_BUFFER_SIZE

Inflater / Decompressed Buffer Size

See Also:

Constant Field Values

INPUT_MAX_BUFFER_SIZE

protected static final int INPUT_MAX_BUFFER_SIZE

Deflater / Inflater: Maximum Input Buffer Size

See Also:

Constant Field Values

decompressCount

protected java.util.concurrent.atomic.AtomicInteger decompressCount

Constructor Detail

CompressExtension

protected CompressExtension()

Method Detail

setInflaterPool

public void setInflaterPool(InflaterPool inflaterPool)

setDeflaterPool

public void setDeflaterPool(DeflaterPool deflaterPool)

getDeflater

public java.util.zip.Deflater getDeflater()

getInflater

public java.util.zip.Inflater getInflater()

isRsv1User

public boolean isRsv1User()

Indicates use of RSV1 flag for indicating deflation is in use.

Specified by:

isRsv1User in interface Extension

Overrides:

isRsv1User in class AbstractExtension

Returns:

true if extension uses RSV1 for its own purposes.

forwardIncoming

protected void forwardIncoming(Frame frame,
                               ByteAccumulator accumulator)

newByteAccumulator

protected ByteAccumulator newByteAccumulator()

decompress

protected void decompress(ByteAccumulator accumulator,
                          java.nio.ByteBuffer buf)
                   throws java.util.zip.DataFormatException

Throws:

java.util.zip.DataFormatException

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.

notifyCallbackSuccess

protected void notifyCallbackSuccess(WriteCallback callback)

notifyCallbackFailure

protected void notifyCallbackFailure(WriteCallback callback,
                                     java.lang.Throwable failure)

endsWithTail

public static boolean endsWithTail(java.nio.ByteBuffer buf)

doStop

protected void doStop()
               throws java.lang.Exception

Overrides:

doStop in class AbstractLifeCycle

Throws:

java.lang.Exception

toString

public java.lang.String toString()

Overrides:

toString in class AbstractExtension