WebSocketPeer
A class representing a specific WebSocket connection.
This class represent a specific WebSocket connection, you can do lower level operations with it.
You can choose to write to the socket in binary or text mode, and you can recognize the mode used for writing by the other peer.
enum WriteMode:
- WRITE_MODE_BINARY = 1 —- Specifies that WebSockets messages should be transferred as binary payload (any byte combination is allowed).
- void close ( code=1000, String reason=”” )
Closes this WebSocket connection. is the status code for the closure (see RFC 6455 section 7.4 for a list of valid status codes). is the human readable reason for closing the connection (can be any UTF-8 string that’s smaller than 123 bytes).
Note: The HTML5 export might not support all status codes. Please refer to browser-specific documentation for more details.
- get_connected_host ( ) const
Returns the IP address of the connected peer.
Note: Not available in the HTML5 export.
- int get_connected_port ( ) const
Returns the remote port of the connected peer.
Note: Not available in the HTML5 export.
- is_connected_to_host ( ) const
Returns if this peer is currently connected.
- void set_no_delay ( bool enabled )
Disable Nagle’s algorithm on the underling TCP socket (default). See for more information.
Note: Not available in the HTML5 export.
- void set_write_mode ( WriteMode mode )
Sets the socket to use the given .
- bool was_string_packet ( ) const
Returns if the last received packet was sent as a text payload. See .