Extension

Interface for WebSocket Extensions. That {@link Frame}s are passed through the Extension via the {@link IncomingFrames} and {@link OutgoingFrames} interfaces

interface Extension : IncomingFrames , OutgoingFrames {

ExtensionConfig getConfig();

void setNextIncomingFrames(IncomingFrames nextIncoming);

void setNextOutgoingFrames(OutgoingFrames nextOutgoing);

}

Members

Functions

getConfig ExtensionConfig getConfig(): The active configuration for this extension.
getName string getName(): The <code>Sec-WebSocket-Extensions</code> name for this extension. Also known as the <a href="https://tools.ietf.org/html/rfc6455#section-9.1"><code>extension-token</code> per Section 9.1. Negotiating Extensions</a>.
isRsv1User bool 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.
isRsv2User bool 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.
isRsv3User bool 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.
setNextIncomingFrames void setNextIncomingFrames(IncomingFrames nextIncoming): Set the next {@link IncomingFrames} to call in the chain.
setNextOutgoingFrames void setNextOutgoingFrames(OutgoingFrames nextOutgoing): Set the next {@link OutgoingFrames} to call in the chain.

Inherited Members

From IncomingFrames

incomingError void incomingError(Exception t): Undocumented in source.
incomingFrame void incomingFrame(WebSocketFrame frame): 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.

From OutgoingFrames

outgoingFrame void outgoingFrame(WebSocketFrame frame, Callback callback): 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.