pollingengine/in.androidplay.pollingengine.polling/PollingConfigBuilder

PollingConfigBuilder

Builder Pattern for creating PollingConfig in a fluent, readable way. Keeps compatibility by producing the existing PollingConfig.

Constructors

constructor()

Functions

backoff

fun backoff(policy: BackoffPolicy): PollingConfigBuilder<T>

Sets the backoff policy controlling delays, jitter, attempts, and timeouts.

build

fun build(): PollingConfig<T>

dispatcher

fun dispatcher(dispatcher: CoroutineDispatcher): PollingConfigBuilder<T>

Sets the CoroutineDispatcher used to run polling. Defaults to Dispatchers.Default.

fetch

fun fetch(block: suspend () -> PollingResult<T>): PollingConfigBuilder<T>

Sets the suspending fetch operation that produces a PollingResult per attempt. Typical implementation performs I/O and maps responses/errors to domain results.

onAttempt

fun onAttempt(hook: (attempt: Int, delayMs: Long?) -> Unit): PollingConfigBuilder<T>

Hook invoked before each attempt is executed, providing the attempt index and the computed delay for the upcoming attempt (null for immediate).

onComplete

fun onComplete(hook: (attempts: Int, durationMs: Long, outcome: PollingOutcome<T>) -> Unit): PollingConfigBuilder<T>

Hook invoked once with the terminal outcome, total attempts, and elapsed time.

onResult

fun onResult(hook: (attempt: Int, result: PollingResult<T>) -> Unit): PollingConfigBuilder<T>

Hook invoked after each attempt completes with a result (Success/Waiting/Failure/Unknown/Cancelled).

retry

fun retry(predicate: (Error?) -> Boolean): PollingConfigBuilder<T>

Sets the retry predicate used when the last attempt produced a Failure(Error). Return true to retry, false to stop with Exhausted. See built-ins in RetryPredicates.

success

fun success(predicate: (T) -> Boolean): PollingConfigBuilder<T>

Sets the terminal success predicate. When it returns true for a Success(value), polling stops with PollingOutcome.Success.

throwableMapper

fun throwableMapper(mapper: (Throwable) -> Error): PollingConfigBuilder<T>

Sets a mapper to convert thrown exceptions into domain Error values. Defaults to a mapper that uses code=-1 and Throwable.message/class name.