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:

CompressExtension, FragmentExtension, IdentityExtension

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)
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)
boolean	useRsv1()
boolean	useRsv2()
boolean	useRsv3()

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

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)

useRsv1

public boolean useRsv1()

useRsv2

public boolean useRsv2()

useRsv3

public boolean useRsv3()