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

Modifier and Type	Field and Description
private ByteBufferPool	bufferPool
private ExtensionConfig	config
private CoreSession	coreSession
private DeflaterPool	deflaterPool
private InflaterPool	inflaterPool
private final Logger	log
private IncomingFrames	nextIncoming
private OutgoingFrames	nextOutgoing

Access	Constructor and Description
public	AbstractExtension()

Method Summary

Modifier and Type	Method and Description
public ByteBufferPool	getByteBufferPool()
public ExtensionConfig	getConfig() Implements org.eclipse.jetty.websocket.core.Extension.getConfig. The active configuration for this extension.
protected Configuration	getConfiguration()
public CoreSession	getCoreSession()
public DeflaterPool	getDeflaterPool()
public InflaterPool	getInflaterPool()
public String	getName() Implements org.eclipse.jetty.websocket.core.Extension.getName. The `Sec-WebSocket-Extensions` name for this extension.
public IncomingFrames	getNextIncoming()
public OutgoingFrames	getNextOutgoing()
public void	init(ExtensionConfig config, WebSocketComponents components) Implements org.eclipse.jetty.websocket.core.Extension.init.
public boolean	Returns: true if extension uses RSV1 for its own purposes. isRsv1User() Implements org.eclipse.jetty.websocket.core.Extension.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() Implements org.eclipse.jetty.websocket.core.Extension.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() Implements org.eclipse.jetty.websocket.core.Extension.isRsv3User. Used to indicate that the extension makes use of the RSV3 bit of the base websocket framing.
protected void	nextIncomingFrame(Frame frame, Callback callback)
protected void	nextOutgoingFrame(Frame frame, Callback callback, boolean batch)
public void	onFrame(Frame the frame to process. frame, Callback the read completion. callback) Implements org.eclipse.jetty.websocket.core.IncomingFrames.onFrame. Process the incoming frame.
public void	sendFrame(Frame the frame to eventually write to the network layer. frame, Callback the callback to notify when the frame is written. callback, boolean the batch mode requested by the sender. batch) Implements org.eclipse.jetty.websocket.core.OutgoingFrames.sendFrame. A frame, and optional callback, intended for the network layer.
public void	setCoreSession(CoreSession the `CoreSession` for this Extension. coreSession) Implements org.eclipse.jetty.websocket.core.Extension.setCoreSession. Set the `CoreSession` for this Extension..
public void	setNextIncomingFrames(IncomingFrames the next incoming extension nextIncoming) Implements org.eclipse.jetty.websocket.core.Extension.setNextIncomingFrames. Set the next `IncomingFrames` to call in the chain.
public void	setNextOutgoingFrames(OutgoingFrames the next outgoing extension nextOutgoing) Implements org.eclipse.jetty.websocket.core.Extension.setNextOutgoingFrames. Set the next `OutgoingFrames` to call in the chain.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

bufferPool	back to summary
private ByteBufferPool bufferPool

config	back to summary
private ExtensionConfig config

coreSession	back to summary
private CoreSession coreSession

deflaterPool	back to summary
private DeflaterPool deflaterPool

inflaterPool	back to summary
private InflaterPool inflaterPool

log	back to summary
private final Logger log

nextIncoming	back to summary
private IncomingFrames nextIncoming

nextOutgoing	back to summary
private OutgoingFrames nextOutgoing

AbstractExtension	back to summary
public AbstractExtension()

Method Detail

getByteBufferPool	back to summary
public ByteBufferPool getByteBufferPool()

getConfig	back to summary
public ExtensionConfig getConfig() Implements org.eclipse.jetty.websocket.core.Extension.getConfig. Doc from org.eclipse.jetty.websocket.core.Extension.getConfig. The active configuration for this extension. Returns:ExtensionConfig the configuration for this extension. never null. Annotations @Override

getConfig

back to summary

public ExtensionConfig getConfig()

Implements org.eclipse.jetty.websocket.core.Extension.getConfig.

Doc from org.eclipse.jetty.websocket.core.Extension.getConfig.

The active configuration for this extension.

Returns:ExtensionConfig

the configuration for this extension. never null.

Annotations

@Override

getConfiguration	back to summary
protected Configuration getConfiguration()

getCoreSession	back to summary
public CoreSession getCoreSession()

getDeflaterPool	back to summary
public DeflaterPool getDeflaterPool()

getInflaterPool	back to summary
public InflaterPool getInflaterPool()

getName back to summary

getName	back to summary
public String getName() Implements org.eclipse.jetty.websocket.core.Extension.getName. Doc from org.eclipse.jetty.websocket.core.Extension.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 Annotations @Override

public String getName()

Implements org.eclipse.jetty.websocket.core.Extension.getName.

Doc from org.eclipse.jetty.websocket.core.Extension.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

Annotations

@Override

getNextIncoming	back to summary
public IncomingFrames getNextIncoming() Annotations @ManagedAttribute name:Next Incoming Frame Handler readonly:true

getNextOutgoing	back to summary
public OutgoingFrames getNextOutgoing() Annotations @ManagedAttribute name:Next Outgoing Frame Handler readonly:true

init	back to summary
public void init(ExtensionConfig config, WebSocketComponents components) Implements org.eclipse.jetty.websocket.core.Extension.init. Annotations @Override

init

back to summary

public void init(ExtensionConfig config, WebSocketComponents components)

Implements org.eclipse.jetty.websocket.core.Extension.init.

Annotations

@Override

isRsv1User	back to summary
public boolean isRsv1User() Implements org.eclipse.jetty.websocket.core.Extension.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. Annotations @Override

isRsv1User

back to summary

public boolean isRsv1User()

Implements org.eclipse.jetty.websocket.core.Extension.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.

Annotations

@Override

isRsv2User	back to summary
public boolean isRsv2User() Implements org.eclipse.jetty.websocket.core.Extension.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. Annotations @Override

isRsv2User

back to summary

public boolean isRsv2User()

Implements org.eclipse.jetty.websocket.core.Extension.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.

Annotations

@Override

isRsv3User	back to summary
public boolean isRsv3User() Implements org.eclipse.jetty.websocket.core.Extension.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. Annotations @Override

isRsv3User

back to summary

public boolean isRsv3User()

Implements org.eclipse.jetty.websocket.core.Extension.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.

Annotations

@Override

nextIncomingFrame	back to summary
protected void nextIncomingFrame(Frame frame, Callback callback)

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

onFrame back to summary

onFrame	back to summary
public void onFrame(Frame frame, Callback callback) Implements org.eclipse.jetty.websocket.core.IncomingFrames.onFrame. Doc from org.eclipse.jetty.websocket.core.IncomingFrames.onFrame. 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. Parameters frame:Frame the frame to process. callback:Callback the read completion. Annotations @Override

public void onFrame(Frame frame, Callback callback)

Implements org.eclipse.jetty.websocket.core.IncomingFrames.onFrame.

Doc from org.eclipse.jetty.websocket.core.IncomingFrames.onFrame.

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.

Parameters

frame:Frame: the frame to process.
callback:Callback: the read completion.

Annotations

@Override

sendFrame	back to summary
public void sendFrame(Frame frame, Callback callback, boolean batch) Implements org.eclipse.jetty.websocket.core.OutgoingFrames.sendFrame. Doc from org.eclipse.jetty.websocket.core.OutgoingFrames.sendFrame. 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. Parameters frame:Frame the frame to eventually write to the network layer. callback:Callback the callback to notify when the frame is written. batch:boolean the batch mode requested by the sender. Annotations @Override

sendFrame

back to summary

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

Implements org.eclipse.jetty.websocket.core.OutgoingFrames.sendFrame.

Doc from org.eclipse.jetty.websocket.core.OutgoingFrames.sendFrame.

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.

Parameters

frame:Frame: the frame to eventually write to the network layer.
callback:Callback: the callback to notify when the frame is written.
batch:boolean: the batch mode requested by the sender.

Annotations

@Override

setCoreSession back to summary

setCoreSession	back to summary
public void setCoreSession(CoreSession coreSession) Implements org.eclipse.jetty.websocket.core.Extension.setCoreSession. Doc from org.eclipse.jetty.websocket.core.Extension.setCoreSession. Set the `CoreSession` for this Extension.. Parameters coreSession:CoreSession the `CoreSession` for this Extension. Annotations @Override

public void setCoreSession(CoreSession coreSession)

Implements org.eclipse.jetty.websocket.core.Extension.setCoreSession.

Doc from org.eclipse.jetty.websocket.core.Extension.setCoreSession.

Set the CoreSession for this Extension..

Parameters

coreSession:CoreSession: the CoreSession for this Extension.

Annotations

@Override

setNextIncomingFrames back to summary

setNextIncomingFrames	back to summary
public void setNextIncomingFrames(IncomingFrames nextIncoming) Implements org.eclipse.jetty.websocket.core.Extension.setNextIncomingFrames. Doc from org.eclipse.jetty.websocket.core.Extension.setNextIncomingFrames. Set the next `IncomingFrames` to call in the chain. Parameters nextIncoming:IncomingFrames the next incoming extension Annotations @Override

public void setNextIncomingFrames(IncomingFrames nextIncoming)

Implements org.eclipse.jetty.websocket.core.Extension.setNextIncomingFrames.

Doc from org.eclipse.jetty.websocket.core.Extension.setNextIncomingFrames.

Set the next IncomingFrames to call in the chain.

Parameters

nextIncoming:IncomingFrames: the next incoming extension

Annotations

@Override

setNextOutgoingFrames back to summary

setNextOutgoingFrames	back to summary
public void setNextOutgoingFrames(OutgoingFrames nextOutgoing) Implements org.eclipse.jetty.websocket.core.Extension.setNextOutgoingFrames. Doc from org.eclipse.jetty.websocket.core.Extension.setNextOutgoingFrames. Set the next `OutgoingFrames` to call in the chain. Parameters nextOutgoing:OutgoingFrames the next outgoing extension Annotations @Override

public void setNextOutgoingFrames(OutgoingFrames nextOutgoing)

Implements org.eclipse.jetty.websocket.core.Extension.setNextOutgoingFrames.

Doc from org.eclipse.jetty.websocket.core.Extension.setNextOutgoingFrames.

Set the next OutgoingFrames to call in the chain.

Parameters

nextOutgoing:OutgoingFrames: the next outgoing extension

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public Class AbstractExtension

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail