Package org.eclipse.jetty.websocket.core.internal

Class PerMessageDeflateExtension

java.lang.Object

org.eclipse.jetty.websocket.core.AbstractExtension

org.eclipse.jetty.websocket.core.internal.PerMessageDeflateExtension

All Implemented Interfaces:

Closeable, AutoCloseable, Extension, IncomingFrames, OutgoingFrames, DemandChain

public class PerMessageDeflateExtension
extends AbstractExtension
implements DemandChain

Per Message Deflate Compression extension for WebSocket.

Attempts to follow Compression Extensions for WebSocket

Constructor Summary

Constructors

Constructor	Description
PerMessageDeflateExtension()

Method Summary

Modifier and Type	Method	Description
void	close()	Used to clean up any resources after connection close.
void	demand()
static boolean	endsWithTail(ByteBuffer buf)
Deflater	getDeflater()
Inflater	getInflater()
String	getName()	The Sec-WebSocket-Extensions name for this extension.
void	init(ExtensionConfig config, WebSocketComponents components)
boolean	isRsv1User()	Used to indicate that the extension makes use of the RSV1 bit of the base websocket framing.
protected void	nextIncomingFrame(Frame frame, Callback callback)
protected void	nextOutgoingFrame(Frame frame, Callback callback, boolean batch)
void	onFrame(Frame frame, Callback callback)	Process the incoming frame.
void	releaseDeflater()
void	releaseInflater()
void	sendFrame(Frame frame, Callback callback, boolean batch)	A frame, and optional callback, intended for the network layer.
void	setNextDemand(DemandChain nextDemand)
String	toString()

Methods inherited from class org.eclipse.jetty.websocket.core.AbstractExtension

getByteBufferPool, getConfig, getConfiguration, getCoreSession, getDeflaterPool, getInflaterPool, getNextIncoming, getNextOutgoing, isRsv2User, isRsv3User, setCoreSession, setNextIncomingFrames, setNextOutgoingFrames

Methods inherited from class java.lang.Object

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

Constructor Details

PerMessageDeflateExtension

public PerMessageDeflateExtension()

Method Details

getName

public 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

isRsv1User

public boolean isRsv1User()

Description copied from class: AbstractExtension

Used to indicate that the extension makes use of the RSV1 bit of the base websocket framing.

This is used to adjust validation during parsing, as well as a checkpoint against 2 or more extensions all simultaneously claiming ownership of RSV1.

Specified by:

isRsv1User in interface Extension

Overrides:

isRsv1User in class AbstractExtension

Returns:

true if extension uses RSV1 for its own purposes.

sendFrame

public void sendFrame(Frame frame,
 Callback callback,
 boolean batch)

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 Callback appropriately.

Specified by:

sendFrame in interface OutgoingFrames

Overrides:

sendFrame in class AbstractExtension

Parameters:

frame - the frame to eventually write to the network layer.

callback - the callback to notify when the frame is written.

batch - the batch mode requested by the sender.

onFrame

public void onFrame(Frame frame,
 Callback callback)

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.

Failure of the callback will propagate the failure back to the CoreSession to fail the connection and attempt to send a close Frame if one has not been sent.

Specified by:

onFrame in interface IncomingFrames

Overrides:

onFrame in class AbstractExtension

Parameters:

frame - the frame to process.

callback - the read completion.

init

public void init(ExtensionConfig config,
 WebSocketComponents components)

Specified by:

init in interface Extension

Overrides:

init in class AbstractExtension

close

public void close()

Description copied from interface: Extension

Used to clean up any resources after connection close.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface Extension

endsWithTail

public static boolean endsWithTail(ByteBuffer buf)

getDeflater

public Deflater getDeflater()

getInflater

public Inflater getInflater()

releaseInflater

public void releaseInflater()

releaseDeflater

public void releaseDeflater()

toString

public String toString()

Overrides:

toString in class AbstractExtension

nextIncomingFrame

protected void nextIncomingFrame(Frame frame,
 Callback callback)

Overrides:

nextIncomingFrame in class AbstractExtension

nextOutgoingFrame

protected void nextOutgoingFrame(Frame frame,
 Callback callback,
 boolean batch)

Overrides:

nextOutgoingFrame in class AbstractExtension

setNextDemand

public void setNextDemand(DemandChain nextDemand)

Specified by:

setNextDemand in interface DemandChain

demand

public void demand()

Specified by:

demand in interface DemandChain