msr-core 0.3.7

Industrial Automation Toolbox - Common core components
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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114

use std::time::{Duration, Instant};

use crate::sync::Arc;

use super::*;

type UnitRelay = Relay<()>;

const TIMEOUT_FOR_NEXT_NOTIFICATION: Duration = Duration::from_millis(100);

struct CapturedNotifications<T> {
    number_of_notifications: usize,
    last_value: Option<T>,
}

fn capture_notifications_fn<T>(
    relay: &Relay<T>,
    max_number_of_notifications: usize,
) -> CapturedNotifications<T> {
    let mut number_of_notifications = 0;
    let mut last_value = None;
    while number_of_notifications < max_number_of_notifications {
        let next_value = relay.wait_for(TIMEOUT_FOR_NEXT_NOTIFICATION);
        if next_value.is_none() {
            // Timed out
            break;
        }
        number_of_notifications += 1;
        last_value = next_value;
    }
    CapturedNotifications {
        number_of_notifications,
        last_value,
    }
}

#[test]
fn wait_for_timeout_zero_empty() {
    let relay = UnitRelay::default();

    assert!(relay.wait_for(Duration::ZERO).is_none());
}

#[test]
fn wait_for_timeout_zero_ready() {
    let relay = Relay::default();

    relay.replace_notify_one(());

    assert!(relay.wait_for(Duration::ZERO).is_some());
}

#[test]
fn wait_for_timeout_max_ready() {
    let relay = Relay::default();

    relay.replace_notify_one(());

    assert!(relay.wait_for(Duration::MAX).is_some());
}

#[test]
fn wait_until_deadline_now_empty() {
    let relay = UnitRelay::default();

    assert!(relay.wait_until(Instant::now()).is_none());
}

#[test]
fn wait_until_deadline_now_ready() {
    let relay = Relay::default();

    relay.replace_notify_one(());

    assert!(relay.wait_until(Instant::now()).is_some());
}

#[test]
fn keep_last_value() {
    let relay = Relay::default();

    let rounds = 10;

    for i in 1..=rounds {
        relay.replace_notify_one(i);
    }

    assert_eq!(Some(rounds), relay.take());
}

#[test]
fn capture_notifications_concurrently() {
    let relay = Arc::new(Relay::default());

    let rounds = 10;

    let thread = std::thread::spawn({
        let relay = Arc::clone(&relay);
        move || capture_notifications_fn(&relay, rounds)
    });

    for i in 1..=rounds {
        relay.replace_notify_one(i);
    }

    let CapturedNotifications {
        number_of_notifications,
        last_value,
    } = thread.join().unwrap();

    assert!(number_of_notifications >= 1);
    assert!(number_of_notifications <= rounds);
    assert_eq!(Some(rounds), last_value);
}