Package org.eclipse.jetty.websocket.api.extensions

Interface Extension

All Superinterfaces:

IncomingFrames, OutgoingFrames

All Known Implementing Classes:

AbstractExtension, CompressExtension, DeflateFrameExtension, FragmentExtension, FrameCaptureExtension, IdentityExtension, PerMessageDeflateExtension, XWebkitDeflateFrameExtension

public interface Extension
extends IncomingFrames, OutgoingFrames

Interface for WebSocket Extensions.

That Frames are passed through the Extension via the IncomingFrames and OutgoingFrames interfaces

Method Summary

Modifier and Type	Method	Description
ExtensionConfig	getConfig()	The active configuration for this extension.
java.lang.String	getName()	The Sec-WebSocket-Extensions name for this extension.
boolean	isRsv1User()	Used to indicate that the extension makes use of the RSV1 bit of the base websocket framing.
boolean	isRsv2User()	Used to indicate that the extension makes use of the RSV2 bit of the base websocket framing.
boolean	isRsv3User()	Used to indicate that the extension makes use of the RSV3 bit of the base websocket framing.
void	setNextIncomingFrames(IncomingFrames nextIncoming)	Set the next IncomingFrames to call in the chain.
void	setNextOutgoingFrames(OutgoingFrames nextOutgoing)	Set the next OutgoingFrames to call in the chain.

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

incomingError, incomingFrame

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

outgoingFrame

Method Detail

getConfig

ExtensionConfig getConfig()

The active configuration for this extension.

Returns:

the configuration for this extension. never null.

getName

java.lang.String getName()

The Sec-WebSocket-Extensions name for this extension.

Also known as the extension-token per Section 9.1. Negotiating Extensions.

Returns:

the name of the extension

isRsv1User

boolean isRsv1User()

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.

Returns:

true if extension uses RSV1 for its own purposes.

isRsv2User

boolean isRsv2User()

Used to indicate that the extension makes use of the RSV2 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 RSV2.

Returns:

true if extension uses RSV2 for its own purposes.

isRsv3User

boolean isRsv3User()

Used to indicate that the extension makes use of the RSV3 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 RSV3.

Returns:

true if extension uses RSV3 for its own purposes.

setNextIncomingFrames

void setNextIncomingFrames(IncomingFrames nextIncoming)

Set the next IncomingFrames to call in the chain.

Parameters:

nextIncoming - the next incoming extension

setNextOutgoingFrames

void setNextOutgoingFrames(OutgoingFrames nextOutgoing)

Set the next OutgoingFrames to call in the chain.

Parameters:

nextOutgoing - the next outgoing extension