Package jakarta.websocket

Class SendResult

java.lang.Object
jakarta.websocket.SendResult
public final class SendResult extends Object
The result of asynchronously sending a web socket message. A SendResult is either ok indicating there was no problem, or is not OK in which case there was a problem and it carries an exception to indicate what the problem was.
Author:
dannycoward

  • Constructor Details

    • SendResult

      public SendResult(Session session, Throwable exception)
      Construct a SendResult carrying an exception.
      Parameters:
      session - the WebSocket session in which the message was sent
      exception - the exception causing a send failure.

    • SendResult

      public SendResult(Session session)
      Construct a SendResult signifying a successful send carrying no exception.
      Parameters:
      session - the WebSocket session in which the message was sent

    • SendResult

      @Deprecated public SendResult(Throwable exception)
      Deprecated.
      Deprecated in WebSocket 2.2 and will be removed in a future version. Use SendResult(Session, Throwable) as a replacement.
      Construct a SendResult carrying an exception.
      Parameters:
      exception - the exception causing a send failure.

    • SendResult

      @Deprecated public SendResult()
      Deprecated.
      Deprecated in WebSocket 2.2 and will be removed in a future version. Use SendResult(Session, Throwable) as a replacement.
      Construct a SendResult signifying a successful send carrying no exception.

  • Method Details

    • getException

      public Throwable getException()
      The problem sending the message.
      Returns:
      the problem or null if the send was successful.

    • isOK

      public boolean isOK()
      Determines if this result is ok or not.
      Returns:
      whether the send was successful or not.

    • getSession

      public Session getSession()
      The WebSocket session in which the session was sent.
      Returns:
      the WebSocket session in which the session was sent or null if not known.