Interface Session

  • All Superinterfaces:
    java.lang.AutoCloseable, java.io.Closeable, WebSocketPolicy
    All Known Implementing Classes:
    WebSocketSession

    public interface Session
    extends WebSocketPolicy, java.io.Closeable
    Session represents an active link of communications with a Remote WebSocket Endpoint.
    • Method Detail

      • close

        void close()
        Request a close of the current conversation with a normal status code and no reason phrase.

        This will enqueue a graceful close to the remote endpoint.

        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        See Also:
        close(CloseStatus), close(int, String), disconnect()
      • close

        void close​(CloseStatus closeStatus)
        Request Close the current conversation, giving a reason for the closure. Note the websocket spec defines the acceptable uses of status codes and reason phrases.

        This will enqueue a graceful close to the remote endpoint.

        Parameters:
        closeStatus - the reason for the closure
        See Also:
        close(), close(int, String), disconnect()
      • close

        void close​(int statusCode,
                   java.lang.String reason)
        Send a websocket Close frame, with status code.

        This will enqueue a graceful close to the remote endpoint.

        Parameters:
        statusCode - the status code
        reason - the (optional) reason. (can be null for no reason)
        See Also:
        StatusCode, close(), close(CloseStatus), disconnect()
      • getLocalAddress

        java.net.SocketAddress getLocalAddress()
        The Local Socket Address for the active Session

        Do not assume that this will return a InetSocketAddress in all cases. Use of various proxies, and even UnixSockets can result a SocketAddress being returned without supporting InetSocketAddress

        Returns:
        the SocketAddress for the local connection, or null if not supported by Session
      • getProtocolVersion

        java.lang.String getProtocolVersion()
        Returns the version of the websocket protocol currently being used. This is taken as the value of the Sec-WebSocket-Version header used in the opening handshake. i.e. "13".
        Returns:
        the protocol version
      • getRemote

        RemoteEndpoint getRemote()
        Return a reference to the RemoteEndpoint object representing the other end of this conversation.
        Returns:
        the remote endpoint
      • getRemoteAddress

        java.net.SocketAddress getRemoteAddress()
        The Remote Socket Address for the active Session

        Do not assume that this will return a InetSocketAddress in all cases. Use of various proxies, and even UnixSockets can result a SocketAddress being returned without supporting InetSocketAddress

        Returns:
        the SocketAddress for the remote connection, or null if not supported by Session
      • getUpgradeRequest

        UpgradeRequest getUpgradeRequest()
        Get the UpgradeRequest used to create this session
        Returns:
        the UpgradeRequest used to create this session
      • getUpgradeResponse

        UpgradeResponse getUpgradeResponse()
        Get the UpgradeResponse used to create this session
        Returns:
        the UpgradeResponse used to create this session
      • isOpen

        boolean isOpen()
        Return true if and only if the underlying socket is open.
        Returns:
        whether the session is open
      • isSecure

        boolean isSecure()
        Return true if and only if the underlying socket is using a secure transport.
        Returns:
        whether its using a secure transport
      • suspend

        SuspendToken suspend()
        Suspend the delivery of incoming WebSocket frames.

        If this is called from inside the scope of the message handler the suspend takes effect immediately. If suspend is called outside the scope of the message handler then the call may take effect after 1 more frame is delivered.

        Returns:
        the suspend token suitable for resuming the reading of data on the connection.