javax.websocket
Class SendResult

java.lang.Object
  javax.websocket.SendResult

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

Since:

DRAFT 002

Author:

dannycoward

Constructor Summary

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

SendResult(Throwable exception)
Construct a SendResult carrying an exception.

Method Summary

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 Detail

SendResult

public SendResult(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 an no exception.

Method Detail

getException

public Throwable getException()

The problem sending the message.

Returns:

the problem.

isOK

public boolean isOK()

Determines if this result is ok or not.

Returns:

whether the send was successful or not.