pollingengine/in.androidplay.pollingengine.polling/PollingEngine

PollingEngine

object PollingEngine

Production-ready polling engine with exponential backoff and jitter.

Coroutine-friendly, supports cancellation.
Robust handling for rogue CancellationException (treat as retryable error if scope is still active).
Configurable via PollingConfig and BackoffPolicy.
Observability hooks and metrics (optional).

Types

Handle

data class Handle(val id: String)

State

enum State : Enum<PollingEngine.State>

Functions

activePollsCount

fun activePollsCount(): Int

cancel

suspend fun cancel(handle: PollingEngine.Handle)

suspend fun cancel(id: String)

cancelAll

suspend fun cancelAll()

Cancels all active polls and clears the registry.

compose

suspend fun <T> compose(vararg configs: PollingConfig<T>): PollingOutcome<T>

Compose multiple polling operations sequentially. Stops early on non-success outcomes. Returns the last outcome (success from the last config or the first non-success).

listActiveIds

suspend fun listActiveIds(): List<String>

pause

suspend fun pause(id: String)

pollUntil

suspend fun <T> pollUntil(config: PollingConfig<T>): PollingOutcome<T>

resume

suspend fun resume(id: String)

shutdown

suspend fun shutdown()

Shuts down the engine: cancels all polls, cancels its scope, and prevents new polls from starting.

startPolling

fun <T> startPolling(config: PollingConfig<T>, onComplete: (PollingOutcome<T>) -> Unit): PollingEngine.Handle

updateBackoff

suspend fun updateBackoff(id: String, newPolicy: BackoffPolicy)