yorkie/dev.yorkie.presence/Channel

Channel

class Channel(key: String) : Attachable

Constructors

constructor(key: String)

Properties

val eventStream: SharedFlow<ChannelEvent>

Functions

open override fun applyStatus(status: ResourceStatus)

applyStatus applies the channel status into this channel counter.

fun close()

close cancels the internal coroutine scope.

fun getActorID(): String?

getActorID returns the actor ID of this channel counter.

fun ~~getCount~~(): Long

getCount returns the current online session count value.

open override fun getKey(): String

getKey returns the key of this channel counter.

getSessionCount

fun getSessionCount(): Long

getSessionCount returns the current online session count value.

fun getSessionId(): String?

getSessionId returns the session ID from the server.

open override fun getStatus(): ResourceStatus

getStatus returns the status of this channel counter.

hasLocalChanges

open override fun hasLocalChanges(): Boolean

hasLocalChanges returns whether this channel has local changes or not. Channel is server-managed, so it always returns false.

fun isAttached(): Boolean

isAttached returns whether this channel counter is attached or not.

open override fun publish(event: ResourceEvent)

publish publishes an event to all registered handlers.

open override fun setActor(actorID: String)

setActor sets the actor ID into this channel counter.

fun setSessionId(sessionId: String?)

setSessionId sets the session ID from the server, or clears it with null so the next refresh runs as a first call. SDK-internal use.

fun ~~updateCount~~(count: Long, seq: Long): Boolean

updateCount updates the session count and sequence number if the sequence is newer. Returns true if the session count was updated, false if the update was ignored.

updateSessionCount

fun updateSessionCount(sessionCount: Long, seq: Long): Boolean

updateSessionCount updates the session count and sequence number if the sequence is newer. Returns true if the session count was updated, false if the update was ignored.