Package org.eclipse.jetty.websocket.common.io

Class ConnectionState

  • public class ConnectionState
extends java.lang.Object
    WebSocket Connection State.

    State can only go in one direction from HANDSHAKING to DISCONNECTED.

    • Constructor Summary

      Constructors 
      Constructor Description
      ConnectionState()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean canReadWebSocketFrames()
      Tests to see if state allows for reading of WebSocket frames
      boolean canWriteWebSocketFrames()
      Test to see if state allows writing of WebSocket frames
      boolean closing()
      The Local Endpoint wants to close.
      boolean disconnected()
      Final Terminal state indicating the connection is disconnected
      boolean opened()
      Requests that the connection migrate to OPENED state
      boolean opening()
      Requests that the connection migrate to OPENING state
      java.lang.String toString()  
      boolean wasOpened()
      Tests to see if state got past the initial HANDSHAKING state

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ConnectionState

        public ConnectionState()

    • Method Detail

      • canWriteWebSocketFrames

        public boolean canWriteWebSocketFrames()
        Test to see if state allows writing of WebSocket frames
        Returns:
        true if state allows for writing of websocket frames

      • canReadWebSocketFrames

        public boolean canReadWebSocketFrames()
        Tests to see if state allows for reading of WebSocket frames
        Returns:
        true if state allows for reading of websocket frames

      • wasOpened

        public boolean wasOpened()
        Tests to see if state got past the initial HANDSHAKING state
        Returns:
        true if the connection state was opened

      • opening

        public boolean opening()
        Requests that the connection migrate to OPENING state
        Returns:
        true if OPENING state attained

      • opened

        public boolean opened()
        Requests that the connection migrate to OPENED state
        Returns:
        true if OPENED state attained

      • closing

        public boolean closing()
        The Local Endpoint wants to close.
        Returns:
        true if this is the first local close

      • disconnected

        public boolean disconnected()
        Final Terminal state indicating the connection is disconnected
        Returns:
        true if disconnected reached for the first time

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object