| Modifier and Type | Field and Description |
|---|---|
| pack-priv static final Logger |
| Access | Constructor and Description |
|---|---|
| protected |
| Modifier and Type | Method and Description |
|---|---|
| public long | getSendTimeout()
Implements jakarta. Return the number of milliseconds the implementation will timeout attempting to send a websocket message. |
| public Future | sendBinary(ByteBuffer
the data being sent. data)Implements jakarta. Initiates the asynchronous transmission of a binary message. |
| public void | sendBinary(ByteBuffer
the data being sent, must not be data, SendHandler null.the handler that will be notified of progress, must not be handler)null.Implements jakarta. Initiates the asynchronous transmission of a binary message. |
| public Future | sendObject(Object
the object being sent. data)Implements jakarta. Initiates the asynchronous transmission of a custom developer object. |
| public void | sendObject(Object
the object being sent. data, SendHandler the handler that will be notified of progress, must not be handler)null.Implements jakarta. Initiates the asynchronous transmission of a custom developer object. |
| public Future | sendText(String
the text being sent. text)Implements jakarta. Initiates the asynchronous transmission of a text message. |
| public void | sendText(String
the text being sent. text, SendHandler the handler which will be notified of progress. handler)Implements jakarta. Initiates the asynchronous transmission of a text message. |
| public void | setSendTimeout(long
The number of milliseconds this RemoteEndpoint will wait before timing out an incomplete
asynchronous message send. timeoutmillis)Implements jakarta. Sets the number of milliseconds the implementation will timeout attempting to send a websocket message. |
| LOG | back to summary |
|---|---|
| pack-priv static final Logger LOG Hides org. | |
| JakartaWebSocketAsyncRemote | back to summary |
|---|---|
| protected JakartaWebSocketAsyncRemote(JakartaWebSocketSession session, CoreSession coreSession) | |
| getSendTimeout | back to summary |
|---|---|
| public long getSendTimeout() Implements jakarta. Doc from jakarta. Return the number of milliseconds the implementation will timeout attempting to send a websocket message. A zero or negative value indicates the implementation will not timeout attempting to send a websocket message asynchronously. This value overrides the default value assigned in the WebSocketContainer.
| |
| sendBinary | back to summary |
|---|---|
| public Future Implements jakarta. Doc from jakarta. Initiates the asynchronous transmission of a binary message. This method returns before the message is
transmitted. Developers use the returned Future object to track progress of the transmission. The Future's
get() method returns It is not safe for other threads to use the ByteBuffer until the sending of this message is complete. If the sending of the message completes successfully, the buffer's limit will be unchanged and the buffer's position will be equal to the limit. If the sending of the message does not complete successfully, the state of the buffer is undefined.
| |
| sendBinary | back to summary |
|---|---|
| public void sendBinary(ByteBuffer data, SendHandler handler) Implements jakarta. Doc from jakarta. Initiates the asynchronous transmission of a binary message. This method returns before the message is transmitted. Developers provide a callback to be notified when the message has been transmitted. Errors in transmission are given to the developer in the SendResult object. It is not safe for other threads to use the ByteBuffer until the sending of this message is complete. If the sending of the message completes successfully, the buffer's limit will be unchanged and the buffer's position will be equal to the limit. If the sending of the message does not complete successfully, the state of the buffer is undefined.
| |
| sendObject | back to summary |
|---|---|
| public Future Implements jakarta. Doc from jakarta. Initiates the asynchronous transmission of a custom developer object. The developer will have provided an
encoder for this object type in the endpoint configuration. Containers will by default be able to encode java
primitive types and their object equivalents, otherwise the developer must have provided an encoder for the
object type in the endpoint configuration. A developer-provided encoder for a Java primitive type and its
object equivalent overrides the container default encoder. Progress may be tracked using the Future object.
The Future's get() methods return | |
| sendObject | back to summary |
|---|---|
| public void sendObject(Object data, SendHandler handler) Implements jakarta. Doc from jakarta. Initiates the asynchronous transmission of a custom developer object. Containers will by default be able to encode java primitive types and their object equivalents, otherwise the developer must have provided an encoder for the object type in the endpoint configuration. A developer-provided encoder for a Java primitive type and its object equivalent overrides the container default encoder. Developers are notified when transmission is complete through the supplied callback object.
| |
| sendText | back to summary |
|---|---|
| public Future Implements jakarta. Doc from jakarta. Initiates the asynchronous transmission of a text message. This method returns before the message is
transmitted. Developers use the returned Future object to track progress of the transmission. The Future's
get() method returns | |
| sendText | back to summary |
|---|---|
| public void sendText(String text, SendHandler handler) Implements jakarta. Doc from jakarta. Initiates the asynchronous transmission of a text message. This method returns before the message is transmitted. Developers provide a callback to be notified when the message has been transmitted. Errors in transmission are given to the developer in the SendResult object.
| |
| setSendTimeout | back to summary |
|---|---|
| public void setSendTimeout(long timeoutmillis) Implements jakarta. Doc from jakarta. Sets the number of milliseconds the implementation will timeout attempting to send a websocket message. A zero or negative value indicates the implementation will not timeout attempting to send a websocket message asynchronously. This value overrides the default value assigned in the WebSocketContainer.
| |