Method Detail

• getSendTimeout

  long getSendTimeout()

  Obtain the timeout (in milliseconds) for sending a message asynchronously. The default value is determined by WebSocketContainer.getDefaultAsyncSendTimeout().

  Returns:

  The current send timeout in milliseconds. A non-positive value means an infinite timeout.

• setSendTimeout

  void setSendTimeout(long timeout)

  Set the timeout (in milliseconds) for sending a message asynchronously. The default value is determined by WebSocketContainer.getDefaultAsyncSendTimeout().

  Parameters:

  timeout - The new timeout for sending messages asynchronously in milliseconds. A non-positive value means an infinite timeout.

• sendText

  void sendText(java.lang.String text,
              SendHandler completion)

  Send the message asynchronously, using the SendHandler to signal to the client when the message has been sent.

  Parameters:

  text - The text message to send

  completion - Used to signal to the client when the message has been sent

• sendText

  java.util.concurrent.Future<java.lang.Void> sendText(java.lang.String text)

  Send the message asynchronously, using the Future to signal to the client when the message has been sent.

  Parameters:

  text - The text message to send

  Returns:

  A Future that signals when the message has been sent.

• sendBinary

  java.util.concurrent.Future<java.lang.Void> sendBinary(java.nio.ByteBuffer data)

  Send the message asynchronously, using the Future to signal to the client when the message has been sent.

  Parameters:

  data - The text message to send

  Returns:

  A Future that signals when the message has been sent.

  Throws:

  java.lang.IllegalArgumentException - if data is null.

• sendBinary

  void sendBinary(java.nio.ByteBuffer data,
                SendHandler completion)

  Send the message asynchronously, using the SendHandler to signal to the client when the message has been sent.

  Parameters:

  data - The text message to send

  completion - Used to signal to the client when the message has been sent

  Throws:

  java.lang.IllegalArgumentException - if data or completion is null.

• sendObject

  java.util.concurrent.Future<java.lang.Void> sendObject(java.lang.Object obj)

  Encodes object as a message and sends it asynchronously, using the Future to signal to the client when the message has been sent.

  Parameters:

  obj - The object to be sent.

  Returns:

  A Future that signals when the message has been sent.

  Throws:

  java.lang.IllegalArgumentException - if obj is null.

• sendObject

  void sendObject(java.lang.Object obj,
                SendHandler completion)

  Encodes object as a message and sends it asynchronously, using the SendHandler to signal to the client when the message has been sent.

  Parameters:

  obj - The object to be sent.

  completion - Used to signal to the client when the message has been sent

  Throws:

  java.lang.IllegalArgumentException - if obj or completion is null.