org.eclipse.jetty.websocket.core.api

Class Extension

java.lang.Object

org.eclipse.jetty.websocket.core.api.Extension

All Implemented Interfaces:

IncomingFrames, OutgoingFrames

Direct Known Subclasses:

FragmentExtension, IdentityExtension, PerMessageCompressionExtension, WebkitDeflateFrameExtension

public abstract class Extension
extends Object
implements OutgoingFrames, IncomingFrames

Constructor Summary

Constructors

Constructor and Description
Extension()

Method Summary

Methods

Modifier and Type	Method and Description
ByteBufferPool	getBufferPool()
ExtensionConfig	getConfig()
String	getName()
IncomingFrames	getNextIncomingFrames()
OutgoingFrames	getNextOutgoingFrames()
String	getParameterizedName()
WebSocketPolicy	getPolicy()
void	incoming(WebSocketException e)
void	incoming(WebSocketFrame frame)
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.
boolean	isTextDataDecoder() Used to indicate that the extension works as a decoder of TEXT Data Frames.
void	nextIncoming(WebSocketException e) Convenience method for #getNextIncomingFrames()#incoming(WebSocketException)
void	nextIncoming(WebSocketFrame frame) Convenience method for #getNextIncomingFrames()#incoming(WebSocketFrame)
<C> void	nextOutput(C context, Callback<C> callback, WebSocketFrame frame) Convenience method for #getNextOutgoingFrames()#output(WebSocketFrame)
<C> void	nextOutputNoCallback(WebSocketFrame frame)
<C> void	output(C context, Callback<C> callback, WebSocketFrame frame)
void	setBufferPool(ByteBufferPool bufferPool)
void	setConfig(ExtensionConfig config)
void	setNextIncomingFrames(IncomingFrames nextIncomingFramesHandler)
void	setNextOutgoingFrames(OutgoingFrames nextOutgoingFramesHandler)
void	setPolicy(WebSocketPolicy policy)

Methods inherited from class java.lang.Object

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

Constructor Detail

Extension

public Extension()

Method Detail

getBufferPool

public ByteBufferPool getBufferPool()

getConfig

public ExtensionConfig getConfig()

getName

public String getName()

getNextIncomingFrames

public IncomingFrames getNextIncomingFrames()

getNextOutgoingFrames

public OutgoingFrames getNextOutgoingFrames()

getParameterizedName

public String getParameterizedName()

getPolicy

public WebSocketPolicy getPolicy()

incoming

public void incoming(WebSocketException e)

Specified by:

incoming in interface IncomingFrames

incoming

public void incoming(WebSocketFrame frame)

Specified by:

incoming in interface IncomingFrames

isRsv1User

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:

true if extension uses RSV1 for its own purposes.

isRsv2User

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:

true if extension uses RSV2 for its own purposes.

isRsv3User

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:

true if extension uses RSV3 for its own purposes.

isTextDataDecoder

public boolean isTextDataDecoder()

Used to indicate that the extension works as a decoder of TEXT Data Frames.

This is used to adjust validation during parsing/generating, as per spec TEXT Data Frames can only contain UTF8 encoded String data.

Example: a compression extension will process a compressed set of text data, the parser/generator should no longer be concerned about the validity of the TEXT Data Frames as this is now the responsibility of the extension.

Returns:

true if extension will process TEXT Data Frames, false if extension makes no modifications of TEXT Data Frames. If false, the parser/generator is now free to validate the conformance to spec of TEXT Data Frames.

nextIncoming

public void nextIncoming(WebSocketException e)

Convenience method for #getNextIncomingFrames()#incoming(WebSocketException)

Parameters:

e - the exception to pass to the next input/incoming

nextIncoming

public void nextIncoming(WebSocketFrame frame)

Convenience method for #getNextIncomingFrames()#incoming(WebSocketFrame)

Parameters:

frame - the frame to send to the next input/incoming

nextOutput

public <C> void nextOutput(C context,
                  Callback<C> callback,
                  WebSocketFrame frame)
                throws IOException

Convenience method for #getNextOutgoingFrames()#output(WebSocketFrame)

Parameters:

frame - the frame to send to the next output

Throws:

IOException

nextOutputNoCallback

public <C> void nextOutputNoCallback(WebSocketFrame frame)
                          throws IOException

Throws:

IOException

output

public <C> void output(C context,
              Callback<C> callback,
              WebSocketFrame frame)
            throws IOException

Specified by:

output in interface OutgoingFrames

Throws:

IOException

setBufferPool

public void setBufferPool(ByteBufferPool bufferPool)

setConfig

public void setConfig(ExtensionConfig config)

setNextIncomingFrames

public void setNextIncomingFrames(IncomingFrames nextIncomingFramesHandler)

setNextOutgoingFrames

public void setNextOutgoingFrames(OutgoingFrames nextOutgoingFramesHandler)

setPolicy

public void setPolicy(WebSocketPolicy policy)