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

WebSocketAdvertisement

data class WebSocketAdvertisement(val url: String, val serverPeerId: PeerId, val displayName: String) : 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, displayName: String)

Properties

displayName

open override val displayName: String

Human-readable name for the local peer.

peerKey

open override val peerKey: String

serverPeerId

val serverPeerId: PeerId

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

url

val url: String

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