SyncStateObserver

Properties

Link copied to clipboard
abstract val syncState: <Error class: unknown class><SyncState>

Allows observing of SyncState. A value is always available immediately for new observers. Assumes that old SyncStates are not relevant anymore, so the available Flow has a limited buffer size and will drop the oldest values as there's no point in waiting for slow collectors. In case a slow collector is interested in receiving all values, it should add a buffer of its own.

Functions

Link copied to clipboard
abstract suspend fun isSlowSyncCompleted(): Boolean
Link copied to clipboard
abstract suspend fun isSlowSyncOngoing(): Boolean
Link copied to clipboard
abstract suspend fun waitUntilLive()

Suspends the caller until all pending events are processed, and the client has finished processing all pending events.

Link copied to clipboard
abstract suspend fun waitUntilLiveOrFailure(): <Error class: unknown class><<Error class: unknown class>, Unit>

If Sync is ongoing, suspends the caller until it reaches a terminal state.

Link copied to clipboard
abstract suspend fun waitUntilStartedOrFailure(): <Error class: unknown class><<Error class: unknown class>, Unit>