Struct tor_basic_utils::retry::RetryDelay

pub struct RetryDelay { /* private fields */ }

An implementation for retrying a remote operation based on a decorrelated jitter schedule.

The algorithm used here has several desirable properties:

• It is randomized, so that multiple timeouts don’t have a danger of getting synchronized with each other and hammering the same servers all at once.
• It tends on average to wait longer and longer over time, so that if the server is down, it won’t get pummeled by a zillion failing clients when it comes back up.
• It has a chance of retrying promptly, which results in better client performance on average.

For a more full specification, see dir-spec.txt.

Implementations

impl RetryDelay

pub fn from_msec(base_delay_msec: u32) -> Self

Construct a new RetryDelay from a given base delay in milliseconds.

The base delay defines the lowest possible interval that can be returned.

Limitations

If the base delay is less than 1000, a base delay of 1000 is used instead, since that’s what the C tor implementation does.

pub fn from_duration(d: Duration) -> Self

Construct a new RetryDelay from a given base delay.

See from_msec for more information.

pub fn next_delay<R: Rng>(&mut self, rng: &mut R) -> Duration

Return the next delay to be used (as a Duration), according to a given random number generator.

pub fn reset(&mut self)

Return this RetryDelay to its original state.

Trait Implementations

impl Clone for RetryDelay

fn clone(&self) -> RetryDelay

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RetryDelay

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RetryDelay

fn default() -> Self

Returns the “default value” for a type.