By: Matej Lazar

no type hierarchy

no supertypes hierarchy

no subtypes hierarchy

Attributes
closeFrameReceivedSource Codeshared formal Boolean closeFrameReceived

Return true if a close frame has been received

hostnameSource Codeshared formal String hostname
idleTimeoutSource Codeshared formal Integer idleTimeout

Idle timeout in milliseconds for this WebSocketSession. The session will be closed if nothing was received or send in this time. If smaller then 1 no timeout is used.

requestPathSource Codeshared formal String requestPath
schemaSource Codeshared formal String schema
Inherited Attributes
Attributes inherited from: Object
Methods
fragmentedBinarySenderSource Codeshared formal FragmentedBinarySender fragmentedBinarySender()
fragmentedTextSenderSource Codeshared formal FragmentedTextSender fragmentedTextSender()
openSource Codeshared formal Boolean open()

Return true if the session is open and connected

sendBinarySource Codeshared formal void sendBinary(ByteBuffer binary)
sendBinaryAsynchronousSource Codeshared formal void sendBinaryAsynchronous(ByteBuffer binary, Anything(WebSocketChannel) onCompletion, Anything(WebSocketChannel, Throwable)? onError = null)
Parameters:
  • onError = null
sendCloseSource Codeshared formal void sendClose(CloseReason reason)

Send the a CLOSE websocket frame and blocks until complete. After the CLOSE is sent the connections will be closed.

sendCloseAsynchronousSource Codeshared formal void sendCloseAsynchronous(CloseReason reason, Anything(WebSocketChannel) onCompletion, Anything(WebSocketChannel, Throwable)? onError = null)

Send the a CLOSE websocket frame and notify the SendCallback once done. After the CLOSE is sent the connections will be closed. The callback that is called when sending is done or null if no notification should be done.

Parameters:
  • onError = null
sendTextSource Codeshared formal void sendText(String text)

Send the a text websocket frame and blocks until complete. The implementation is responsible to queue them up and send them in the correct order.

The payload must be valid UTF8.

sendTextAsynchronousSource Codeshared formal void sendTextAsynchronous(String text, Anything(WebSocketChannel) onCompletion, Anything(WebSocketChannel, Throwable)? onError = null)

Send a text websocket frame and notify the SendCallback once done. It is possible to send multiple frames at the same time even if the SendCallback is not triggered yet. The implementation is responsible to queue them up and send them in the correct order. The payload which must be valid UTF8. The callback is called when sending is done, use without sendCallback if no notification should be done.

Parameters:
  • onError = null
Inherited Methods
Methods inherited from: Object