Defines session for WebSocket connection.
Attributes
- Companion
- object
- Graph
-
- Supertypes
-
class Objecttrait Matchableclass Any
Members list
Value members
Abstract methods
Closes session with supplied status code.
Closes session with supplied status code.
Value parameters
- code
-
status code of closure
Attributes
Gets session identifer.
Gets session identifer.
Attributes
Gets WebSocket idle timeout in milliseconds.
Gets WebSocket idle timeout in milliseconds.
Timeout of zero disables this option – i.e., timeout is indefinite.
Attributes
- Note
-
If no activity transpires for specified duration, then session is closed with status code GoingAway.
Sets WebSocket idle timeout.
Sets WebSocket idle timeout.
Timeout of zero disables this option – i.e., timeout is indefinite.
Value parameters
- milliseconds
-
idle timeout
Attributes
- Returns
-
this session
- Note
-
If no activity transpires for specified duration, then session is closed with status code GoingAway.
Tests for secure WebSocket session.
Tests for secure WebSocket session.
Attributes
Gets capacity of incoming message.
Gets capacity of incoming message.
Attributes
- Note
-
If message exceeds specified capacity, then session is closed with status code MessageTooBig.
Sets capacity of incoming message.
Sets capacity of incoming message.
Value parameters
- size
-
message capacity in bytes
Attributes
- Returns
-
this session
- Note
-
If message exceeds specified capacity, then session is closed with status code MessageTooBig.
Sets handler for incoming binary message.
Sets handler for incoming binary message.
Value parameters
- handler
-
binary message handler
Attributes
- Returns
-
this session
Sets handler to be notified when session closes.
Sets handler to be notified when session closes.
Value parameters
- handler
-
close handler
Attributes
- Returns
-
this session
Sets handler to be notified when session error occurs.
Sets handler to be notified when session error occurs.
Value parameters
- handler
-
error handler
Attributes
- Returns
-
this session
Sets handler for incoming ping message.
Sets handler for incoming ping message.
Value parameters
- handler
-
ping message handler
Attributes
- Returns
-
this session
Sets handler for incoming pong message.
Sets handler for incoming pong message.
Value parameters
- handler
-
pong message handler
Attributes
- Returns
-
this session
Sets handler for incoming text message.
Sets handler for incoming text message.
Value parameters
- handler
-
text message handler
Attributes
- Returns
-
this session
Opens session.
Opens session.
Attributes
- Note
-
This method becomes an effective no-op if invoked more than once.
Gets payload limit of outgoing message.
Gets payload limit of outgoing message.
Attributes
- Note
-
If outgoing message exceeds specified limit, then message is sent over multiple frames.
Gets payload limit of outgoing message.
Gets payload limit of outgoing message.
Value parameters
- length
-
payload limit in bytes
Attributes
- Returns
-
this session
- Note
-
If outgoing message exceeds specified limit, then message is sent over multiple frames.
Sends ping message.
Sends ping message.
Value parameters
- data
-
application data to accompany ping message
Attributes
Sends ping message asynchronously.
Sends ping message asynchronously.
Value parameters
- data
-
application data to accompany ping message
Attributes
Sends pong message.
Sends pong message.
Value parameters
- data
-
application data to accompany pong message
Attributes
Sends pong message asynchronously.
Sends pong message asynchronously.
Value parameters
- data
-
application data to accompany pong message
Attributes
Gets WebSocket protocol version.
Gets WebSocket protocol version.
Attributes
Sends text message.
Sends text message.
Value parameters
- message
-
text message
Attributes
Sends binary message.
Sends binary message.
Value parameters
- message
-
binary message
Attributes
Sends text message.
Sends text message.
Value parameters
- message
-
reader to message
Attributes
Sends binary message.
Sends binary message.
Value parameters
- message
-
input stream to message
Attributes
Sends text message asynchronously.
Sends text message asynchronously.
Value parameters
- message
-
text message
Attributes
Sends binary message asynchronously.
Sends binary message asynchronously.
Value parameters
- message
-
binary message
Attributes
Sends text message asynchronously.
Sends text message asynchronously.
Value parameters
- message
-
reader to message
Attributes
Sends binary message asynchronously.
Sends binary message asynchronously.
Value parameters
- message
-
input stream to message
Attributes
Gets current state of WebSocket session.
Gets current state of WebSocket session.