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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
use std::{ops, time::Duration};

use lunatic::{
    serializer::{Bincode, Serializer},
    MailboxResult, Process, Tag,
};
use serde::{de::DeserializeOwned, Deserialize, Serialize};

use crate::TaggedMailbox;

/// Message containing a request, allowing for a response to be sent back.
///
/// Message requests can be created using [`MessageRequest::new`].
///
/// **A message request should always have [`reply`](MessageRequest::reply) called,
/// otherwise a process could be left waiting forever for a response (unless receive_timeout is used).**
#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)]
#[serde(bound = "Req: Serialize + for<'dee> Deserialize<'dee>")]
#[must_use]
pub struct MessageRequest<Req, Res, S = Bincode>
where
    S: Serializer<Res>,
{
    req: Req,
    req_process: Process<Res, S>,
    tag: Tag,
}

impl<Req, Res, S> MessageRequest<Req, Res, S>
where
    S: Serializer<Res>,
{
    /// Creates a new [MessageRequest] and [TaggedMailbox].
    ///
    /// The tagged mailbox can be used to wait for a response using [TaggedMailbox::receive].
    ///
    /// Internally, this method creates a tag which is shared between the message request and tagged mailbox.
    pub fn new(req: Req) -> (Self, TaggedMailbox<Res, S>) {
        let tag = Tag::new();
        let req = Self {
            req,
            req_process: Process::this(),
            tag,
        };
        let mailbox = TaggedMailbox::from_tag(tag);

        (req, mailbox)
    }

    /// Splits the message request into a [PendingProcess] and the inner request.
    ///
    /// This is useful if you need ownership of the inner request directly.
    pub fn into_parts(self) -> (PendingProcess<Res, S>, Req) {
        (
            PendingProcess {
                process: self.req_process,
                tag: self.tag,
            },
            self.req,
        )
    }

    /// Replies to the process with a response.
    pub fn reply(self, res: Res)
    where
        Res: Serialize + DeserializeOwned,
    {
        self.req_process.tag_send(self.tag, res);
    }
}

impl<Req, Res, S> ops::Deref for MessageRequest<Req, Res, S>
where
    S: Serializer<Res>,
{
    type Target = Req;

    fn deref(&self) -> &Self::Target {
        &self.req
    }
}

impl<Req, Res, S> ops::DerefMut for MessageRequest<Req, Res, S>
where
    S: Serializer<Res>,
{
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.req
    }
}

/// A process waiting to receive a response.
#[derive(Serialize, Deserialize)]
pub struct PendingProcess<M, S = Bincode> {
    process: Process<M, S>,
    tag: Tag,
}

impl<M, S> PendingProcess<M, S> {
    /// Returns a local node process ID.
    pub fn id(&self) -> u64 {
        self.process.id()
    }

    /// Returns a node ID.
    pub fn node_id(&self) -> u64 {
        self.process.node_id()
    }

    /// Replies to the request process with a response.
    pub fn reply(self, res: M)
    where
        S: Serializer<M>,
    {
        self.process.tag_send(self.tag, res);
    }

    /// Returns the inner process.
    pub fn process(&self) -> Process<M, S> {
        self.process
    }

    /// Returns the tag used by the pending process.
    pub fn tag(&self) -> Tag {
        self.tag
    }
}

/// Trait for sending a message request directly on a lunatic process.
pub trait ProcessRequest<M, S = Bincode> {
    /// Sends a message request and waits for a reponse.
    fn request<Res, Req, F>(&self, f: F, req: Req) -> Res
    where
        F: Fn(MessageRequest<Req, Res, S>) -> M,
        S: Serializer<Res> + Serializer<M>;

    /// Sends a message request and waits for a reponse with a timeout.
    fn request_timeout<Res, Req, F>(&self, f: F, req: Req, timeout: Duration) -> MailboxResult<Res>
    where
        F: Fn(MessageRequest<Req, Res, S>) -> M,
        S: Serializer<Res> + Serializer<M>;
}

impl<M, S, PS> ProcessRequest<M, S> for Process<M, PS>
where
    PS: Serializer<M>,
{
    fn request<Res, Req, F>(&self, f: F, req: Req) -> Res
    where
        F: Fn(MessageRequest<Req, Res, S>) -> M,
        S: Serializer<Res> + Serializer<M>,
    {
        let (msg_req, mailbox) = MessageRequest::new(req);
        let msg = f(msg_req);
        self.send(msg);
        mailbox.receive()
    }

    fn request_timeout<Res, Req, F>(&self, f: F, req: Req, timeout: Duration) -> MailboxResult<Res>
    where
        F: Fn(MessageRequest<Req, Res, S>) -> M,
        S: Serializer<Res> + Serializer<M>,
    {
        let (msg_req, mailbox) = MessageRequest::new(req);
        let msg = f(msg_req);
        self.send(msg);
        mailbox.receive_timeout(timeout)
    }
}

#[cfg(test)]
mod tests {
    use lunatic::{spawn_link, test};
    use serde::{Deserialize, Serialize};

    use super::*;

    #[derive(Serialize, Deserialize)]
    enum Message {
        Inc,
        Dec,
        Count(MessageRequest<(), i32>),
    }

    #[test]
    fn counter() {
        let process = spawn_link!(|mailbox: Mailbox<Message>| {
            let mut count = 0;

            loop {
                let msg = mailbox.receive();
                match msg {
                    Message::Inc => count += 1,
                    Message::Dec => count -= 1,
                    Message::Count(req) => req.reply(count),
                }
            }
        });

        let count = process.request(Message::Count, ());
        assert_eq!(count, 0);

        process.send(Message::Inc);

        let count = process.request(Message::Count, ());
        assert_eq!(count, 1);

        process.send(Message::Inc);

        let count = process.request(Message::Count, ());
        assert_eq!(count, 2);

        process.send(Message::Dec);

        let count = process.request(Message::Count, ());
        assert_eq!(count, 1);
    }

    #[test]
    fn timeout() {
        let process = spawn_link!(|mailbox: Mailbox<Message>| {
            let mut count = 0;

            loop {
                let msg = mailbox.receive();
                match msg {
                    Message::Inc => count += 1,
                    Message::Dec => count -= 1,
                    Message::Count(req) => {
                        lunatic::sleep(Duration::from_millis(100));
                        req.reply(count);
                    }
                }
            }
        });

        let count = process.request_timeout(Message::Count, (), Duration::from_millis(200));
        assert_eq!(count.unwrap(), 0);

        process.send(Message::Inc);

        let count = process.request_timeout(Message::Count, (), Duration::from_millis(50));
        assert!(count.is_timed_out());
    }
}