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
|
.TH ct_rpc 3 "common_test 1.3.2" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
ct_rpc \- Common Test specific layer on Erlang/OTP rpc\&.
.SH DESCRIPTION
.LP
Common Test specific layer on Erlang/OTP rpc\&.
.SH EXPORTS
.LP
.B
app_node(App, Candidates) -> NodeName
.br
.RS
.TP
Types
App = atom()
.br
Candidates = [NodeName]
.br
NodeName = atom()
.br
.RE
.RS
.LP
From a set of candidate nodes determines which of them is running the application App\&. If none of the candidate nodes is running the application the function will make the test case calling this function fail\&. This function is the same as calling \fIapp_node(App, Candidates, true)\fR\&.
.RE
.LP
.B
app_node(App, Candidates, FailOnBadRPC) -> NodeName
.br
.RS
.TP
Types
App = atom()
.br
Candidates = [NodeName]
.br
NodeName = atom()
.br
FailOnBadRPC = true | false
.br
.RE
.RS
.LP
Same as \fIapp_node/2\fR only the \fIFailOnBadRPC\fR argument will determine if the search for a candidate node should stop or not if \fIbadrpc\fR is received at some point\&.
.RE
.LP
.B
app_node(App, Candidates, FailOnBadRPC, Cookie) -> NodeName
.br
.RS
.TP
Types
App = atom()
.br
Candidates = [NodeName]
.br
NodeName = atom()
.br
FailOnBadRPC = true | false
.br
Cookie = atom()
.br
.RE
.RS
.LP
Same as \fIapp_node/2\fR only the \fIFailOnBadRPC\fR argument will determine if the search for a candidate node should stop or not if \fIbadrpc\fR is received at some point\&. The cookie on the client node will be set to \fICookie\fR for this rpc operation (use to match the server node cookie)\&.
.RE
.LP
.B
call(Node, Module, Function, Args) -> term() | {badrpc, Reason}
.br
.RS
.LP
Same as call(Node, Module, Function, Args, infinity)
.RE
.LP
.B
call(Node, Module, Function, Args, TimeOut) -> term() | {badrpc, Reason}
.br
.RS
.TP
Types
Node = NodeName | {Fun, FunArgs}
.br
Fun = fun()
.br
FunArgs = term()
.br
NodeName = atom()
.br
Module = atom()
.br
Function = atom()
.br
Args = [term()]
.br
Reason = timeout | term()
.br
.RE
.RS
.LP
Evaluates apply(Module, Function, Args) on the node Node\&. Returns whatever Function returns or {badrpc, Reason} if the remote procedure call fails\&. If Node is {Fun, FunArgs} applying Fun to FunArgs should return a node name\&.
.RE
.LP
.B
call(Node, Module, Function, Args, TimeOut, Cookie) -> term() | {badrpc, Reason}
.br
.RS
.TP
Types
Node = NodeName | {Fun, FunArgs}
.br
Fun = fun()
.br
FunArgs = term()
.br
NodeName = atom()
.br
Module = atom()
.br
Function = atom()
.br
Args = [term()]
.br
Reason = timeout | term()
.br
Cookie = atom()
.br
.RE
.RS
.LP
Evaluates apply(Module, Function, Args) on the node Node\&. Returns whatever Function returns or {badrpc, Reason} if the remote procedure call fails\&. If Node is {Fun, FunArgs} applying Fun to FunArgs should return a node name\&. The cookie on the client node will be set to \fICookie\fR for this rpc operation (use to match the server node cookie)\&.
.RE
.LP
.B
cast(Node, Module, Function, Args) -> ok
.br
.RS
.TP
Types
Node = NodeName | {Fun, FunArgs}
.br
Fun = fun()
.br
FunArgs = term()
.br
NodeName = atom()
.br
Module = atom()
.br
Function = atom()
.br
Args = [term()]
.br
Reason = timeout | term()
.br
.RE
.RS
.LP
Evaluates apply(Module, Function, Args) on the node Node\&. No response is delivered and the process which makes the call is not suspended until the evaluation is compleated as in the case of call/[3,4]\&. If Node is {Fun, FunArgs} applying Fun to FunArgs should return a node name\&.
.RE
.LP
.B
cast(Node, Module, Function, Args, Cookie) -> ok
.br
.RS
.TP
Types
Node = NodeName | {Fun, FunArgs}
.br
Fun = fun()
.br
FunArgs = term()
.br
NodeName = atom()
.br
Module = atom()
.br
Function = atom()
.br
Args = [term()]
.br
Reason = timeout | term()
.br
Cookie = atom()
.br
.RE
.RS
.LP
Evaluates apply(Module, Function, Args) on the node Node\&. No response is delivered and the process which makes the call is not suspended until the evaluation is compleated as in the case of call/[3,4]\&. If Node is {Fun, FunArgs} applying Fun to FunArgs should return a node name\&. The cookie on the client node will be set to \fICookie\fR for this rpc operation (use to match the server node cookie)\&.
.RE
|
