pollingengine/in.androidplay.pollingengine.polling/PollingOutcome

PollingOutcome

Terminal outcome of a polling session.

Use exhaustive when to handle all cases:

when (outcome) { is PollingOutcome.Success -> { /* use outcome.value / } is PollingOutcome.Exhausted -> { / retries ended without success / } is PollingOutcome.Timeout -> { / overall timeout exceeded / } is PollingOutcome.Cancelled -> { / cancelled by user/system */ } }

Inheritors

Types

Cancelled

data class Cancelled(val attempts: Int, val elapsedMs: Long) : PollingOutcome<Nothing>

Cancelled externally or due to scope cancellation.

Exhausted

data class Exhausted(val last: PollingResult<*>?, val attempts: Int, val elapsedMs: Long) : PollingOutcome<Nothing>

Attempts exhausted or retry predicate returned false on last error.

Success

data class Success<T>(val value: T, val attempts: Int, val elapsedMs: Long) : PollingOutcome<T>

Terminal success with the last successful value.

Timeout

data class Timeout(val attempts: Int, val elapsedMs: Long) : PollingOutcome<Nothing>

Overall timeout reached.