javax.net.websocket.extensions

Interface Extension

public interface Extension

The Extension interface represents a web socket extension. Extensions are added to a web socket endpoint by adding them to its EndpointConfiguration. The extension consists of a name, a collection of extension parameters and a pair of ExtensionHandlers, one that handles all the frames the web socket implementation uses for representing incoming web socket events and messages, and the other that handles all the frames the web socket implementation uses for representing outgoing web socket events and messages.

Since:

DRAFT 003

Author:

dannycoward

Method Summary

Methods

Modifier and Type	Method and Description
FrameHandler	createIncomingFrameHandler(FrameHandler downstream) The FrameHandler that is invoked for any incoming Frames.
FrameHandler	createOutgoingFrameHandler(FrameHandler upstream) The FrameHandler that is invoked for any outgoing Frames.
String	getName() The name of this extension.
Map<String,String>	getParameters() The map name value pairs that are the web socket extension parameters for this extension.

Method Detail

getName

String getName()

The name of this extension.

getParameters

Map<String,String> getParameters()

The map name value pairs that are the web socket extension parameters for this extension.

createIncomingFrameHandler

FrameHandler createIncomingFrameHandler(FrameHandler downstream)

The FrameHandler that is invoked for any incoming Frames.

createOutgoingFrameHandler

FrameHandler createOutgoingFrameHandler(FrameHandler upstream)

The FrameHandler that is invoked for any outgoing Frames.