org.eclipse.jetty.websocket.common.extensions.identity

Class IdentityExtension

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.websocket.common.extensions.AbstractExtension

org.eclipse.jetty.websocket.common.extensions.identity.IdentityExtension

All Implemented Interfaces:

LifeCycle, Extension, IncomingFrames, OutgoingFrames

@ManagedObject(value="Identity Extension")
public class IdentityExtension
extends AbstractExtension

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

AbstractLifeCycle.AbstractLifeCycleListener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

LifeCycle.Listener

Field Summary

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Constructor Summary

Constructors

Constructor and Description
IdentityExtension()

Method Summary

Modifier and Type	Method and Description
String	getName() The Sec-WebSocket-Extensions name for this extension.
String	getParam(String key)
void	incomingFrame(Frame frame) Process the incoming frame.
void	outgoingFrame(Frame frame, WriteCallback callback, BatchMode batchMode) A frame, and optional callback, intended for the network layer.
void	setConfig(ExtensionConfig config)
String	toString()

Methods inherited from class org.eclipse.jetty.websocket.common.extensions.AbstractExtension

getBufferPool, getConfig, getConnection, getNextIncoming, getNextOutgoing, getPolicy, init, init, isRsv1User, isRsv2User, isRsv3User, setBufferPool, setConnection, setNextIncomingFrames, setNextOutgoingFrames, setPolicy

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, setStopTimeout, start, stop

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle

start, stop

Constructor Detail

IdentityExtension

public IdentityExtension()

Method Detail

getParam

public String getParam(String key)

getName

public String getName()

Description copied from interface: Extension

The Sec-WebSocket-Extensions name for this extension.

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

Specified by:

getName in interface Extension

Overrides:

getName in class AbstractExtension

Returns:

the name of the extension

incomingFrame

public void incomingFrame(Frame frame)

Description copied from interface: IncomingFrames

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.

Parameters:

frame - the frame to process

outgoingFrame

public void outgoingFrame(Frame frame,
                          WriteCallback callback,
                          BatchMode batchMode)

Description copied from interface: OutgoingFrames

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 WriteCallback appropriately.

Parameters:

frame - the frame to eventually write to the network layer.

callback - the callback to notify when the frame is written.

batchMode - the batch mode requested by the sender.

setConfig

public void setConfig(ExtensionConfig config)

Overrides:

setConfig in class AbstractExtension

toString

public String toString()

Overrides:

toString in class AbstractExtension