org.openingo.spring.boot.extension.websocket

Class InstantManager

java.lang.Object

org.openingo.spring.boot.extension.websocket.InstantManager

public class InstantManager
extends Object

InstantManager

Author:

Qicz

Method Summary

Modifier and Type	Method and Description
static List<Future<Void>>	asyncSendBinary(Integer connId, ByteBuffer data) Send the message asynchronously, using the Future to signal to the client when the message has been sent.
static void	asyncSendBinary(Integer connId, ByteBuffer data, javax.websocket.SendHandler completion) Send the message asynchronously, using the SendHandler to signal to the client when the message has been sent.
static void	asyncSendJson(Integer connId, Object obj) Send the message, blocking until the message is sent.
static List<Future<Void>>	asyncSendObject(Integer connId, 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.
static void	asyncSendObject(Integer connId, Object obj, javax.websocket.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.
static List<Future<Void>>	asyncSendText(Integer connId, String text) Send the message asynchronously, using the Future to signal to the client when the message has been sent.
void	asyncSendText(Integer connId, String text, javax.websocket.SendHandler completion) Send the message asynchronously, using the SendHandler to signal to the client when the message has been sent.
static long	getSessionAsyncSendTimeout(Integer connId) Obtain the timeout (in milliseconds) for sending a message asynchronously.
static void	sendBinary(Integer connId, ByteBuffer data) Send the message, blocking until the message is sent.
void	sendBinary(Integer connId, ByteBuffer partialByte, boolean isLast) Sends part of a binary message to the remote endpoint.
static void	sendJson(Integer connId, Object obj) Send the message, blocking until the message is sent.
void	sendObject(Integer connId, Object data) Encodes object as a message and sends it to the remote endpoint.
static void	sendText(Integer connId, String text) Send the message, blocking until the message is sent.
static void	sendText(Integer connId, String fragment, boolean isLast) Sends part of a text message to the remote endpoint.
static void	setAsyncSendTimeout(Integer connId, long timeout) Set the timeout (in milliseconds) for sending a message asynchronously.

Methods inherited from class java.lang.Object

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

Method Detail

sendText

public static void sendText(Integer connId,
                            String text)
                     throws IOException

Send the message, blocking until the message is sent.

Parameters:

connId - connect id

text - The text message to send.

Throws:

IllegalArgumentException - if text is null.

IOException - if an I/O error occurs during the sending of the message.

sendBinary

public static void sendBinary(Integer connId,
                              ByteBuffer data)
                       throws IOException

Send the message, blocking until the message is sent.

Parameters:

connId - connect id

data - The binary message to send

Throws:

IllegalArgumentException - if data is null.

IOException - if an I/O error occurs during the sending of the message.

sendText

public static void sendText(Integer connId,
                            String fragment,
                            boolean isLast)
                     throws IOException

Sends part of a text message to the remote endpoint. Once the first part of a message has been sent, no other text or binary messages may be sent until all remaining parts of this message have been sent.

Parameters:

connId - connect id

fragment - The partial message to send

isLast - true if this is the last part of the message, otherwise false

Throws:

IllegalArgumentException - if fragment is null.

IOException - if an I/O error occurs during the sending of the message.

sendBinary

public void sendBinary(Integer connId,
                       ByteBuffer partialByte,
                       boolean isLast)
                throws IOException

Sends part of a binary message to the remote endpoint. Once the first part of a message has been sent, no other text or binary messages may be sent until all remaining parts of this message have been sent.

Parameters:

connId - connect id

partialByte - The partial message to send

isLast - true if this is the last part of the message, otherwise false

Throws:

IllegalArgumentException - if partialByte is null.

IOException - if an I/O error occurs during the sending of the message.

sendObject

public void sendObject(Integer connId,
                       Object data)
                throws IOException,
                       javax.websocket.EncodeException

Encodes object as a message and sends it to the remote endpoint.

Parameters:

connId - connect id

data - The object to be sent.

Throws:

javax.websocket.EncodeException - if there was a problem encoding the data object as a websocket message.

IllegalArgumentException - if data is null.

IOException - if an I/O error occurs during the sending of the message.

getSessionAsyncSendTimeout

public static long getSessionAsyncSendTimeout(Integer connId)

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

Parameters:

connId - connect id

Returns:

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

setAsyncSendTimeout

public static void setAsyncSendTimeout(Integer connId,
                                       long timeout)

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

Parameters:

connId - connect id

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

asyncSendText

public void asyncSendText(Integer connId,
                          String text,
                          javax.websocket.SendHandler completion)

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

Parameters:

connId - connect id

text - The text message to send

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

asyncSendText

public static List<Future<Void>> asyncSendText(Integer connId,
                                               String text)

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

Parameters:

connId - connect id

text - The text message to send

Returns:

A Future that signals when the message has been sent.

asyncSendBinary

public static List<Future<Void>> asyncSendBinary(Integer connId,
                                                 ByteBuffer data)

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

Parameters:

connId - connect id

data - The text message to send

Returns:

A Future that signals when the message has been sent.

Throws:

IllegalArgumentException - if data is null.

asyncSendBinary

public static void asyncSendBinary(Integer connId,
                                   ByteBuffer data,
                                   javax.websocket.SendHandler completion)

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

Parameters:

connId - connect id

data - The text message to send

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

Throws:

IllegalArgumentException - if data or completion is null.

asyncSendObject

public static List<Future<Void>> asyncSendObject(Integer connId,
                                                 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:

connId - connect id

obj - The object to be sent.

Returns:

A Future that signals when the message has been sent.

Throws:

IllegalArgumentException - if obj is null.

asyncSendObject

public static void asyncSendObject(Integer connId,
                                   Object obj,
                                   javax.websocket.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:

connId - connect id

obj - The object to be sent.

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

Throws:

IllegalArgumentException - if obj or completion is null.

sendJson

public static void sendJson(Integer connId,
                            Object obj)
                     throws IOException

Send the message, blocking until the message is sent.

Parameters:

connId - connect id

obj - The obj to send.

Throws:

IllegalArgumentException - if text is null.

IOException - if an I/O error occurs during the sending of the message.

asyncSendJson

public static void asyncSendJson(Integer connId,
                                 Object obj)
                          throws IOException

Send the message, blocking until the message is sent.

Parameters:

connId - connect id

obj - The obj to send.

Throws:

IllegalArgumentException - if text is null.

IOException - if an I/O error occurs during the sending of the message.