org.eclipse.jetty.websocket.common.extensions.mux

Class AbstractMuxExtension

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

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

org.eclipse.jetty.websocket.common.extensions.mux.AbstractMuxExtension

All Implemented Interfaces:

Container, Destroyable, Dumpable, LifeCycle, Extension, IncomingFrames, OutgoingFrames

Direct Known Subclasses:

MuxClientExtension, MuxServerExtension

public abstract class AbstractMuxExtension
extends AbstractExtension

Multiplexing Extension for WebSockets.

Supporting draft-ietf-hybi-websocket-multiplexing-08 Specification.

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
AbstractMuxExtension()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	configureMuxer(Muxer muxer)
void	incomingFrame(Frame frame)
void	outgoingFrame(Frame frame, WriteCallback callback) A frame, and optional callback, intended for the network.
void	setConnection(LogicalConnection connection)

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

dump, dumpWithHeading, getBufferPool, getConfig, getConnection, getName, getNextIncoming, getNextOutgoing, getPolicy, incomingError, isRsv1User, isRsv2User, isRsv3User, isTextDataDecoder, nextIncomingError, nextIncomingFrame, nextOutgoingFrame, setBufferPool, setConfig, setNextIncomingFrames, setNextOutgoingFrames, setPolicy, toString

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

addBean, addBean, addBean, contains, destroy, doStart, doStop, dump, dump, dump, dump, dumpBeans, dumpObject, dumpStdErr, dumpThis, getBean, getBeans, getBeans, isManaged, manage, removeBean, removeBeans, setBeans, setStopTimeout, start, 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

AbstractMuxExtension

public AbstractMuxExtension()

Method Detail

configureMuxer

public abstract void configureMuxer(Muxer muxer)

incomingFrame

public void incomingFrame(Frame frame)

outgoingFrame

public void outgoingFrame(Frame frame,
                 WriteCallback callback)

Description copied from interface: OutgoingFrames

A frame, and optional callback, intended for the network.

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.

callback - the optional callback to use for success/failure of the network write operation. Can be null.

setConnection

public void setConnection(LogicalConnection connection)

Overrides:

setConnection in class AbstractExtension