-
Notifications
You must be signed in to change notification settings - Fork 2.9k
/
erpc.erl
1609 lines (1409 loc) · 61.5 KB
/
erpc.erl
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
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
%%
%% %CopyrightBegin%
%%
%% Copyright Ericsson AB 2020-2024. All Rights Reserved.
%%
%% Licensed under the Apache License, Version 2.0 (the "License");
%% you may not use this file except in compliance with the License.
%% You may obtain a copy of the License at
%%
%% http://www.apache.org/licenses/LICENSE-2.0
%%
%% Unless required by applicable law or agreed to in writing, software
%% distributed under the License is distributed on an "AS IS" BASIS,
%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
%% See the License for the specific language governing permissions and
%% limitations under the License.
%%
%% %CopyrightEnd%
%%
%% Author: Rickard Green
%%
-module(erpc).
-moduledoc """
Enhanced Remote Procedure Call
This module provide services similar to Remote Procedure Calls. A remote
procedure call is a method to call a function on a remote node and collect the
answer. It is used for collecting information on a remote node, or for running a
function with some specific side effects on the remote node.
This is an enhanced subset of the operations provided by the `m:rpc` module.
Enhanced in the sense that it makes it possible to distinguish between returned
value, raised exceptions, and other errors. `erpc` also has better performance
and scalability than the original `rpc` implementation. However, current `rpc`
module will utilize `erpc` in order to also provide these properties when
possible.
In order for an `erpc` operation to succeed, the remote node also needs to
support `erpc`. Typically only ordinary Erlang nodes as of OTP 23 have `erpc`
support.
Note that it is up to the user to ensure that correct code to execute via `erpc`
is available on the involved nodes.
> #### Note {: .info }
>
> For some important information about distributed signals, see the
> [Blocking Signaling Over Distribution](`e:system:ref_man_processes.md#blocking-signaling-over-distribution`)
> section in the _Processes_ chapter of the _Erlang Reference Manual_. Blocking
> signaling can, for example, cause timeouts in `erpc` to be significantly
> delayed.
""".
-moduledoc(#{since => "OTP 23.0"}).
%% Exported API
-export([call/2,
call/3,
call/4,
call/5,
cast/2,
cast/4,
send_request/2,
send_request/4,
send_request/6,
receive_response/1,
receive_response/2,
receive_response/3,
wait_response/1,
wait_response/2,
wait_response/3,
check_response/2,
check_response/3,
multicall/2,
multicall/3,
multicall/4,
multicall/5,
multicast/2,
multicast/4,
reqids_new/0,
reqids_size/1,
reqids_add/3,
reqids_to_list/1]).
-export_type([request_id/0, request_id_collection/0, timeout_time/0]).
%% Internal exports (also used by the 'rpc' module)
-export([execute_call/4,
execute_call/3,
execute_cast/3,
is_arg_error/4,
trim_stack/4,
call_result/4]).
%%------------------------------------------------------------------------
%% Nicer error stack trace...
-compile({inline,[{result,4},{collection_result,6},{timeout_value,1}]}).
-define(MAX_INT_TIMEOUT, 4294967295).
-define(IS_VALID_TMO_INT(TI_), (is_integer(TI_)
andalso (0 =< TI_)
andalso (TI_ =< ?MAX_INT_TIMEOUT))).
-doc """
The timeout time used by erpc functions.
The value can be:
- **`0..4294967295`** - Timeout relative to current time in milliseconds.
- **`infinity`** - Infinite timeout. That is, the operation will never time out.
- **`{abs, Timeout}`** - An absolute
[Erlang monotonic time](`erlang:monotonic_time/1`) timeout in milliseconds.
That is, the operation will time out when
[`erlang:monotonic_time(millisecond)`](`erlang:monotonic_time/1`) returns a
value larger than or equal to `Timeout`. `Timeout` is not allowed to identify
a time further into the future than `4294967295` milliseconds. Identifying the
timeout using an absolute timeout value is especially handy when you have a
deadline for responses corresponding to a complete collection of requests
(`t:request_id_collection/0`) , since you do not have to recalculate the
relative time until the deadline over and over again.
""".
-type timeout_time() :: 0..?MAX_INT_TIMEOUT | 'infinity' | {abs, integer()}.
%%------------------------------------------------------------------------
%% Exported API
%%------------------------------------------------------------------------
-doc(#{equiv => call(Node, Fun, infinity)}).
-doc(#{since => <<"OTP 23.0">>}).
-spec call(Node, Fun) -> Result when
Node :: node(),
Fun :: function(),
Result :: term().
call(N, Fun) ->
call(N, Fun, infinity).
-doc """
Equivalent to
[`erpc:call(Node, erlang, apply, [Fun,[]], Timeout)`](`call/5`).
May raise all the same exceptions as [`call/5`](`call/5`) plus an `{erpc, badarg}`
`error` exception if `Fun` is not a fun of zero arity.
""".
-doc(#{since => <<"OTP 23.0">>}).
-spec call(Node, Fun, Timeout) -> Result when
Node :: node(),
Fun :: function(),
Timeout :: timeout_time(),
Result :: term().
call(N, Fun, Timeout) when is_function(Fun, 0) ->
call(N, erlang, apply, [Fun, []], Timeout);
call(_N, _Fun, _Timeout) ->
error({?MODULE, badarg}).
-doc(#{equiv => call(Node, Module, Function, Args, infinity)}).
-doc(#{since => <<"OTP 23.0">>}).
-spec call(Node, Module, Function, Args) -> Result when
Node :: node(),
Module :: atom(),
Function :: atom(),
Args :: [term()],
Result :: term().
call(N, M, F, A) ->
call(N, M, F, A, infinity).
-dialyzer([{nowarn_function, call/5}, no_return]).
-doc """
Evaluates [`apply(Module, Function, Args)`](`apply/3`) on node `Node` and
returns the corresponding value `Result`. `Timeout` sets an upper time limit for
the `call` operation to complete.
The `call()` function only returns if the applied function successfully returned
without raising any uncaught exceptions, the operation did not time out, and no
failures occurred. In all other cases an exception is raised. The following
exceptions, listed by exception class, can currently be raised by `call()`:
- **`throw`** - The applied function called [`throw(Value)`](`throw/1`) and did
not catch this exception. The exception reason `Value` equals the argument
passed to [`throw/1`](`throw/1`).
- **`exit`** - Exception reason:
- **`{exception, ExitReason}`** - The applied function called
[`exit(ExitReason)`](`exit/1`) and did not catch this exception. The exit
reason `ExitReason` equals the argument passed to [`exit/1`](`exit/1`).
- **`{signal, ExitReason}`** - The process that applied the function received
an exit signal and terminated due to this signal. The process terminated
with exit reason `ExitReason`.
- **`error`** - Exception reason:
- **`{exception, ErrorReason, StackTrace}`** - A runtime error occurred which
raised an error exception while applying the function, and the applied
function did not catch the exception. The error reason `ErrorReason`
indicates the type of error that occurred. `StackTrace` is formatted as when
caught in a `try/catch` construct. The `StackTrace` is limited to the
applied function and functions called by it.
- **`{erpc, ERpcErrorReason}`** - The `erpc` operation failed. The following
`ERpcErrorReason`s are the most common ones:
- **`badarg`** - If any one of these are true:
- `Node` is not an atom.
- `Module` is not an atom.
- `Function` is not an atom.
- `Args` is not a list. Note that the list is not verified to be a proper
list at the client side.
- `Timeout` is invalid.
- **`noconnection`** - The connection to `Node` was lost or could not be
established. The function may or may not be applied.
- **`system_limit`** - The `erpc` operation failed due to some system limit
being reached. This typically due to failure to create a process on the
remote node `Node`, but can be other things as well.
- **`timeout`** - The `erpc` operation timed out. The function may or may
not be applied.
- **`notsup`** - The remote node `Node` does not support this `erpc`
operation.
If the `erpc` operation fails, but it is unknown if the function is/will be
applied (that is, a timeout or a connection loss), the caller will not receive
any further information about the result if/when the applied function completes.
If the applied function explicitly communicates with the calling process, such
communication may, of course, reach the calling process.
> #### Note {: .info }
>
> You cannot make _any_ assumptions about the process that will perform the
> `apply()`. It may be the calling process itself, a server, or a freshly
> spawned process.
""".
-doc(#{since => <<"OTP 23.0">>}).
-spec call(Node, Module, Function, Args, Timeout) -> Result when
Node :: node(),
Module :: atom(),
Function :: atom(),
Args :: [term()],
Timeout :: timeout_time(),
Result :: term().
call(N, M, F, A, infinity) when node() =:= N, %% Optimize local call
is_atom(M),
is_atom(F),
is_list(A) ->
try
{return, Return} = execute_call(M,F,A),
Return
catch
exit:Reason ->
exit({exception, Reason});
error:Reason:Stack ->
case is_arg_error(Reason, M, F, A) of
true ->
error({?MODULE, Reason});
false ->
ErpcStack = trim_stack(Stack, M, F, A),
error({exception, Reason, ErpcStack})
end
end;
call(N, M, F, A, T) when is_atom(N),
is_atom(M),
is_atom(F),
is_list(A) ->
Timeout = timeout_value(T),
Res = make_ref(),
ReqId = spawn_request(N, ?MODULE, execute_call, [Res, M, F, A],
[{reply, error_only}, monitor]),
receive
{spawn_reply, ReqId, error, Reason} ->
result(spawn_reply, ReqId, Res, Reason);
{'DOWN', ReqId, process, _Pid, Reason} ->
result(down, ReqId, Res, Reason)
after Timeout ->
result(timeout, ReqId, Res, undefined)
end;
call(_N, _M, _F, _A, _T) ->
error({?MODULE, badarg}).
%% Asynchronous call
-doc "An opaque request identifier. For more information see `send_request/4`.".
-opaque request_id() :: nonempty_improper_list(reference(), reference()).
-doc """
An opaque collection of request identifiers (`t:request_id/0`) where each
request identifier can be associated with a label chosen by the user. For more
information see `reqids_new/0`.
""".
-opaque request_id_collection() :: #{ reference() => [reference() | term()] }.
-doc """
Equivalent to
[`erpc:send_request(Node, erlang, apply, [Fun, []])`](`send_request/4`).
Fails with an `{erpc, badarg}` `error` exception if:
- `Node` is not an atom.
- `Fun` is not a fun of zero arity.
> #### Note {: .info }
>
> You cannot make _any_ assumptions about the process that will perform the
> `apply()`. It may be a server, or a freshly spawned process.
""".
-doc(#{since => <<"OTP 23.0">>}).
-spec send_request(Node, Fun) -> RequestId when
Node :: node(),
Fun :: function(),
RequestId :: request_id().
send_request(N, F) when is_atom(N), is_function(F, 0) ->
send_request(N, erlang, apply, [F, []]);
send_request(_N, _F) ->
error({?MODULE, badarg}).
-dialyzer({no_improper_lists, send_request/4}).
-doc """
Send an asynchronous `call` request to the node `Node`.
[`send_request/4`](`send_request/4`) returns a request identifier that later is
to be passed to either `receive_response/2`, `wait_response/2`, or,
`check_response/2` in order to get the response of the call request. Besides
passing the request identifier directly to these functions, it can also be added
in a request identifier collection using `reqids_add/3`. Such a collection of
request identifiers can later be used in order to get one response corresponding
to a request in the collection by passing the collection as argument to
`receive_response/3`, `wait_response/3`, or, `check_response/3`. If you are
about to save the request identifier in a request identifier collection, you may
want to consider using `send_request/6` instead.
A call to the function `my_call(Node, Module, Function, Args, Timeout)` below is
equivalent to the call
[`erpc:call(Node, Module, Function, Args, Timeout)`](`call/5`) if one disregards
performance. `call()` can utilize a selective receive optimization which removes
the need to scan the message queue from the beginning in order to find a
matching message. The `send_request()/receive_response()` combination can,
however, not utilize this optimization.
```erlang
my_call(Node, Module, Function, Args, Timeout) ->
RequestId = erpc:send_request(Node, Module, Function, Args),
erpc:receive_response(RequestId, Timeout).
```
Fails with an `{erpc, badarg}` `error` exception if:
- `Node` is not an atom.
- `Module` is not an atom.
- `Function` is not an atom.
- `Args` is not a list. Note that the list is not verified to be a proper list
at the client side.
> #### Note {: .info }
>
> You cannot make _any_ assumptions about the process that will perform the
> `apply()`. It may be a server, or a freshly spawned process.
Equivalent to
[`erpc:send_request(Node, erlang, apply, [Fun,[]]), Label, RequestIdCollection)`](`send_request/6`).
Fails with an `{erpc, badarg}` `error` exception if:
- `Node` is not an atom.
- `Fun` is not a fun of zero arity.
- `RequestIdCollection` is detected not to be request identifier collection.
> #### Note {: .info }
>
> You cannot make _any_ assumptions about the process that will perform the
> `apply()`. It may be a server, or a freshly spawned process.
""".
-doc(#{since => <<"OTP 23.0">>}).
-spec send_request(Node, Module, Function, Args) -> RequestId when
Node :: node(),
Module :: atom(),
Function :: atom(),
Args :: [term()],
RequestId :: request_id();
(Node, Fun, Label, RequestIdCollection) ->
NewRequestIdCollection when
Node :: node(),
Fun :: function(),
Label :: term(),
RequestIdCollection :: request_id_collection(),
NewRequestIdCollection :: request_id_collection().
send_request(N, M, F, A) when is_atom(N),
is_atom(M),
is_atom(F),
is_list(A) ->
Res = make_ref(),
ReqId = spawn_request(N, ?MODULE, execute_call, [Res, M, F, A],
[{reply, error_only}, monitor]),
[Res|ReqId];
send_request(N, F, L, C) when is_atom(N), is_function(F, 0), is_map(C) ->
send_request(N, erlang, apply, [F, []], L, C);
send_request(_, _, _, _) ->
error({?MODULE, badarg}).
-dialyzer({no_improper_lists, send_request/6}).
-doc """
Send an asynchronous `call` request to the node `Node`. The `Label` will be
associated with the request identifier of the operation and added to the
returned request identifier collection `NewRequestIdCollection`. The collection
can later be used in order to get one response corresponding to a request in the
collection by passing the collection as argument to `receive_response/3`,
`wait_response/3`, or, `check_response/3`.
Equivalent to
[`erpc:reqids_add`](`reqids_add/3`)([`erpc:send_request`](`send_request/4`)`(Node, Module, Function, Args), Label, RequestIdCollection)`,
but calling [`send_request/6`](`send_request/6`) is slightly more efficient.
Fails with an `{erpc, badarg}` `error` exception if:
- `Node` is not an atom.
- `Module` is not an atom.
- `Function` is not an atom.
- `Args` is not a list. Note that the list is not verified to be a proper list
at the client side.
- `RequestIdCollection` is detected not to be request identifier collection.
> #### Note {: .info }
>
> You cannot make _any_ assumptions about the process that will perform the
> `apply()`. It may be a server, or a freshly spawned process.
""".
-doc(#{since => <<"OTP 25.0">>}).
-spec send_request(Node, Module, Function, Args,
Label, RequestIdCollection) ->
NewRequestIdCollection when
Node :: node(),
Module :: atom(),
Function :: atom(),
Args :: [term()],
Label :: term(),
RequestIdCollection :: request_id_collection(),
NewRequestIdCollection :: request_id_collection().
send_request(N, M, F, A, L, C) when is_atom(N),
is_atom(M),
is_atom(F),
is_list(A),
is_map(C) ->
Res = make_ref(),
ReqId = spawn_request(N, ?MODULE, execute_call, [Res, M, F, A],
[{reply, error_only}, monitor]),
maps:put(ReqId, [Res|L], C);
send_request(_N, _M, _F, _A, _L, _C) ->
error({?MODULE, badarg}).
-doc(#{ equiv => receive_response(RequestId, infinity) }).
-doc(#{since => <<"OTP 23.0">>}).
-spec receive_response(RequestId) -> Result when
RequestId :: request_id(),
Result :: term().
receive_response([Res|ReqId] = RId) when is_reference(Res),
is_reference(ReqId) ->
receive_response(RId, infinity);
receive_response(_) ->
error({?MODULE, badarg}).
-dialyzer([{nowarn_function, receive_response/2}, no_return]).
-doc """
Receive a response to a `call` request previously made by the calling process
using `send_request/4`.
`RequestId` should be the value returned from the
previously made [`send_request/4`](`send_request/4`) call, and the corresponding
response should not already have been received and handled to completion by
`receive_response()`, [`check_response/4`](`check_response/2`), or
[`wait_response/4`](`wait_response/2`).
`Timeout` sets an upper time limit on how long to wait for a response. If the
operation times out, the request identified by `RequestId` will be abandoned,
then an `{erpc, timeout}` `error` exception will be raised. That is, no response
corresponding to the request will ever be received after a timeout. If a
response is received, the `call` operation is completed and either the result is
returned or an exception is raised. The exceptions that can be raised
corresponds to the same exceptions as can be raised by `call/5`.
[`receive_response/2`](`receive_response/2`) will fail with an `{erpc, badarg}`
exception if/when an invalid `RequestId` is detected or if an invalid `Timeout`
is passed.
A call to the function `my_call(Node, Module, Function, Args, Timeout)` below is
equivalent to the call
[`erpc:call(Node, Module, Function, Args, Timeout)`](`call/5`) if one disregards
performance. `call()` can utilize a selective receive optimization which removes
the need to scan the message queue from the beginning in order to find a
matching message. The `send_request()/receive_response()` combination can,
however, not utilize this optimization.
```erlang
my_call(Node, Module, Function, Args, Timeout) ->
RequestId = erpc:send_request(Node, Module, Function, Args),
erpc:receive_response(RequestId, Timeout).
```
If the `erpc` operation fails, but it is unknown if the function is/will be
applied (that is, a timeout, or a connection loss), the caller will not receive
any further information about the result if/when the applied function completes.
If the applied function explicitly communicates with the calling process, such
communication may, of course, reach the calling process.
""".
-doc(#{since => <<"OTP 23.0">>}).
-spec receive_response(RequestId, Timeout) -> Result when
RequestId :: request_id(),
Timeout :: timeout_time(),
Result :: term().
receive_response([Res|ReqId], Tmo) when is_reference(Res),
is_reference(ReqId) ->
Timeout = timeout_value(Tmo),
receive
{spawn_reply, ReqId, error, Reason} ->
result(spawn_reply, ReqId, Res, Reason);
{'DOWN', ReqId, process, _Pid, Reason} ->
result(down, ReqId, Res, Reason)
after Timeout ->
result(timeout, ReqId, Res, undefined)
end;
receive_response(_, _) ->
error({?MODULE, badarg}).
-dialyzer([{nowarn_function, receive_response/3}, no_return]).
-doc """
Receive a response to a `call` request corresponding to a request identifier
saved in `RequestIdCollection`. All request identifiers of `RequestIdCollection`
must correspond to requests that have been made using `send_request/4` or
`send_request/6`, and all requests must have been made by the process calling
this function.
`Label` is the label associated with the request identifier of the request that
the response corresponds to. A request identifier is associated with a label
when [adding a request identifier](`reqids_add/3`) in a
[request identifier collection](`t:request_id_collection/0`), or when sending
the request using `send_request/6`.
Compared to `receive_response/2`, the returned result associated with a specific
request identifier or an exception associated with a specific request identifier
will be wrapped in a 3-tuple. The first element of this tuple equals the value
that would have been produced by [`receive_response/2`](`receive_response/2`),
the second element equals the `Label` associated with the specific request
identifier, and the third element `NewRequestIdCollection` is a possibly
modified request identifier collection. The `error` exceptions `{erpc, badarg}`
and `{erpc, timeout}` are not associated with any specific request identifiers,
and will hence not be wrapped.
If `RequestIdCollection` is empty, the atom `no_request` will be returned.
If the operation times out, all requests identified by `RequestIdCollection`
will be abandoned, then an `{erpc, timeout}` `error` exception will be raised.
That is, no responses corresponding to any of the request identifiers in
`RequestIdCollection` will ever be received after a timeout. The difference
between [`receive_response/3`](`receive_response/3`) and `wait_response/3` is
that [`receive_response/3`](`receive_response/3`) abandons the requests at
timeout so that any potential future responses are ignored, while
[`wait_response/3`](`wait_response/3`) does not.
If `Delete` equals `true`, the association with `Label` will have been deleted
from `RequestIdCollection` in the resulting `NewRequestIdCollection`. If
`Delete` equals `false`, `NewRequestIdCollection` will equal
`RequestIdCollection`. Note that deleting an association is not for free and
that a collection containing already handled requests can still be used by
subsequent calls to [`receive_response/3`](`receive_response/3`),
`check_response/3`, and `wait_response/3`. However, without deleting handled
associations, the above calls will not be able to detect when there are no more
outstanding requests to handle, so you will have to keep track of this some
other way than relying on a `no_request` return. Note that if you pass a
collection only containing associations of already handled or abandoned requests
to [`receive_response/3`](`receive_response/3`), it will always block until a
timeout determined by `Timeout` is triggered.
Note that a response might have been consumed uppon an `{erpc, badarg}`
exception and if so, will be lost for ever.
""".
-doc(#{since => <<"OTP 25.0">>}).
-spec receive_response(RequestIdCollection, Timeout, Delete) ->
{Result, Label, NewRequestIdCollection} | 'no_request' when
RequestIdCollection :: request_id_collection(),
Timeout :: timeout_time(),
Delete :: boolean(),
Result :: term(),
Label :: term(),
NewRequestIdCollection :: request_id_collection().
receive_response(ReqIdCol, WT, Del) when map_size(ReqIdCol) == 0,
is_boolean(Del) ->
_ = timeout_value(WT),
no_request;
receive_response(ReqIdCol, Tmo, Del) when is_map(ReqIdCol),
is_boolean(Del) ->
Timeout = timeout_value(Tmo),
receive
{spawn_reply, ReqId, error, Reason}
when is_map_key(ReqId, ReqIdCol), is_reference(ReqId) ->
collection_result(spawn_reply, ReqId, Reason, ReqIdCol, false, Del);
{'DOWN', ReqId, process, _Pid, Reason}
when is_map_key(ReqId, ReqIdCol), is_reference(ReqId) ->
collection_result(down, ReqId, Reason, ReqIdCol, false, Del)
after Timeout ->
collection_result(timeout, ok, ok, ReqIdCol, false, Del)
end;
receive_response(_, _, _) ->
error({?MODULE, badarg}).
-doc """
Equivalent to [`erpc:wait_response(RequestId, 0)`](`wait_response/2`).
That is, poll for a response message to a `call` request previously made by the
calling process.
""".
-doc(#{since => <<"OTP 23.0">>}).
-spec wait_response(RequestId) ->
{'response', Result} | 'no_response' when
RequestId :: request_id(),
Result :: term().
wait_response([Res|ReqId] = RId) when is_reference(Res),
is_reference(ReqId) ->
wait_response(RId, 0);
wait_response(_) ->
error({?MODULE, badarg}).
-dialyzer([{nowarn_function, wait_response/2}, no_return]).
-doc """
Wait or poll for a response message to a `call` request previously made by the
calling process using `send_request/4`.
`RequestId` should be the value returned from the previously made `send_request()`
call, and the corresponding response should not already have been received and
handled to completion by `check_response/2`, `receive_response/2`, or `wait_response()`.
`WaitTime` sets an upper time limit on how long to wait for a response. If no
response is received before the `WaitTime` timeout has triggered, the atom
`no_response` is returned. It is valid to continue waiting for a response as
many times as needed up until a response has been received and completed by
`check_response()`, `receive_response()`, or `wait_response()`. If a response is
received, the `call` operation is completed and either the result is returned as
`{response, Result}` where `Result` corresponds to the value returned from the
applied function or an exception is raised. The exceptions that can be raised
corresponds to the same exceptions as can be raised by `call/4`. That is, no
`{erpc, timeout}` `error` exception can be raised.
[`wait_response/2`](`wait_response/2`) will fail with an `{erpc, badarg}`
exception if/when an invalid `RequestId` is detected or if an invalid `WaitTime`
is passed.
If the `erpc` operation fails, but it is unknown if the function is/will be
applied (that is, a too large wait time value, or a connection loss), the caller
will not receive any further information about the result if/when the applied
function completes. If the applied function explicitly communicates with the
calling process, such communication may, of course, reach the calling process.
""".
-doc(#{since => <<"OTP 23.0">>}).
-spec wait_response(RequestId, WaitTime) ->
{'response', Result} | 'no_response' when
RequestId :: request_id(),
WaitTime :: timeout_time(),
Result :: term().
wait_response([Res|ReqId], WT) when is_reference(Res),
is_reference(ReqId) ->
Timeout = timeout_value(WT),
receive
{spawn_reply, ReqId, error, Reason} ->
result(spawn_reply, ReqId, Res, Reason);
{'DOWN', ReqId, process, _Pid, Reason} ->
{response, result(down, ReqId, Res, Reason)}
after Timeout ->
no_response
end;
wait_response(_, _) ->
error({?MODULE, badarg}).
-doc """
Wait or poll for a response to a `call` request corresponding to a request
identifier saved in `RequestIdCollection`. All request identifiers of
`RequestIdCollection` must correspond to requests that have been made using
`send_request/4` or `send_request/6`, and all requests must have been made by
the process calling this function.
`Label` is the label associated with the request identifier of the request that
the response corresponds to. A request identifier is associated with a label
when [adding a request identifier](`reqids_add/3`) in a
[request identifier collection](`t:request_id_collection/0`), or when sending
the request using `send_request/6`.
Compared to `wait_response/2`, the returned result associated with a specific
request identifier or an exception associated with a specific request identifier
will be wrapped in a 3-tuple. The first element of this tuple equals the value
that would have been produced by [`wait_response/2`](`wait_response/2`), the
second element equals the `Label` associated with the specific request
identifier, and the third element `NewRequestIdCollection` is a possibly
modified request identifier collection. The `error` exception `{erpc, badarg}`
is not associated with any specific request identifier, and will hence not be
wrapped.
If `RequestIdCollection` is empty, `no_request` will be returned. If no response
is received before the `WaitTime` timeout has triggered, the atom `no_response`
is returned. It is valid to continue waiting for a response as many times as
needed up until a response has been received and completed by
`check_response()`, `receive_response()`, or `wait_response()`. The difference
between `receive_response/3` and [`wait_response/3`](`wait_response/3`) is that
[`receive_response/3`](`receive_response/3`) abandons requests at timeout so
that any potential future responses are ignored, while
[`wait_response/3`](`wait_response/3`) does not.
If `Delete` equals `true`, the association with `Label` will have been deleted
from `RequestIdCollection` in the resulting `NewRequestIdCollection`. If
`Delete` equals `false`, `NewRequestIdCollection` will equal
`RequestIdCollection`. Note that deleting an association is not for free and
that a collection containing already handled requests can still be used by
subsequent calls to [`wait_response/3`](`wait_response/3`), `check_response/3`,
and `receive_response/3`. However, without deleting handled associations, the
above calls will not be able to detect when there are no more outstanding
requests to handle, so you will have to keep track of this some other way than
relying on a `no_request` return. Note that if you pass a collection only
containing associations of already handled or abandoned requests to
[`wait_response/3`](`wait_response/3`), it will always block until a timeout
determined by `WaitTime` is triggered and then return `no_response`.
Note that a response might have been consumed uppon an `{erpc, badarg}`
exception and if so, will be lost for ever.
""".
-doc(#{since => <<"OTP 25.0">>}).
-spec wait_response(RequestIdCollection, WaitTime, Delete) ->
{{'response', Result}, Label, NewRequestIdCollection} |
'no_response' |
'no_request' when
RequestIdCollection :: request_id_collection(),
WaitTime :: timeout_time(),
Delete :: boolean(),
Label :: term(),
NewRequestIdCollection :: request_id_collection(),
Result :: term().
wait_response(ReqIdCol, WT, Del) when map_size(ReqIdCol) == 0,
is_boolean(Del) ->
_ = timeout_value(WT),
no_request;
wait_response(ReqIdCol, WT, Del) when is_map(ReqIdCol),
is_boolean(Del) ->
Timeout = timeout_value(WT),
receive
{spawn_reply, ReqId, error, Reason}
when is_map_key(ReqId, ReqIdCol), is_reference(ReqId) ->
collection_result(spawn_reply, ReqId, Reason, ReqIdCol, true, Del);
{'DOWN', ReqId, process, _Pid, Reason}
when is_map_key(ReqId, ReqIdCol), is_reference(ReqId) ->
collection_result(down, ReqId, Reason, ReqIdCol, true, Del)
after Timeout ->
no_response
end;
wait_response(_, _, _) ->
error({?MODULE, badarg}).
-dialyzer([{nowarn_function, check_response/2}, no_return]).
-doc """
Check if a message is a response to a `call` request previously made by the
calling process using `send_request/4`.
`RequestId` should be the value returned from the previously made
[`send_request/4`](`send_request/4`) call, and the
corresponding response should not already have been received and handled to
completion by [`check_response/2`](`check_response/2`), `receive_response/2`, or
`wait_response/2`. `Message` is the message to check.
If `Message` does not correspond to the response, the atom `no_response` is
returned. If `Message` corresponds to the response, the `call` operation is
completed and either the result is returned as `{response, Result}` where
`Result` corresponds to the value returned from the applied function or an
exception is raised. The exceptions that can be raised corresponds to the same
exceptions as can be raised by `call/4`. That is, no `{erpc, timeout}` `error`
exception can be raised. `check_response()` will fail with an `{erpc, badarg}`
exception if/when an invalid `RequestId` is detected.
If the `erpc` operation fails, but it is unknown if the function is/will be
applied (that is, a connection loss), the caller will not receive any further
information about the result if/when the applied function completes. If the
applied function explicitly communicates with the calling process, such
communication may, of course, reach the calling process.
""".
-doc(#{since => <<"OTP 23.0">>}).
-spec check_response(Message, RequestId) ->
{'response', Result} | 'no_response' when
Message :: term(),
RequestId :: request_id(),
Result :: term().
check_response({spawn_reply, ReqId, error, Reason},
[Res|ReqId]) when is_reference(Res),
is_reference(ReqId) ->
result(spawn_reply, ReqId, Res, Reason);
check_response({'DOWN', ReqId, process, _Pid, Reason},
[Res|ReqId]) when is_reference(Res),
is_reference(ReqId) ->
{response, result(down, ReqId, Res, Reason)};
check_response(_Msg, [Res|ReqId]) when is_reference(Res),
is_reference(ReqId) ->
no_response;
check_response(_, _) ->
error({?MODULE, badarg}).
-doc """
Check if a message is a response to a `call` request corresponding to a request
identifier saved in `RequestIdCollection`. All request identifiers of
`RequestIdCollection` must correspond to requests that have been made using
`send_request/4` or `send_request/6`, and all requests must have been made by
the process calling this function.
`Label` is the label associated with the request identifier of the request that
the response corresponds to. A request identifier is associated with a label
when [adding a request identifier](`reqids_add/3`) in a
[request identifier collection](`t:request_id_collection/0`), or when sending
the request using `send_request/6`.
Compared to `check_response/2`, the returned result associated with a specific
request identifier or an exception associated with a specific request identifier
will be wrapped in a 3-tuple. The first element of this tuple equals the value
that would have been produced by [`check_response/2`](`check_response/2`), the
second element equals the `Label` associated with the specific request
identifier, and the third element `NewRequestIdCollection` is a possibly
modified request identifier collection. The `error` exception `{erpc, badarg}`
is not associated with any specific request identifier, and will hence not be
wrapped.
If `RequestIdCollection` is empty, the atom `no_request` will be returned. If
`Message` does not correspond to any of the request identifiers in
`RequestIdCollection`, the atom `no_response` is returned.
If `Delete` equals `true`, the association with `Label` will have been deleted
from `RequestIdCollection` in the resulting `NewRequestIdCollection`. If
`Delete` equals `false`, `NewRequestIdCollection` will equal
`RequestIdCollection`. Note that deleting an association is not for free and
that a collection containing already handled requests can still be used by
subsequent calls to [`check_response/3`](`check_response/3`),
`receive_response/3`, and `wait_response/3`. However, without deleting handled
associations, the above calls will not be able to detect when there are no more
outstanding requests to handle, so you will have to keep track of this some
other way than relying on a `no_request` return. Note that if you pass a
collection only containing associations of already handled or abandoned requests
to [`check_response/3`](`check_response/3`), it will always return
`no_response`.
Note that a response might have been consumed uppon an `{erpc, badarg}`
exception and if so, will be lost for ever.
""".
-doc(#{since => <<"OTP 25.0">>}).
-spec check_response(Message, RequestIdCollection, Delete) ->
{{'response', Result}, Label, NewRequestIdCollection} |
'no_response' |
'no_request' when
Message :: term(),
RequestIdCollection :: request_id_collection(),
Delete :: boolean(),
Result :: term(),
Label :: term(),
NewRequestIdCollection :: request_id_collection().
check_response(_Msg, ReqIdCol, Del) when map_size(ReqIdCol) == 0,
is_boolean(Del) ->
no_request;
check_response({spawn_reply, ReqId, error, Reason},
ReqIdCol, Del) when is_reference(ReqId),
is_map_key(ReqId, ReqIdCol),
is_boolean(Del) ->
collection_result(spawn_reply, ReqId, Reason, ReqIdCol, true, Del);
check_response({'DOWN', ReqId, process, _Pid, Reason},
ReqIdCol, Del) when is_reference(ReqId),
is_map_key(ReqId, ReqIdCol),
is_boolean(Del) ->
collection_result(down, ReqId, Reason, ReqIdCol, true, Del);
check_response(_Msg, ReqIdCol, Del) when is_map(ReqIdCol),
is_boolean(Del) ->
no_response;
check_response(_, _, _) ->
error({?MODULE, badarg}).
-doc """
Returns a new empty request identifier collection. A request identifier
collection can be utilized in order the handle multiple outstanding requests.
Request identifiers of requests made by `send_request/4` can be saved in a
request identifier collection using `reqids_add/3`. Such a collection of request
identifiers can later be used in order to get one response corresponding to a
request in the collection by passing the collection as argument to
`check_response/3`, `receive_response/3`, and `wait_response/3`.
`reqids_size/1` can be used to determine the amount of request identifiers in a
request identifier collection.
""".
-doc(#{since => <<"OTP 25.0">>}).
-spec reqids_new() ->
NewRequestIdCollection::request_id_collection().
reqids_new() ->
maps:new().
-doc "Returns the amount of request identifiers saved in `RequestIdCollection`.".
-doc(#{since => <<"OTP 25.0">>}).
-spec reqids_size(RequestIdCollection::request_id_collection()) ->
non_neg_integer().
reqids_size(ReqIdCollection) ->
try
maps:size(ReqIdCollection)
catch
_:_ ->
error({?MODULE, badarg})
end.
-dialyzer({no_improper_lists, reqids_add/3}).
-doc """
Saves `RequestId` and associates a `Label` with the request identifier by adding
this information to `RequestIdCollection` and returning the resulting request
identifier collection.
""".
-doc(#{since => <<"OTP 25.0">>}).
-spec reqids_add(RequestId::request_id(), Label::term(),
RequestIdCollection::request_id_collection()) ->
NewRequestIdCollection::request_id_collection().
reqids_add([_|ReqId], _, ReqIdCollection) when is_reference(ReqId),
is_map_key(ReqId,
ReqIdCollection) ->
error({?MODULE, badarg});
reqids_add([Res|ReqId], Label, ReqIdCollection) when is_reference(Res),
is_reference(ReqId),
is_map(ReqIdCollection) ->
maps:put(ReqId, [Res|Label], ReqIdCollection);
reqids_add(_, _, _) ->
error({?MODULE, badarg}).
-dialyzer({no_improper_lists, reqids_to_list/1}).
-doc """
Returns a list of `{RequestId, Label}` tuples which corresponds to all request
identifiers with their associated labels present in the `RequestIdCollection`
collection.
""".
-doc(#{since => <<"OTP 25.0">>}).
-spec reqids_to_list(RequestIdCollection::request_id_collection()) ->
[{RequestId::request_id(), Label::term()}].
reqids_to_list(ReqIdCollection) when is_map(ReqIdCollection) ->
try
maps:fold(fun (ReqId, [Res|Label], Acc) when is_reference(ReqId),
is_reference(Res) ->
[{[Res|ReqId], Label}|Acc];
(_, _, _) ->
throw(badarg)
end,
[],
ReqIdCollection)
catch
throw:badarg ->
error({?MODULE, badarg})
end;
reqids_to_list(_) ->
error({?MODULE, badarg}).
-type stack_item() ::
{Module :: atom(),
Function :: atom(),
Arity :: arity() | (Args :: [term()]),
Location :: [{file, Filename :: string()} |
{line, Line :: pos_integer()}]}.
-type caught_call_exception() ::
{throw, Throw :: term()}
| {exit, {exception, Reason :: term()}}
| {error, {exception, Reason :: term(), StackTrace :: [stack_item()]}}
| {exit, {signal, Reason :: term()}}
| {error, {?MODULE, Reason :: term()}}.
-doc(#{equiv => multicall(Nodes, Fun, infinity)}).
-doc(#{since => <<"OTP 23.0">>}).
-spec multicall(Nodes, Fun) -> Result when
Nodes :: [atom()],
Fun :: function(),
Result :: term().