Package org.eclipse.jetty.websocket.common

Class WebSocketSession

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.websocket.common.WebSocketSession

All Implemented Interfaces:

Closeable, AutoCloseable, org.eclipse.jetty.io.Connection.Listener, org.eclipse.jetty.util.component.Container, org.eclipse.jetty.util.component.Destroyable, org.eclipse.jetty.util.component.Dumpable, org.eclipse.jetty.util.component.LifeCycle, org.eclipse.jetty.websocket.api.extensions.IncomingFrames, org.eclipse.jetty.websocket.api.Session, IOState.ConnectionStateListener, RemoteEndpointFactory, WebSocketSessionScope

@ManagedObject("A Jetty WebSocket Session")
public class WebSocketSession
extends org.eclipse.jetty.util.component.ContainerLifeCycle
implements org.eclipse.jetty.websocket.api.Session, RemoteEndpointFactory, WebSocketSessionScope, org.eclipse.jetty.websocket.api.extensions.IncomingFrames, org.eclipse.jetty.io.Connection.Listener, IOState.ConnectionStateListener

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	WebSocketSession.DisconnectCallback
static interface	WebSocketSession.Listener
static class	WebSocketSession.OnCloseLocalCallback

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

org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener

Nested classes/interfaces inherited from interface org.eclipse.jetty.io.Connection.Listener

org.eclipse.jetty.io.Connection.Listener.Adapter

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

org.eclipse.jetty.util.component.Container.InheritedListener

Field Summary

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

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

KEY

Constructor Summary

Constructors

Constructor	Description
WebSocketSession(WebSocketContainerScope containerScope, URI requestURI, EventDriver websocket, LogicalConnection connection)

Method Summary

Modifier and Type	Method	Description
void	abort(int statusCode, String reason)	Aborts the active session abruptly.
void	close()
void	close(int statusCode, String reason)
void	close(org.eclipse.jetty.websocket.api.CloseStatus closeStatus)
void	disconnect()	Harsh disconnect
void	dispatch(Runnable runnable)
protected void	doStart()
protected void	doStop()
void	dump(Appendable out, String indent)
boolean	equals(Object obj)
org.eclipse.jetty.websocket.api.BatchMode	getBatchMode()
org.eclipse.jetty.io.ByteBufferPool	getBufferPool()
ClassLoader	getClassLoader()
LogicalConnection	getConnection()
WebSocketContainerScope	getContainerScope()	The parent WebSocketContainerScope for this session scope.
org.eclipse.jetty.websocket.api.extensions.ExtensionFactory	getExtensionFactory()
long	getIdleTimeout()	The idle timeout in milliseconds
org.eclipse.jetty.websocket.api.extensions.IncomingFrames	getIncomingHandler()
InetSocketAddress	getLocalAddress()
org.eclipse.jetty.websocket.api.extensions.OutgoingFrames	getOutgoingHandler()
org.eclipse.jetty.websocket.api.WebSocketPolicy	getPolicy()
String	getProtocolVersion()
org.eclipse.jetty.websocket.api.RemoteEndpoint	getRemote()
InetSocketAddress	getRemoteAddress()
URI	getRequestURI()
org.eclipse.jetty.websocket.api.UpgradeRequest	getUpgradeRequest()
org.eclipse.jetty.websocket.api.UpgradeResponse	getUpgradeResponse()
WebSocketSession	getWebSocketSession()	Active WebSocketSession associated with this scope.
int	hashCode()
void	incomingError(Throwable t)	Incoming Errors
void	incomingFrame(org.eclipse.jetty.websocket.api.extensions.Frame frame)	Incoming Raw Frames from Parser
boolean	isOpen()
boolean	isSecure()
WebSocketRemoteEndpoint	newRemoteEndpoint(LogicalConnection connection, org.eclipse.jetty.websocket.api.extensions.OutgoingFrames outgoingFrames, org.eclipse.jetty.websocket.api.BatchMode batchMode)
void	notifyClose(int statusCode, String reason)
void	notifyError(Throwable cause)
void	onClosed(org.eclipse.jetty.io.Connection connection)	Jetty Connection onClosed event
void	onConnectionStateChange(ConnectionState state)
void	onOpened(org.eclipse.jetty.io.Connection connection)	Jetty Connection onOpen event
void	open()	Open/Activate the session
void	setExtensionFactory(org.eclipse.jetty.websocket.api.extensions.ExtensionFactory extensionFactory)
void	setFuture(CompletableFuture<org.eclipse.jetty.websocket.api.Session> fut)
void	setIdleTimeout(long ms)	Set the timeout in milliseconds
void	setOutgoingHandler(org.eclipse.jetty.websocket.api.extensions.OutgoingFrames outgoing)
void	setPolicy(org.eclipse.jetty.websocket.api.WebSocketPolicy policy)	Deprecated.
void	setUpgradeRequest(org.eclipse.jetty.websocket.api.UpgradeRequest request)
void	setUpgradeResponse(org.eclipse.jetty.websocket.api.UpgradeResponse response)
org.eclipse.jetty.websocket.api.SuspendToken	suspend()
String	toString()

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

addBean, addBean, addBean, addEventListener, addManaged, contains, destroy, dump, dump, dump, dump, dumpBeans, dumpObject, dumpObjects, dumpStdErr, dumpThis, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, updateBean, 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, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WebSocketSession

public WebSocketSession(WebSocketContainerScope containerScope,
                        URI requestURI,
                        EventDriver websocket,
                        LogicalConnection connection)

Method Detail

abort

public void abort(int statusCode,
                  String reason)

Aborts the active session abruptly.

Parameters:

statusCode - the status code

reason - the raw reason code

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface org.eclipse.jetty.websocket.api.Session

close

public void close(org.eclipse.jetty.websocket.api.CloseStatus closeStatus)

Specified by:

close in interface org.eclipse.jetty.websocket.api.Session

close

public void close(int statusCode,
                  String reason)

Specified by:

close in interface org.eclipse.jetty.websocket.api.Session

disconnect

public void disconnect()

Harsh disconnect

Specified by:

disconnect in interface org.eclipse.jetty.websocket.api.Session

dispatch

public void dispatch(Runnable runnable)

doStart

protected void doStart()
                throws Exception

Overrides:

doStart in class org.eclipse.jetty.util.component.ContainerLifeCycle

Throws:

Exception

doStop

protected void doStop()
               throws Exception

Overrides:

doStop in class org.eclipse.jetty.util.component.ContainerLifeCycle

Throws:

Exception

dump

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

Specified by:

dump in interface org.eclipse.jetty.util.component.Dumpable

Overrides:

dump in class org.eclipse.jetty.util.component.ContainerLifeCycle

Throws:

IOException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getBufferPool

public org.eclipse.jetty.io.ByteBufferPool getBufferPool()

getClassLoader

public ClassLoader getClassLoader()

getConnection

public LogicalConnection getConnection()

getContainerScope

public WebSocketContainerScope getContainerScope()

Description copied from interface: WebSocketSessionScope

The parent WebSocketContainerScope for this session scope.

Specified by:

getContainerScope in interface WebSocketSessionScope

Returns:

the websocket container scope

getExtensionFactory

public org.eclipse.jetty.websocket.api.extensions.ExtensionFactory getExtensionFactory()

getIdleTimeout

public long getIdleTimeout()

The idle timeout in milliseconds

Specified by:

getIdleTimeout in interface org.eclipse.jetty.websocket.api.Session

getIncomingHandler

@ManagedAttribute(readonly=true)
public org.eclipse.jetty.websocket.api.extensions.IncomingFrames getIncomingHandler()

getLocalAddress

public InetSocketAddress getLocalAddress()

Specified by:

getLocalAddress in interface org.eclipse.jetty.websocket.api.Session

getOutgoingHandler

@ManagedAttribute(readonly=true)
public org.eclipse.jetty.websocket.api.extensions.OutgoingFrames getOutgoingHandler()

getPolicy

public org.eclipse.jetty.websocket.api.WebSocketPolicy getPolicy()

Specified by:

getPolicy in interface org.eclipse.jetty.websocket.api.Session

getProtocolVersion

public String getProtocolVersion()

Specified by:

getProtocolVersion in interface org.eclipse.jetty.websocket.api.Session

getRemote

public org.eclipse.jetty.websocket.api.RemoteEndpoint getRemote()

Specified by:

getRemote in interface org.eclipse.jetty.websocket.api.Session

getRemoteAddress

public InetSocketAddress getRemoteAddress()

Specified by:

getRemoteAddress in interface org.eclipse.jetty.websocket.api.Session

getRequestURI

public URI getRequestURI()

getUpgradeRequest

public org.eclipse.jetty.websocket.api.UpgradeRequest getUpgradeRequest()

Specified by:

getUpgradeRequest in interface org.eclipse.jetty.websocket.api.Session

getUpgradeResponse

public org.eclipse.jetty.websocket.api.UpgradeResponse getUpgradeResponse()

Specified by:

getUpgradeResponse in interface org.eclipse.jetty.websocket.api.Session

getWebSocketSession

public WebSocketSession getWebSocketSession()

Description copied from interface: WebSocketSessionScope

Active WebSocketSession associated with this scope.

Specified by:

getWebSocketSession in interface WebSocketSessionScope

Returns:

the websocket session

hashCode

public int hashCode()

Overrides:

hashCode in class Object

incomingError

public void incomingError(Throwable t)

Incoming Errors

Specified by:

incomingError in interface org.eclipse.jetty.websocket.api.extensions.IncomingFrames

incomingFrame

public void incomingFrame(org.eclipse.jetty.websocket.api.extensions.Frame frame)

Incoming Raw Frames from Parser

Specified by:

incomingFrame in interface org.eclipse.jetty.websocket.api.extensions.IncomingFrames

isOpen

public boolean isOpen()

Specified by:

isOpen in interface org.eclipse.jetty.websocket.api.Session

isSecure

public boolean isSecure()

Specified by:

isSecure in interface org.eclipse.jetty.websocket.api.Session

notifyClose

public void notifyClose(int statusCode,
                        String reason)

notifyError

public void notifyError(Throwable cause)

onClosed

public void onClosed(org.eclipse.jetty.io.Connection connection)

Jetty Connection onClosed event

Specified by:

onClosed in interface org.eclipse.jetty.io.Connection.Listener

Parameters:

connection - the connection that was closed

onOpened

public void onOpened(org.eclipse.jetty.io.Connection connection)

Jetty Connection onOpen event

Specified by:

onOpened in interface org.eclipse.jetty.io.Connection.Listener

Parameters:

connection - the connection that was opened

onConnectionStateChange

public void onConnectionStateChange(ConnectionState state)

Specified by:

onConnectionStateChange in interface IOState.ConnectionStateListener

newRemoteEndpoint

public WebSocketRemoteEndpoint newRemoteEndpoint(LogicalConnection connection,
                                                 org.eclipse.jetty.websocket.api.extensions.OutgoingFrames outgoingFrames,
                                                 org.eclipse.jetty.websocket.api.BatchMode batchMode)

Specified by:

newRemoteEndpoint in interface RemoteEndpointFactory

open

public void open()

Open/Activate the session

setExtensionFactory

public void setExtensionFactory(org.eclipse.jetty.websocket.api.extensions.ExtensionFactory extensionFactory)

setFuture

public void setFuture(CompletableFuture<org.eclipse.jetty.websocket.api.Session> fut)

setIdleTimeout

public void setIdleTimeout(long ms)

Set the timeout in milliseconds

Specified by:

setIdleTimeout in interface org.eclipse.jetty.websocket.api.Session

setOutgoingHandler

public void setOutgoingHandler(org.eclipse.jetty.websocket.api.extensions.OutgoingFrames outgoing)

setPolicy

@Deprecated
public void setPolicy(org.eclipse.jetty.websocket.api.WebSocketPolicy policy)

Deprecated.

setUpgradeRequest

public void setUpgradeRequest(org.eclipse.jetty.websocket.api.UpgradeRequest request)

setUpgradeResponse

public void setUpgradeResponse(org.eclipse.jetty.websocket.api.UpgradeResponse response)

suspend

public org.eclipse.jetty.websocket.api.SuspendToken suspend()

Specified by:

suspend in interface org.eclipse.jetty.websocket.api.Session

getBatchMode

public org.eclipse.jetty.websocket.api.BatchMode getBatchMode()

Returns:

the default (initial) value for the batching mode.

toString

public String toString()

Overrides:

toString in class org.eclipse.jetty.util.component.AbstractLifeCycle