kuilt-websocket/us.tractat.kuilt.websocket/WebSocketAdvertisement

WebSocketAdvertisement

data class WebSocketAdvertisement(val url: String, val serverPeerId: PeerId, val sessionName: String, val roomKey: String? = null) : Tag

Tag for WebSocket transports.

Carries the ws:// or wss:// URL needed by KtorClientLoom.join plus the server's PeerId so both ends arrive at the same membership view without any in-band handshake.

Constructors

constructor(url: String, serverPeerId: PeerId, sessionName: String, roomKey: String? = null)

Properties

peerKey

open override val peerKey: String

roomKey

open override val roomKey: String?

The stable room identity this joiner targets, matched against the host's room before admission. Defaults to null (permissive) — a WebSocket relay binds the room by URL path, so the transport already names the target and no host-side room check is needed. The property lets a consumer set it on a flat fabric. See Tag.roomKey.

serverPeerId

val serverPeerId: PeerId

The server's PeerId for this endpoint. Must match the selfPeerId the corresponding KtorServerLoom was constructed with.

sessionName

open override val sessionName: String

Human-readable name for the local peer.

url

val url: String

WebSocket endpoint URL, e.g. ws://192.168.1.1:8080/live/session.