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 inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Method Summary

Modifier and Type	Method and Description
static boolean	endsWithTail(ByteBuffer buf)
Deflater	getDeflater()
Inflater	getInflater()
boolean	isRsv1User() Indicates use of RSV1 flag for indicating deflation is in use.
void	outgoingFrame(Frame frame, WriteCallback callback, BatchMode batchMode) A frame, and optional callback, intended for the network layer.
void	setDeflaterPool(org.eclipse.jetty.util.compression.DeflaterPool deflaterPool)
void	setInflaterPool(org.eclipse.jetty.util.compression.InflaterPool inflaterPool)
String	toString()

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

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

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

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

incomingFrame

Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle

start, stop

Method Detail

setInflaterPool

public void setInflaterPool(org.eclipse.jetty.util.compression.InflaterPool inflaterPool)

setDeflaterPool

public void setDeflaterPool(org.eclipse.jetty.util.compression.DeflaterPool deflaterPool)

getDeflater

public Deflater getDeflater()

getInflater

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

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.

endsWithTail

public static boolean endsWithTail(ByteBuffer buf)

toString

public String toString()

Overrides:

toString in class AbstractExtension