org.eclipse.jetty.websocket.core.extensions.permessage

Class CompressExtension

java.lang.Object

org.eclipse.jetty.websocket.core.api.Extension

org.eclipse.jetty.websocket.core.extensions.permessage.CompressExtension

All Implemented Interfaces:

IncomingFrames, OutgoingFrames

public class CompressExtension
extends Extension

Per Message Compression extension for WebSocket.

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

Constructor Summary

Constructors

Constructor and Description
CompressExtension()

Method Summary

Methods

Modifier and Type	Method and Description
ByteBuffer	deflate(ByteBuffer data)
void	incoming(WebSocketFrame frame)
ByteBuffer	inflate(ByteBuffer data)
<C> void	output(C context, Callback<C> callback, WebSocketFrame frame)
int	readUncompresseLength(ByteBuffer data) Read the uncompressed length indicator in the frame.
void	setConfig(ExtensionConfig config)
String	toString()
boolean	useRsv1() Indicates use of RSV1 flag for indicating deflation is in use.

Methods inherited from class org.eclipse.jetty.websocket.core.api.Extension

getBufferPool, getConfig, getName, getNextIncomingFrames, getNextOutgoingFrames, getParameterizedName, getPolicy, incoming, nextIncoming, nextIncoming, nextOutput, nextOutputNoCallback, setBufferPool, setNextIncomingFrames, setNextOutgoingFrames, setPolicy, useRsv2, useRsv3

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CompressExtension

public CompressExtension()

Method Detail

deflate

public ByteBuffer deflate(ByteBuffer data)

incoming

public void incoming(WebSocketFrame frame)

Specified by:

incoming in interface IncomingFrames

Overrides:

incoming in class Extension

inflate

public ByteBuffer inflate(ByteBuffer data)

output

public <C> void output(C context,
              Callback<C> callback,
              WebSocketFrame frame)
            throws IOException

Specified by:

output in interface OutgoingFrames

Overrides:

output in class Extension

Throws:

IOException

readUncompresseLength

public int readUncompresseLength(ByteBuffer data)

Read the uncompressed length indicator in the frame.

Will modify the position of the buffer.

Parameters:

data -

Returns:

setConfig

public void setConfig(ExtensionConfig config)

Overrides:

setConfig in class Extension

toString

public String toString()

Overrides:

toString in class Object

useRsv1

public boolean useRsv1()

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

Overrides:

useRsv1 in class Extension