rusty_agent 0.1.1

multi-agent systems framework.
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

use crate::agent;
use std::sync;
use std::vec;

///
/// An struct to help create a new Agent.
///
pub struct AgentBuilder {
    ep: String,
    peers: sync::Arc<sync::Mutex<Vec<String>>>,
    msgs: sync::Arc<sync::Mutex<Vec<String>>>,
    ctxt: zmq::Context,
    wait: u64,
    timeout: u64,
}

/// Builder for creating new agents.
impl AgentBuilder {
    /// Creates a new agent.
    pub fn new(ep: String) -> Self {
        let ngbhs: sync::Arc<sync::Mutex<Vec<String>>> =
            sync::Arc::new(sync::Mutex::new(vec![ep.clone()]));
        let msgs: sync::Arc<sync::Mutex<Vec<String>>> = sync::Arc::new(sync::Mutex::new(vec![]));
        let context: zmq::Context = zmq::Context::new();
        Self {
            ep,
            peers: ngbhs,
            ctxt: context,
            msgs,
            wait: 100,
            timeout: 2,
        }
    }

    /// Set the timeout between pings to neighbours in seconds.
    pub fn timeout(mut self, timeout: u64) -> Self {
        self.timeout = timeout;
        self
    }

    /// Set the wait time in ms for a neighbour to respond.
    pub fn wait(mut self, wait: u64) -> Self {
        self.wait = wait;
        self
    }

    /// Create the actual ZeroAgent.
    pub fn build(self) -> agent::ZeroAgent {
        let Self {
            ep,
            peers,
            ctxt,
            msgs,
            wait,
            timeout,
        } = self;
        agent::ZeroAgent {
            ep,
            peers,
            ctxt,
            msgs,
            wait,
            timeout,
        }
    }
}

#[cfg(test)]
mod tests {
    use crate::agent::ZeroAgent;
    use super::*;

    // Test for success.

    #[test]
    fn test_build_for_success() {
        AgentBuilder::new("inproc://#0".to_string()).build();
    }

    #[test]
    fn test_timeout_for_success() {
        AgentBuilder::new("inproc://#0".to_string()).timeout(10).build();
    }

    #[test]
    fn test_wait_for_success() {
        AgentBuilder::new("inproc://#0".to_string()).wait(10).build();
    }

    // Test for failure.

    // Test for sanity.

        #[test]
    fn test_build_for_sanity() {
        let agent: ZeroAgent = AgentBuilder::new("inproc://#0".to_string()).timeout(1).wait(2).build();
        assert_eq!(agent.timeout, 1);
        assert_eq!(agent.wait, 2);
    }
}