kobweb-api/com.varabyte.kobweb.api.stream/StreamId

StreamId

class StreamId(val clientId: Short, val localStreamId: Short)(source)

Represents a unique ID for a stream.

This is commonly used when indicating which other streams should receive (or NOT receive) a broadcast message:

// Exclude from self:
ctx.stream.broadcastExcluding("Hello, everyone else!", ctx.stream.id)

As this class is simple, immutable data, it is totally safe to store a copy of it after receiving some event, e.g. if you receive a ClientConnected event, without worrying about major memory leaks. Just be sure to remove it when you receive a ClientDisconnected event that contains that stream ID.

In most cases, a user will only ever create a single client stream per API stream endpoint they want to connect to. However, a user could technically create multiple streams that attach to the same endpoint, and each one will get its own unique stream ID.

NOTE: A stream's ID is a hashed combination of its clientId and its localStreamId, which are both exposed as well.

Constructors

StreamId

constructor(clientId: Short, localStreamId: Short)

Types

Companion

object Companion

Properties

clientId

val clientId: Short

A value which uniquely identifies the client that connected this stream. In most cases, users will only create one stream per endpoint, but in the case a user does create multiple streams, the client ID will be the same across all of them.

localStreamId

val localStreamId: Short

A value which uniquely identifies a stream for a client (but not globally across all clients). In other words, multiple different StreamId instances may share the same localStreamId but they will represent different streams if associated with different clientId values.

value

val value: Int

A value uniquely identifying this stream globally across all connected clients and all of their streams.

Functions

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String