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

Class Muxer

java.lang.Object

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

All Implemented Interfaces:

IncomingFrames, MuxParser.Listener

public class Muxer
extends Object
implements IncomingFrames, MuxParser.Listener

Muxer responsible for managing sub-channels.

Maintains a 1 (incoming and outgoing mux encapsulated frames) to many (per-channel incoming/outgoing standard websocket frames) relationship, along with routing of MuxControlBlock events.

Control Channel events (channel ID == 0) are handled by the Muxer.

Constructor Summary

Constructors

Constructor and Description
Muxer(LogicalConnection connection)

Method Summary

Methods

Modifier and Type	Method and Description
MuxAddClient	getAddClient()
MuxAddServer	getAddServer()
MuxChannel	getChannel(long channelId, boolean create)
WebSocketPolicy	getPolicy()
InetSocketAddress	getRemoteAddress() Get the remote address of the physical connection.
void	incomingError(WebSocketException e) Incoming parser errors
void	incomingFrame(Frame frame) Incoming mux encapsulated frames.
boolean	isOpen() Is the muxer and the physical connection still open?
String	mergeHeaders(List<String> physicalHeaders, String deltaHeaders)
void	onMuxAddChannelRequest(MuxAddChannelRequest request) Incoming mux control block, destined for the control channel (id 0)
void	onMuxAddChannelResponse(MuxAddChannelResponse response) Incoming mux control block, destined for the control channel (id 0)
void	onMuxDropChannel(MuxDropChannel drop) Incoming mux control block, destined for the control channel (id 0)
void	onMuxedFrame(MuxedFrame frame) Incoming mux-unwrapped frames, destined for a sub-channel
void	onMuxException(MuxException e)
void	onMuxFlowControl(MuxFlowControl flow) Incoming mux control block, destined for the control channel (id 0)
void	onMuxNewChannelSlot(MuxNewChannelSlot slot) Incoming mux control block, destined for the control channel (id 0)
void	output(long channelId, Frame frame, WriteCallback callback) Outgoing frame, without mux encapsulated payload.
void	output(MuxControlBlock op) Write an OP out the physical connection.
void	setAddClient(MuxAddClient addClient)
void	setAddServer(MuxAddServer addServer)
void	setOutgoingFramesHandler(OutgoingFrames outgoing)
void	setRemoteAddress(InetSocketAddress remoteAddress) Set the remote address of the physical connection.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Muxer

public Muxer(LogicalConnection connection)

Method Detail

getAddClient

public MuxAddClient getAddClient()

getAddServer

public MuxAddServer getAddServer()

getChannel

public MuxChannel getChannel(long channelId,
                    boolean create)

getPolicy

public WebSocketPolicy getPolicy()

getRemoteAddress

public InetSocketAddress getRemoteAddress()

Get the remote address of the physical connection.

Returns:

the remote address of the physical connection

incomingError

public void incomingError(WebSocketException e)

Incoming parser errors

Specified by:

incomingError in interface IncomingFrames

incomingFrame

public void incomingFrame(Frame frame)

Incoming mux encapsulated frames.

Specified by:

incomingFrame in interface IncomingFrames

isOpen

public boolean isOpen()

Is the muxer and the physical connection still open?

Returns:

true if open

mergeHeaders

public String mergeHeaders(List<String> physicalHeaders,
                  String deltaHeaders)

onMuxAddChannelRequest

public void onMuxAddChannelRequest(MuxAddChannelRequest request)

Incoming mux control block, destined for the control channel (id 0)

Specified by:

onMuxAddChannelRequest in interface MuxParser.Listener

onMuxAddChannelResponse

public void onMuxAddChannelResponse(MuxAddChannelResponse response)

Incoming mux control block, destined for the control channel (id 0)

Specified by:

onMuxAddChannelResponse in interface MuxParser.Listener

onMuxDropChannel

public void onMuxDropChannel(MuxDropChannel drop)

Incoming mux control block, destined for the control channel (id 0)

Specified by:

onMuxDropChannel in interface MuxParser.Listener

onMuxedFrame

public void onMuxedFrame(MuxedFrame frame)

Incoming mux-unwrapped frames, destined for a sub-channel

Specified by:

onMuxedFrame in interface MuxParser.Listener

onMuxException

public void onMuxException(MuxException e)

Specified by:

onMuxException in interface MuxParser.Listener

onMuxFlowControl

public void onMuxFlowControl(MuxFlowControl flow)

Incoming mux control block, destined for the control channel (id 0)

Specified by:

onMuxFlowControl in interface MuxParser.Listener

onMuxNewChannelSlot

public void onMuxNewChannelSlot(MuxNewChannelSlot slot)

Incoming mux control block, destined for the control channel (id 0)

Specified by:

onMuxNewChannelSlot in interface MuxParser.Listener

output

public void output(long channelId,
          Frame frame,
          WriteCallback callback)

Outgoing frame, without mux encapsulated payload.

output

public void output(MuxControlBlock op)
            throws IOException

Write an OP out the physical connection.

Parameters:

op - the mux operation to write

Throws:

IOException

setAddClient

public void setAddClient(MuxAddClient addClient)

setAddServer

public void setAddServer(MuxAddServer addServer)

setOutgoingFramesHandler

public void setOutgoingFramesHandler(OutgoingFrames outgoing)

setRemoteAddress

public void setRemoteAddress(InetSocketAddress remoteAddress)

Set the remote address of the physical connection.

This address made available to sub-channels.

Parameters:

remoteAddress - the remote address

toString

public String toString()

Overrides:

toString in class Object