WebSocketClient

class WebSocketClient(apiKey: String, connect: PortalConnect, webSocketServer: String = "connect.portalhq.io")

WebSocketClient is responsible for managing a WebSocket connection to a remote server, handling events, and sending/receiving messages.

Constructors

constructor(apiKey: String, connect: PortalConnect, webSocketServer: String = "connect.portalhq.io")

Checks if the WebSocket client is currently connected or in the process of connecting.

The current topic associated with the WebSocket session.

fun close()

Closes the WebSocket connection and updates the connection state.

Establishes a WebSocket connection to the specified URI.

fun disconnect(topic: String?, userInitiated: Boolean = false)

Disconnects the WebSocket client, optionally specifying whether the disconnection was user-initiated.

Emits an event with the given name and associated data to registered handlers.

fun off(event: String)

Unregisters all event handlers for a specified event.

Registers an event handler for a specified event.

fun send(message: String)

Sends a message over the WebSocket connection.

Sends a final message before disconnecting the WebSocket client.