Class SendResult

java.lang.Object
jakarta.websocket.SendResult
public final class SendResult extends Object
Represents the result of an asynchronous WebSocket message send operation.

  • Constructor Details

    • SendResult

      public SendResult(Session session, Throwable exception)
      Create an instance for an unsuccessful message.
      Parameters:
      session - the WebSocket session in which the message was sent
      exception - The exception describing the failure when trying to send the message.

    • SendResult

      public SendResult(Session session)
      Create an instance for a successful message.
      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.
      Create an instance for an unsuccessful message.
      Parameters:
      exception - The exception describing the failure when trying to send the message.

    • 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.
      Create an instance for a successful message.

  • Method Details

    • getException

      public Throwable getException()
      Returns the exception that occurred during the send operation, or null if the operation was successful.
      Returns:
      The exception, or null if successful

    • isOK

      public boolean isOK()
      Returns whether the send operation was successful.
      Returns:
      true if the send was successful, false otherwise

    • 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.