MuxChannel (Jetty :: Websocket :: Common 9.0.3.v20130506 API)

java.lang.Object
- org.eclipse.jetty.websocket.common.extensions.mux.MuxChannel

All Implemented Interfaces:

IncomingFrames, OutgoingFrames, SuspendToken, IOState.ConnectionStateListener, LogicalConnection
```
public class MuxChannel
extends Object
implements LogicalConnection, IncomingFrames, SuspendToken, IOState.ConnectionStateListener
```
MuxChannel, acts as WebSocketConnection for specific sub-channel.

Constructor Summary

Constructors
Constructor and Description

MuxChannel(long channelId, Muxer muxer)

Constructors
Constructor and Description
`MuxChannel(long channelId, Muxer muxer)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()` Send a websocket Close frame, without a status code or reason.
`void`	`close(int statusCode, String reason)` Send a websocket Close frame, with status code.
`void`	`disconnect()` Terminate the connection (no close frame sent)
`long`	`getChannelId()`
`IOState`	`getIOState()` Get the IOState of the connection.
`InetSocketAddress`	`getLocalAddress()` Get the local `InetSocketAddress` in use for this connection.
`long`	`getMaxIdleTimeout()` Set the maximum number of milliseconds of idleness before the connection is closed/disconnected, (ie no frames are either sent or received)
`WebSocketPolicy`	`getPolicy()` The policy that the connection is running under.
`InetSocketAddress`	`getRemoteAddress()` Get the remote Address in use for this connection.
`WebSocketSession`	`getSession()` Get the Session for this connection
`void`	`incomingError(WebSocketException e)` Incoming exceptions from Muxer.
`void`	`incomingFrame(Frame frame)` Incoming frames from Muxer
`boolean`	`isActive()`
`boolean`	`isOpen()` Test if logical connection is still open
`boolean`	`isReading()` Tests if the connection is actively reading.
`void`	`onClose()`
`void`	`onConnectionStateChange(ConnectionState state)`
`void`	`onOpen()`
`void`	`outgoingFrame(Frame frame, WriteCallback callback)` Frames destined for the Muxer
`void`	`resume()`
`void`	`setMaxIdleTimeout(long ms)` Set the maximum number of milliseconds of idleness before the connection is closed/disconnected, (ie no frames are either sent or received)
`void`	`setNextIncomingFrames(IncomingFrames incoming)` Set where the connection should send the incoming frames to.
`void`	`setSession(WebSocketSession session)` Set the session associated with this connection
`void`	`setSubProtocol(String subProtocol)`
`SuspendToken`	`suspend()` Suspend a the incoming read events on the connection.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MuxChannel
```
public MuxChannel(long channelId,
          Muxer muxer)
```
- Method Detail
  - close
```
public void close()
```
    Description copied from interface: LogicalConnection
    
    Send a websocket Close frame, without a status code or reason.
    Basic usage: results in an non-blocking async write, then connection close.
    
    Specified by:
    
    close in interface LogicalConnection
    
    See Also:
    StatusCode, LogicalConnection.close(int, String)
  - close
```
public void close(int statusCode,
         String reason)
```
    Description copied from interface: LogicalConnection
    
    Send a websocket Close frame, with status code.
    Advanced usage: results in an non-blocking async write, then connection close.
    
    Specified by:
    
    close in interface LogicalConnection
    
    Parameters:
    statusCode - the status code
    reason - the (optional) reason. (can be null for no reason)
    See Also:
    StatusCode
  - disconnect
```
public void disconnect()
```
    Description copied from interface: LogicalConnection
    
    Terminate the connection (no close frame sent)
    
    Specified by:
    
    disconnect in interface LogicalConnection
  - getChannelId
```
public long getChannelId()
```
  - getIOState
```
public IOState getIOState()
```
    Description copied from interface: LogicalConnection
    
    Get the IOState of the connection.
    
    Specified by:
    
    getIOState in interface LogicalConnection
    
    Returns:
    the IOState of the connection.
  - getLocalAddress
```
public InetSocketAddress getLocalAddress()
```
    Description copied from interface: LogicalConnection
    
    Get the local InetSocketAddress in use for this connection.
    Note: Non-physical connections, like during the Mux extensions, or during unit testing can result in a InetSocketAddress on port 0 and/or on localhost.
    
    Specified by:
    
    getLocalAddress in interface LogicalConnection
    
    Returns:
    the local address.
  - getMaxIdleTimeout
```
public long getMaxIdleTimeout()
```
    Description copied from interface: LogicalConnection
    
    Set the maximum number of milliseconds of idleness before the connection is closed/disconnected, (ie no frames are either sent or received)
    
    Specified by:
    
    getMaxIdleTimeout in interface LogicalConnection
    
    Returns:
    the idle timeout in milliseconds
  - getPolicy
```
public WebSocketPolicy getPolicy()
```
    Description copied from interface: LogicalConnection
    
    The policy that the connection is running under.
    
    Specified by:
    
    getPolicy in interface LogicalConnection
    
    Returns:
    the policy for the connection
  - getRemoteAddress
```
public InetSocketAddress getRemoteAddress()
```
    Description copied from interface: LogicalConnection
    
    Get the remote Address in use for this connection.
    Note: Non-physical connections, like during the Mux extensions, or during unit testing can result in a InetSocketAddress on port 0 and/or on localhost.
    
    Specified by:
    
    getRemoteAddress in interface LogicalConnection
    
    Returns:
    the remote address.
  - getSession
```
public WebSocketSession getSession()
```
    Description copied from interface: LogicalConnection
    
    Get the Session for this connection
    
    Specified by:
    
    getSession in interface LogicalConnection
    
    Returns:
    the Session for this connection
  - incomingError
```
public void incomingError(WebSocketException e)
```
    Incoming exceptions from Muxer.
    
    Specified by:
    
    incomingError in interface IncomingFrames
  - incomingFrame
```
public void incomingFrame(Frame frame)
```
    Incoming frames from Muxer
    
    Specified by:
    
    incomingFrame in interface IncomingFrames
  - isActive
```
public boolean isActive()
```
  - isOpen
```
public boolean isOpen()
```
    Description copied from interface: LogicalConnection
    
    Test if logical connection is still open
    
    Specified by:
    
    isOpen in interface LogicalConnection
    
    Returns:
    true if connection is open
  - isReading
```
public boolean isReading()
```
    Description copied from interface: LogicalConnection
    
    Tests if the connection is actively reading.
    
    Specified by:
    
    isReading in interface LogicalConnection
    
    Returns:
    true if connection is actively attempting to read.
  - onClose
```
public void onClose()
```
  - onConnectionStateChange
```
public void onConnectionStateChange(ConnectionState state)
```
    Specified by:
    
    onConnectionStateChange in interface IOState.ConnectionStateListener
  - onOpen
```
public void onOpen()
```
  - outgoingFrame
```
public void outgoingFrame(Frame frame,
                 WriteCallback callback)
```
    Frames destined for the Muxer
    
    Specified by:
    
    outgoingFrame in interface OutgoingFrames
  - resume
```
public void resume()
```
    Specified by:
    
    resume in interface SuspendToken
  - setMaxIdleTimeout
```
public void setMaxIdleTimeout(long ms)
```
    Description copied from interface: LogicalConnection
    
    Set the maximum number of milliseconds of idleness before the connection is closed/disconnected, (ie no frames are either sent or received)
    
    Specified by:
    
    setMaxIdleTimeout in interface LogicalConnection
    
    Parameters:
    ms - the number of milliseconds of idle timeout
  - setNextIncomingFrames
```
public void setNextIncomingFrames(IncomingFrames incoming)
```
    Description copied from interface: LogicalConnection
    
    Set where the connection should send the incoming frames to.
    Often this is from the Parser to the start of the extension stack, and eventually on to the session.
    
    Specified by:
    
    setNextIncomingFrames in interface LogicalConnection
    
    Parameters:
    incoming - the incoming frames handler
  - setSession
```
public void setSession(WebSocketSession session)
```
    Description copied from interface: LogicalConnection
    
    Set the session associated with this connection
    
    Specified by:
    
    setSession in interface LogicalConnection
    
    Parameters:
    session - the session
  - setSubProtocol
```
public void setSubProtocol(String subProtocol)
```
  - suspend
```
public SuspendToken suspend()
```
    Description copied from interface: LogicalConnection
    
    Suspend a the incoming read events on the connection.
    
    Specified by:
    
    suspend in interface LogicalConnection
    
    Returns:

Class MuxChannel

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MuxChannel

Method Detail

close

close

disconnect

getChannelId

getIOState

getLocalAddress

getMaxIdleTimeout

getPolicy

getRemoteAddress

getSession

incomingError

incomingFrame

isActive

isOpen

isReading

onClose

onConnectionStateChange

onOpen

outgoingFrame

resume

setMaxIdleTimeout

setNextIncomingFrames

setSession

setSubProtocol

suspend