foundation_core 0.0.6

Central crate for all foundation crates for the ewe-platform project
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

use std::time;

pub const DEFAULT_MIN_DURATION: time::Duration = time::Duration::from_millis(100);

/// Attempts is a state identifying the overall expectation for
/// when a reconnection attempt should re-occur. It is Most
/// useful to allow the `ConnectionStateIterator` to be able to
/// securely handle retries.
#[derive(Clone, Debug)]
pub struct RetryState {
    pub wait: Option<time::Duration>,
    pub total_allowed: u32,
    pub attempt: u32,
}

impl RetryState {
    #[must_use]
    pub fn new(attempt: u32, total_allowed: u32, wait: Option<time::Duration>) -> Self {
        Self {
            wait,
            total_allowed,
            attempt,
        }
    }

    #[must_use]
    pub fn can_retry(&self) -> bool {
        self.attempt == self.total_allowed
    }
}

/// `ReconnectionDecider` defines an retry mechanism that allows
/// a central system to decide the next reconnection attempt parameters
/// regarding how long to wait before attempt and state info on the current
/// attempts and when such attempt to stop by returning None.
pub trait RetryDecider {
    fn decide(&self, state: RetryState) -> Option<RetryState>;
}

pub trait CReconnectionDecider: RetryDecider {
    fn clone_box(&self) -> Box<dyn CReconnectionDecider>;
}

impl<T> CReconnectionDecider for T
where
    T: RetryDecider + Clone + 'static,
{
    fn clone_box(&self) -> Box<dyn CReconnectionDecider> {
        Box::new(self.clone())
    }
}