ergot 0.12.0

Eloquence in messaging
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

#[cfg(feature = "tokio-std")]
use crate::well_known::{SocketQuery, SocketQueryResponseAddress};
use crate::{net_stack::NetStackHandle, well_known::DeviceInfo};

/// A proxy type usable for performing Discovery services
pub struct Discovery<NS: NetStackHandle> {
    #[allow(dead_code)]
    pub(super) inner: NS,
}

#[derive(Debug, Hash, PartialEq, Eq)]
pub struct DeviceRecord {
    pub addr: crate::Address,
    pub info: DeviceInfo,
}

impl<NS: NetStackHandle> Discovery<NS> {
    /// Discover devices on the network
    ///
    /// Terminates when the timeout is reached
    #[cfg(feature = "tokio-std")]
    pub async fn discover(&self, bound: usize, timeout: std::time::Duration) -> Vec<DeviceRecord> {
        use crate::{
            net_stack::topics::Topics,
            well_known::{ErgotDeviceInfoInterrogationTopic, ErgotDeviceInfoTopic},
        };

        let topics = Topics {
            inner: self.inner.clone(),
        };
        let subber = topics
            .clone()
            .heap_bounded_receiver::<ErgotDeviceInfoTopic>(bound, None);
        let subber = std::pin::pin!(subber);
        let mut hdl = subber.subscribe_unicast();
        let port = hdl.port();
        let mut rxd = vec![];

        // AFTER creating the subscription, send the interrogation
        let res = topics
            .clone()
            .broadcast_with_src_port::<ErgotDeviceInfoInterrogationTopic>(&(), None, port);
        if res.is_err() {
            return vec![];
        }

        let fut = async {
            loop {
                let msg = hdl.recv().await;
                let addr = msg.hdr.src;
                let info = msg.t;
                rxd.push(DeviceRecord { addr, info });
            }
        };
        _ = tokio::time::timeout(timeout, fut).await;

        rxd
    }

    /// Send a request to discover sockets. This sends a broadcast message with the given
    /// query parameters, then listens for responses. These requests are usually handled by
    /// `Services::socket_query_handler()`.
    ///
    /// TODO: In the future, we should have helpers like `discover_topic_socket` and
    /// `discover_endpoint_socket` that populate the `SocketQuery` with correct info.
    #[cfg(feature = "tokio-std")]
    pub async fn discover_sockets(
        &self,
        bound: usize,
        timeout: std::time::Duration,
        query: &SocketQuery,
    ) -> Vec<SocketQueryResponseAddress> {
        use crate::{
            net_stack::topics::Topics,
            well_known::{ErgotSocketQueryResponseTopic, ErgotSocketQueryTopic},
        };

        // Set up listener for responses
        let topics = Topics {
            inner: self.inner.clone(),
        };
        let subber = topics
            .clone()
            .heap_bounded_receiver::<ErgotSocketQueryResponseTopic>(bound, None);
        let subber = std::pin::pin!(subber);
        // Responses are topic messages, but unicast not broadcast
        let mut hdl = subber.subscribe_unicast();
        let port = hdl.port();
        let mut rxd = vec![];

        // AFTER creating the subscription, send the interrogation
        let res = topics
            .clone()
            .broadcast_with_src_port::<ErgotSocketQueryTopic>(query, None, port);
        if res.is_err() {
            return vec![];
        }

        let fut = async {
            loop {
                let msg = hdl.recv().await;
                let mut addr = msg.hdr.src;
                addr.port_id = msg.t.port;
                rxd.push(SocketQueryResponseAddress {
                    name: msg.t.name,
                    address: addr,
                });
            }
        };
        _ = tokio::time::timeout(timeout, fut).await;

        rxd
    }
}