Package javax.websocket
Interface RemoteEndpoint.Async
- 
- All Superinterfaces:
- RemoteEndpoint
 - Enclosing interface:
- RemoteEndpoint
 
 public static interface RemoteEndpoint.Async extends RemoteEndpoint 
- 
- 
Nested Class Summary- 
Nested classes/interfaces inherited from interface javax.websocket.RemoteEndpointRemoteEndpoint.Async, RemoteEndpoint.Basic
 
- 
 - 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description longgetSendTimeout()Obtain the timeout (in milliseconds) for sending a message asynchronously.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.voidsendBinary(java.nio.ByteBuffer data, SendHandler completion)Send the message asynchronously, using the SendHandler to signal to the client when the message has been sent.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.voidsendObject(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.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.voidsendText(java.lang.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 javax.websocket.RemoteEndpointflushBatch, getBatchingAllowed, sendPing, sendPong, setBatchingAllowed
 
- 
 
- 
- 
- 
Method Detail- 
getSendTimeoutlong 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.
 
 - 
setSendTimeoutvoid 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.
 
 - 
sendTextvoid 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
 
 - 
sendTextjava.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.
 
 - 
sendBinaryjava.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- datais- null.
 
 - 
sendBinaryvoid 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- dataor- completionis- null.
 
 - 
sendObjectjava.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- objis- null.
 
 - 
sendObjectvoid 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- objor- completionis- null.
 
 
- 
 
-