Package javax.websocket

Class SendResult

java.lang.Object
javax.websocket.SendResult
public final class SendResult
extends java.lang.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 Summary

    Constructors 
    Constructor Description
    SendResult()
    Construct a SendResult signifying a successful send carrying no exception.
    SendResult​(java.lang.Throwable exception)
    Construct a SendResult carrying an exception.

  • Method Summary

    Modifier and Type Method Description
    java.lang.Throwable getException()
    The problem sending the message.
    boolean isOK()
    Determines if this result is ok or not.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • SendResult

      public SendResult​(java.lang.Throwable exception)
      Construct a SendResult carrying an exception.
      Parameters:
      exception - the exception causing a send failure.

    • SendResult

      public SendResult()
      Construct a SendResult signifying a successful send carrying no exception.

  • Method Details

    • getException

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