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

Class MessageCompressionExtension

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

All Implemented Interfaces:

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

public class MessageCompressionExtension
extends AbstractExtension

Per Message Compression extension for WebSocket.

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

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.util.component.AbstractLifeCycle

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Constructor Summary

Constructors

Constructor and Description
MessageCompressionExtension()

Method Summary

Methods

Modifier and Type	Method and Description
void	incomingFrame(Frame frame)
boolean	isRsv1User() Indicates use of RSV1 flag for indicating deflation is in use.
boolean	isTextDataDecoder() Used to indicate that the extension works as a decoder of TEXT Data Frames.
void	outgoingFrame(Frame frame, WriteCallback callback) A frame, and optional callback, intended for the network.
void	setConfig(ExtensionConfig config)
String	toString()

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

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

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

addBean, addBean, addBean, addEventListener, 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

MessageCompressionExtension

public MessageCompressionExtension()

Method Detail

incomingFrame

public void incomingFrame(Frame frame)

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.

isTextDataDecoder

public boolean isTextDataDecoder()

Description copied from class: AbstractExtension

Used to indicate that the extension works as a decoder of TEXT Data Frames.

This is used to adjust validation during parsing/generating, as per spec TEXT Data Frames can only contain UTF8 encoded String data.

Example: a compression extension will process a compressed set of text data, the parser/generator should no longer be concerned about the validity of the TEXT Data Frames as this is now the responsibility of the extension.

Specified by:

isTextDataDecoder in interface Extension

Overrides:

isTextDataDecoder in class AbstractExtension

Returns:

true if extension will process TEXT Data Frames, false if extension makes no modifications of TEXT Data Frames. If false, the parser/generator is now free to validate the conformance to spec of TEXT Data Frames.

outgoingFrame

public void outgoingFrame(Frame frame,
                 WriteCallback callback)

Description copied from interface: OutgoingFrames

A frame, and optional callback, intended for the network.

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.

callback - the optional callback to use for success/failure of the network write operation. Can be null.

setConfig

public void setConfig(ExtensionConfig config)

Overrides:

setConfig in class AbstractExtension

toString

public String toString()

Overrides:

toString in class AbstractExtension