org.eclipse.jetty.websocket.common.extensions

Class ExtensionStack

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.websocket.common.extensions.ExtensionStack

All Implemented Interfaces:

Container, Destroyable, Dumpable, LifeCycle, IncomingFrames, OutgoingFrames

@ManagedObject(value="Extension Stack")
public class ExtensionStack
extends ContainerLifeCycle
implements IncomingFrames, OutgoingFrames

Represents the stack of Extensions.

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.Container

Container.InheritedListener, Container.Listener

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
ExtensionStack(ExtensionFactory factory)

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(Generator generator)
void	configure(Parser parser)
protected void	doStart() Starts the managed lifecycle beans in the order they were added.
void	dump(Appendable out, String indent)
List<Extension>	getExtensions()
List<ExtensionConfig>	getNegotiatedExtensions() Get the list of negotiated extensions, each entry being a full "name; params" extension configuration
IncomingFrames	getNextIncoming()
OutgoingFrames	getNextOutgoing()
boolean	hasNegotiatedExtensions()
void	incomingError(Throwable e)
void	incomingFrame(Frame frame) Process the incoming frame.
void	negotiate(List<ExtensionConfig> configs) Perform the extension negotiation.
void	outgoingFrame(Frame frame, WriteCallback callback, BatchMode batchMode) A frame, and optional callback, intended for the network layer.
void	setNextIncoming(IncomingFrames nextIncoming)
void	setNextOutgoing(OutgoingFrames nextOutgoing)
void	setPolicy(WebSocketPolicy policy)
String	toString()

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

addBean, addBean, addBean, addEventListener, contains, destroy, doStop, dump, dump, dump, dump, dumpBeans, dumpObject, dumpStdErr, dumpThis, getBean, getBeans, getBeans, isManaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, updateBean, updateBeans

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtensionStack

public ExtensionStack(ExtensionFactory factory)

Method Detail

configure

public void configure(Generator generator)

configure

public void configure(Parser parser)

doStart

protected void doStart()
                throws Exception

Description copied from class: ContainerLifeCycle

Starts the managed lifecycle beans in the order they were added.

Overrides:

doStart in class ContainerLifeCycle

Throws:

Exception

dump

public void dump(Appendable out,
        String indent)
          throws IOException

Specified by:

dump in interface Dumpable

Overrides:

dump in class ContainerLifeCycle

Throws:

IOException

getExtensions

@ManagedAttribute(name="Extension List",
                  readonly=true)
public List<Extension> getExtensions()

getNegotiatedExtensions

public List<ExtensionConfig> getNegotiatedExtensions()

Get the list of negotiated extensions, each entry being a full "name; params" extension configuration

Returns:

list of negotiated extensions

getNextIncoming

@ManagedAttribute(name="Next Incoming Frames Handler",
                  readonly=true)
public IncomingFrames getNextIncoming()

getNextOutgoing

@ManagedAttribute(name="Next Outgoing Frames Handler",
                  readonly=true)
public OutgoingFrames getNextOutgoing()

hasNegotiatedExtensions

public boolean hasNegotiatedExtensions()

incomingError

public void incomingError(Throwable e)

Specified by:

incomingError in interface IncomingFrames

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.

Specified by:

incomingFrame in interface IncomingFrames

Parameters:

frame - the frame to process

negotiate

public void negotiate(List<ExtensionConfig> configs)

Perform the extension negotiation.

For the list of negotiated extensions, use getNegotiatedExtensions()

Parameters:

configs - the configurations being requested

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.

Specified by:

outgoingFrame in interface OutgoingFrames

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.

setNextIncoming

public void setNextIncoming(IncomingFrames nextIncoming)

setNextOutgoing

public void setNextOutgoing(OutgoingFrames nextOutgoing)

setPolicy

public void setPolicy(WebSocketPolicy policy)

toString

public String toString()

Overrides:

toString in class Object