Package jakarta.websocket
Interface RemoteEndpoint.Async
-
Nested Class Summary
Nested classes/interfaces inherited from interface jakarta.websocket.RemoteEndpoint
RemoteEndpoint.Async, RemoteEndpoint.Basic -
Method Summary
Modifier and TypeMethodDescriptionlongObtain the timeout (in milliseconds) for sending a message asynchronously.sendBinary(ByteBuffer data) Send the message asynchronously, using the Future to signal to the client when the message has been sent.voidsendBinary(ByteBuffer data, SendHandler completion) Send the message asynchronously, using the SendHandler to signal to the client when the message has been sent.sendObject(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.voidsendObject(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.Send the message asynchronously, using the Future to signal to the client when the message has been sent.voidsendText(String text, SendHandler completion) Send the message asynchronously, using the SendHandler to signal to the client when the message has been sent.voidsetSendTimeout(long timeout) Set the timeout (in milliseconds) for sending a message asynchronously.Methods inherited from interface jakarta.websocket.RemoteEndpoint
flushBatch, getBatchingAllowed, sendPing, sendPong, setBatchingAllowed
-
Method Details
-
getSendTimeout
long getSendTimeout()Obtain the timeout (in milliseconds) for sending a message asynchronously. The default value is determined byWebSocketContainer.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 byWebSocketContainer.getDefaultAsyncSendTimeout().- Parameters:
timeout- The new timeout for sending messages asynchronously in milliseconds. A non-positive value means an infinite timeout.
-
sendText
Send the message asynchronously, using the SendHandler to signal to the client when the message has been sent.- Parameters:
text- The text message to sendcompletion- Used to signal to the client when the message has been sent
-
sendText
-
sendBinary
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:
IllegalArgumentException- ifdataisnull.
-
sendBinary
Send the message asynchronously, using the SendHandler to signal to the client when the message has been sent.- Parameters:
data- The text message to sendcompletion- Used to signal to the client when the message has been sent- Throws:
IllegalArgumentException- ifdataorcompletionisnull.
-
sendObject
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:
IllegalArgumentException- ifobjisnull.
-
sendObject
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:
IllegalArgumentException- ifobjorcompletionisnull.
-