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
// Copyright (c) Sean Lawlor
//
// This source code is licensed under both the MIT license found in the
// LICENSE-MIT file in the root directory of this source tree.
//! Macro helpers for remote procedure calls
/// `cast!` takes an actor and a message and emits a [crate::RactorErr] error
/// which can be pattern matched on in order to derive the output.
/// `call!`: Perform an infinite-time remote procedure call to an [crate::Actor]
///
/// * `$actor` - The actor to call
/// * `$msg` - The message builder which takes in a [crate::port::RpcReplyPort] and emits a message which
/// the actor supports
/// * `$args` - (optional) Variable length arguments which will PRECEDE the reply channel when
/// constructing the message payload
///
/// Returns [Ok(_)] with the result on successful RPC or [Err(crate::RactorErr)] on failure
/// Example usage (without the `cluster` feature)
/// ```rust
/// use ractor::{call, Actor, RpcReplyPort, ActorRef, ActorProcessingErr};
/// struct TestActor;
/// enum MessageFormat {
/// TestRpc(String, RpcReplyPort<String>),
/// }
/// #[cfg(feature = "cluster")]
/// impl ractor::Message for MessageFormat {}
///
/// #[cfg_attr(feature = "async-trait", ractor::async_trait)]
/// impl Actor for TestActor {
/// type Msg = MessageFormat;
/// type Arguments = ();
/// type State = ();
///
/// async fn pre_start(&self, _this_actor: ActorRef<Self::Msg>, _: ()) -> Result<Self::State, ActorProcessingErr> {
/// Ok(())
/// }
///
/// async fn handle(
/// &self,
/// _this_actor: ActorRef<Self::Msg>,
/// message: Self::Msg,
/// _state: &mut Self::State,
/// ) -> Result<(), ActorProcessingErr> {
/// match message {
/// Self::Msg::TestRpc(arg, reply) => {
/// // An error sending means no one is listening anymore (the receiver was dropped),
/// // so we should shortcut the processing of this message probably!
/// if !reply.is_closed() {
/// let _ = reply.send(arg);
/// }
/// }
/// }
/// Ok(())
/// }
/// }
///
/// #[tokio::main]
/// async fn main() {
/// let (actor, handle) = Actor::spawn(None, TestActor, ()).await.unwrap();
/// let result = call!(actor, MessageFormat::TestRpc, "Something".to_string()).unwrap();
/// assert_eq!(result, "Something".to_string());
/// actor.stop(None);
/// handle.await.unwrap();
/// }
/// ```
/// `call_t!`: Perform an finite-time remote procedure call to an [crate::Actor]
///
/// * `$actor` - The actor to call
/// * `$msg` - The message builder variant
/// * `$timeout_ms` - the timeout in milliseconds for the remote procedure call
/// * `$args` - (optional) Variable length arguments which will PRECEDE the reply channel when
/// constructing the message payload
///
/// Returns [Ok(_)] with the result on successful RPC or [Err(crate::RactorErr)] on failure
///
/// Example usage
/// ```rust
/// use ractor::{call_t, Actor, ActorRef, RpcReplyPort, ActorProcessingErr};
/// struct TestActor;
/// enum MessageFormat {
/// TestRpc(String, RpcReplyPort<String>),
/// }
/// #[cfg(feature = "cluster")]
/// impl ractor::Message for MessageFormat {}
///
/// #[cfg_attr(feature = "async-trait", ractor::async_trait)]
/// impl Actor for TestActor {
/// type Msg = MessageFormat;
/// type Arguments = ();
/// type State = ();
///
/// async fn pre_start(&self, _this_actor: ActorRef<Self::Msg>, _: ()) -> Result<Self::State, ActorProcessingErr> {
/// Ok(())
/// }
///
/// async fn handle(
/// &self,
/// _this_actor: ActorRef<Self::Msg>,
/// message: Self::Msg,
/// _state: &mut Self::State,
/// ) -> Result<(), ActorProcessingErr> {
/// match message {
/// Self::Msg::TestRpc(arg, reply) => {
/// // An error sending means no one is listening anymore (the receiver was dropped),
/// // so we should shortcut the processing of this message probably!
/// if !reply.is_closed() {
/// let _ = reply.send(arg);
/// }
/// }
/// }
/// Ok(())
/// }
/// }
///
/// #[tokio::main]
/// async fn main() {
/// let (actor, handle) = Actor::spawn(None, TestActor, ()).await.unwrap();
/// let result = call_t!(actor, MessageFormat::TestRpc, 50, "Something".to_string()).unwrap();
/// assert_eq!(result, "Something".to_string());
/// actor.stop(None);
/// handle.await.unwrap();
/// }
/// ```
/// `forward!`: Perform a remote procedure call to a [crate::Actor]
/// and forwards the result to another actor if successful
///
/// * `$actor` - The actors to call
/// * `$msg` - The message builder, which takes in a [crate::port::RpcReplyPort] and emits a message which
/// the actor supports.
/// * `$forward` - The [crate::ActorRef] to forward the call to
/// * `$forward_mapping` - The message transformer from the RPC result to the forwarding actor's message format
/// * `$timeout` - The [crate::concurrency::Duration] to allow the call to complete before timing out.
///
/// Returns [Ok(())] on successful call forwarding, [Err(crate::RactorErr)] otherwies