Jetty 12.0.6 · org.eclipse.jetty.websocket.core.Extension

Method Summary

Modifier and Type	Method and Description
public default void	close() Implements java.io.Closeable.close. Used to clean up any resources after connection close.
public ExtensionConfig	Returns: the configuration for this extension. never null. getConfig() The active configuration for this extension.
public String	Returns: the name of the extension getName() The `Sec-WebSocket-Extensions` name for this extension.
public void	init(ExtensionConfig config, WebSocketComponents components)
public boolean	Returns: true if extension uses RSV1 for its own purposes. isRsv1User() Used to indicate that the extension makes use of the RSV1 bit of the base websocket framing.
public boolean	Returns: true if extension uses RSV2 for its own purposes. isRsv2User() Used to indicate that the extension makes use of the RSV2 bit of the base websocket framing.
public boolean	Returns: true if extension uses RSV3 for its own purposes. isRsv3User() Used to indicate that the extension makes use of the RSV3 bit of the base websocket framing.
public void	setCoreSession(CoreSession the `CoreSession` for this Extension. coreSession) Set the `CoreSession` for this Extension..
public void	setNextIncomingFrames(IncomingFrames the next incoming extension nextIncoming) Set the next `IncomingFrames` to call in the chain.
public void	setNextOutgoingFrames(OutgoingFrames the next outgoing extension nextOutgoing) Set the next `OutgoingFrames` to call in the chain.

Inherited from org.eclipse.jetty.websocket.core.IncomingFrames:: onFrame
Inherited from org.eclipse.jetty.websocket.core.OutgoingFrames:: sendFrame

Method Detail

close	back to summary
public default void close() Implements java.io.Closeable.close. Used to clean up any resources after connection close.

back to summary

public default void close()

Implements java.io.Closeable.close.

Used to clean up any resources after connection close.

getConfig	back to summary
public ExtensionConfig getConfig() The active configuration for this extension. Returns:ExtensionConfig the configuration for this extension. never null.

getConfig

back to summary

public ExtensionConfig getConfig()

The active configuration for this extension.

Returns:ExtensionConfig: the configuration for this extension. never null.

getName back to summary

getName	back to summary
public String getName() The `Sec-WebSocket-Extensions` name for this extension. Also known as the `extension-token` per Section 9.1. Negotiating Extensions. Returns:String the name of the extension

public String getName()

The Sec-WebSocket-Extensions name for this extension.

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

Returns:String: the name of the extension

init	back to summary
public void init(ExtensionConfig config, WebSocketComponents components)

isRsv1User	back to summary
public 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:boolean true if extension uses RSV1 for its own purposes.

isRsv1User

back to summary

public 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:boolean: true if extension uses RSV1 for its own purposes.

isRsv2User	back to summary
public 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:boolean true if extension uses RSV2 for its own purposes.

isRsv2User

back to summary

public 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:boolean: true if extension uses RSV2 for its own purposes.

isRsv3User	back to summary
public 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:boolean true if extension uses RSV3 for its own purposes.

isRsv3User

back to summary

public 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:boolean: true if extension uses RSV3 for its own purposes.

setCoreSession back to summary

setCoreSession	back to summary
public void setCoreSession(CoreSession coreSession) Set the `CoreSession` for this Extension.. Parameters coreSession:CoreSession the `CoreSession` for this Extension.

public void setCoreSession(CoreSession coreSession)

Set the CoreSession for this Extension..

Parameters

coreSession:CoreSession: the CoreSession for this Extension.

setNextIncomingFrames back to summary

setNextIncomingFrames	back to summary
public void setNextIncomingFrames(IncomingFrames nextIncoming) Set the next `IncomingFrames` to call in the chain. Parameters nextIncoming:IncomingFrames the next incoming extension

public void setNextIncomingFrames(IncomingFrames nextIncoming)

Set the next IncomingFrames to call in the chain.

Parameters

nextIncoming:IncomingFrames: the next incoming extension

setNextOutgoingFrames back to summary

setNextOutgoingFrames	back to summary
public void setNextOutgoingFrames(OutgoingFrames nextOutgoing) Set the next `OutgoingFrames` to call in the chain. Parameters nextOutgoing:OutgoingFrames the next outgoing extension

public void setNextOutgoingFrames(OutgoingFrames nextOutgoing)

Set the next OutgoingFrames to call in the chain.

Parameters

nextOutgoing:OutgoingFrames: the next outgoing extension

public Interface Extension

Method Summary

Method Detail