Package org.eclipse.jetty.websocket.common

Class WebSocketSession

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.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, 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

    • Nested Class Summary

      • 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, org.eclipse.jetty.util.component.Container.Listener

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

        org.eclipse.jetty.util.component.LifeCycle.Listener

    • 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

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void callApplicationOnClose​(CloseInfo closeInfo)  
      void callApplicationOnError​(java.lang.Throwable cause)  
      void close()  
      void close​(int statusCode, java.lang.String reason)  
      void close​(java.lang.Throwable cause)
      Close the active session based on the throwable
      void close​(org.eclipse.jetty.websocket.api.CloseStatus closeStatus)  
      void disconnect()
      Harsh disconnect
      void dispatch​(java.lang.Runnable runnable)  
      protected void doStart()  
      protected void doStop()  
      java.lang.String dumpSelf()  
      org.eclipse.jetty.websocket.api.BatchMode getBatchMode()  
      org.eclipse.jetty.io.ByteBufferPool getBufferPool()  
      java.lang.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()  
      java.net.InetSocketAddress getLocalAddress()  
      org.eclipse.jetty.websocket.api.extensions.OutgoingFrames getOutgoingHandler()  
      org.eclipse.jetty.websocket.api.WebSocketPolicy getPolicy()  
      java.lang.String getProtocolVersion()  
      org.eclipse.jetty.websocket.api.RemoteEndpoint getRemote()  
      java.net.InetSocketAddress getRemoteAddress()  
      java.net.URI getRequestURI()  
      org.eclipse.jetty.websocket.api.UpgradeRequest getUpgradeRequest()  
      org.eclipse.jetty.websocket.api.UpgradeResponse getUpgradeResponse()  
      WebSocketSession getWebSocketSession()
      Active WebSocketSession associated with this scope.
      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 onClosed​(org.eclipse.jetty.io.Connection connection)
      Jetty Connection onSessionClosed event
      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​(java.util.concurrent.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()  
      java.lang.String toString()  

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

        addBean, addBean, addBean, addEventListener, addManaged, contains, destroy, dump, 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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Method Detail

      • close

        public void close​(java.lang.Throwable cause)
        Close the active session based on the throwable
        Parameters:
        cause - the cause for closing the connection

      • close

        public void close()
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.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,
                  java.lang.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​(java.lang.Runnable runnable)

      • doStart

        protected void doStart()
                throws java.lang.Exception
        Overrides:
        doStart in class org.eclipse.jetty.util.component.ContainerLifeCycle
        Throws:
        java.lang.Exception

      • doStop

        protected void doStop()
               throws java.lang.Exception
        Overrides:
        doStop in class org.eclipse.jetty.util.component.ContainerLifeCycle
        Throws:
        java.lang.Exception

      • dumpSelf

        public java.lang.String dumpSelf()
        Specified by:
        dumpSelf in interface org.eclipse.jetty.util.component.Dumpable

      • getBufferPool

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

      • getClassLoader

        public java.lang.ClassLoader getClassLoader()

      • 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 java.net.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 java.lang.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 java.net.InetSocketAddress getRemoteAddress()
        Specified by:
        getRemoteAddress in interface org.eclipse.jetty.websocket.api.Session

      • getRequestURI

        public java.net.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

      • 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

      • callApplicationOnClose

        public void callApplicationOnClose​(CloseInfo closeInfo)

      • callApplicationOnError

        public void callApplicationOnError​(java.lang.Throwable cause)

      • onClosed

        public void onClosed​(org.eclipse.jetty.io.Connection connection)
        Jetty Connection onSessionClosed 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

      • open

        public void open()
        Open/Activate the session

      • setExtensionFactory

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

      • setFuture

        public void setFuture​(java.util.concurrent.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 java.lang.String toString()
        Overrides:
        toString in class org.eclipse.jetty.util.component.AbstractLifeCycle