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
use crate::{Request, Response};
use std::{convert, io, sync::Weak};
use tokio::{sync::mpsc, time::Duration};
mod mailbox;
pub use mailbox::*;
const CHANNEL_MAILBOX_CAPACITY: usize = 10000;
pub struct Channel<T, U>
where
T: Send + Sync,
U: Send + Sync,
{
pub(crate) tx: mpsc::Sender<Request<T>>,
pub(crate) post_office: Weak<PostOffice<Response<U>>>,
}
impl<T, U> Clone for Channel<T, U>
where
T: Send + Sync,
U: Send + Sync,
{
fn clone(&self) -> Self {
Self {
tx: self.tx.clone(),
post_office: Weak::clone(&self.post_office),
}
}
}
impl<T, U> Channel<T, U>
where
T: Send + Sync,
U: Send + Sync + 'static,
{
pub fn is_closed(&self) -> bool {
self.tx.is_closed()
}
pub async fn mail(&mut self, req: impl Into<Request<T>>) -> io::Result<Mailbox<Response<U>>> {
let req = req.into();
let mailbox = Weak::upgrade(&self.post_office)
.ok_or_else(|| {
io::Error::new(
io::ErrorKind::NotConnected,
"Session's post office is no longer available",
)
})?
.make_mailbox(req.id.clone(), CHANNEL_MAILBOX_CAPACITY)
.await;
self.fire(req).await?;
Ok(mailbox)
}
pub async fn mail_timeout(
&mut self,
req: impl Into<Request<T>>,
duration: impl Into<Option<Duration>>,
) -> io::Result<Mailbox<Response<U>>> {
match duration.into() {
Some(duration) => tokio::time::timeout(duration, self.mail(req))
.await
.map_err(|x| io::Error::new(io::ErrorKind::TimedOut, x))
.and_then(convert::identity),
None => self.mail(req).await,
}
}
pub async fn send(&mut self, req: impl Into<Request<T>>) -> io::Result<Response<U>> {
let mut mailbox = self.mail(req).await?;
mailbox
.next()
.await
.ok_or_else(|| io::Error::from(io::ErrorKind::ConnectionAborted))
}
pub async fn send_timeout(
&mut self,
req: impl Into<Request<T>>,
duration: impl Into<Option<Duration>>,
) -> io::Result<Response<U>> {
match duration.into() {
Some(duration) => tokio::time::timeout(duration, self.send(req))
.await
.map_err(|x| io::Error::new(io::ErrorKind::TimedOut, x))
.and_then(convert::identity),
None => self.send(req).await,
}
}
pub async fn fire(&mut self, req: impl Into<Request<T>>) -> io::Result<()> {
self.tx
.send(req.into())
.await
.map_err(|x| io::Error::new(io::ErrorKind::BrokenPipe, x.to_string()))
}
pub async fn fire_timeout(
&mut self,
req: impl Into<Request<T>>,
duration: impl Into<Option<Duration>>,
) -> io::Result<()> {
match duration.into() {
Some(duration) => tokio::time::timeout(duration, self.fire(req))
.await
.map_err(|x| io::Error::new(io::ErrorKind::TimedOut, x))
.and_then(convert::identity),
None => self.fire(req).await,
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::{Client, FramedTransport, TypedAsyncRead, TypedAsyncWrite};
use std::time::Duration;
type TestClient = Client<u8, u8>;
#[tokio::test]
async fn mail_should_return_mailbox_that_receives_responses_until_transport_closes() {
let (t1, mut t2) = FramedTransport::make_test_pair();
let session: TestClient = Client::from_framed_transport(t1).unwrap();
let mut channel = session.clone_channel();
let req = Request::new(0);
let res = Response::new(req.id.clone(), 1);
let mut mailbox = channel.mail(req).await.unwrap();
match tokio::join!(mailbox.next(), t2.write(res.clone())) {
(Some(actual), _) => assert_eq!(actual, res),
x => panic!("Unexpected response: {:?}", x),
}
match tokio::join!(mailbox.next(), t2.write(res.clone())) {
(Some(actual), _) => assert_eq!(actual, res),
x => panic!("Unexpected response: {:?}", x),
}
let next_task = tokio::spawn(async move { mailbox.next().await });
tokio::task::yield_now().await;
drop(t2);
match next_task.await {
Ok(None) => {}
x => panic!("Unexpected response: {:?}", x),
}
}
#[tokio::test]
async fn send_should_wait_until_response_received() {
let (t1, mut t2) = FramedTransport::make_test_pair();
let session: TestClient = Client::from_framed_transport(t1).unwrap();
let mut channel = session.clone_channel();
let req = Request::new(0);
let res = Response::new(req.id.clone(), 1);
let (actual, _) = tokio::join!(channel.send(req), t2.write(res.clone()));
match actual {
Ok(actual) => assert_eq!(actual, res),
x => panic!("Unexpected response: {:?}", x),
}
}
#[tokio::test]
async fn send_timeout_should_fail_if_response_not_received_in_time() {
let (t1, mut t2) = FramedTransport::make_test_pair();
let session: TestClient = Client::from_framed_transport(t1).unwrap();
let mut channel = session.clone_channel();
let req = Request::new(0);
match channel.send_timeout(req, Duration::from_millis(30)).await {
Err(x) => assert_eq!(x.kind(), io::ErrorKind::TimedOut),
x => panic!("Unexpected response: {:?}", x),
}
let _req = TypedAsyncRead::<Request<u8>>::read(&mut t2)
.await
.unwrap()
.unwrap();
}
#[tokio::test]
async fn fire_should_send_request_and_not_wait_for_response() {
let (t1, mut t2) = FramedTransport::make_test_pair();
let session: TestClient = Client::from_framed_transport(t1).unwrap();
let mut channel = session.clone_channel();
let req = Request::new(0);
match channel.fire(req).await {
Ok(_) => {}
x => panic!("Unexpected response: {:?}", x),
}
let _req = TypedAsyncRead::<Request<u8>>::read(&mut t2)
.await
.unwrap()
.unwrap();
}
}