Struct Backoff

pub struct Backoff {
    base_delay: u64,
    max_delay: u64,
    retries: AtomicU32,
    stop: AtomicBool,
}

Exponential backoff https://en.wikipedia.org/wiki/Exponential_backoff

Examples

use karyon_core::async_util::Backoff;

 async {
    let backoff = Backoff::new(300, 3000);

    loop {
        backoff.sleep().await;
     
        // do something
        break;
    }

    backoff.reset();

    // ....
 };

Fields

base_delay: u64

The base delay in milliseconds for the initial retry.

max_delay: u64

The max delay in milliseconds allowed for a retry.

retries: AtomicU32

Atomic counter

stop: AtomicBool

Stop flag

Implementations

impl Backoff

pub fn new(base_delay: u64, max_delay: u64) -> Self

Creates a new Backoff.

pub async fn sleep(&self) -> u64

Sleep based on the current retry count and delay values. Retruns the delay value.

pub fn reset(&self)

Reset the retry counter to 0.