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
|
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">
<erlref>
<header>
<copyright>
<year>2010</year><year>2012</year>
<holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>
<legalnotice>
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.
</legalnotice>
<title>ct_rpc</title>
<prepared></prepared>
<responsible></responsible>
<docno></docno>
<approved></approved>
<checked></checked>
<date></date>
<rev>A</rev>
<file>ct_rpc.xml</file>
</header>
<module>ct_rpc</module>
<modulesummary>Common Test specific layer on Erlang/OTP rpc.</modulesummary>
<description>
<p><c>Common Test</c> specific layer on Erlang/OTP <c>rpc</c>.</p>
</description>
<funcs>
<func>
<name>app_node(App, Candidates) -> NodeName</name>
<fsummary>From a set of candidate nodes determines which of them is
running the application App.</fsummary>
<type>
<v>App = atom()</v>
<v>Candidates = [NodeName]</v>
<v>NodeName = atom()</v>
</type>
<desc><marker id="app_node-2"/>
<p>From a set of candidate nodes determines which of them is running
the application <c>App</c>. If none of the candidate nodes is
running <c>App</c>, the function makes the test case calling
this function to fail. This function is the same as calling
<c>app_node(App, Candidates, true)</c>.</p>
</desc>
</func>
<func>
<name>app_node(App, Candidates, FailOnBadRPC) -> NodeName</name>
<fsummary>Same as app_node/2, except that argument FailOnBadRPC
determines if the search for a candidate node is to stop if
badrpc is received at some point.</fsummary>
<type>
<v>App = atom()</v>
<v>Candidates = [NodeName]</v>
<v>NodeName = atom()</v>
<v>FailOnBadRPC = true | false</v>
</type>
<desc><marker id="app_node-3"/>
<p>Same as
<seealso marker="#app_node-2"><c>ct_rpc:app_node/2</c></seealso>,
except that argument <c>FailOnBadRPC</c> determines if the search
for a candidate node is to stop if <c>badrpc</c> is received at
some point.</p>
</desc>
</func>
<func>
<name>app_node(App, Candidates, FailOnBadRPC, Cookie) -> NodeName</name>
<fsummary>Same as app_node/2, except that argument FailOnBadRPC
determines if the search for a candidate node is to stop if badrpc is
received at some point.</fsummary>
<type>
<v>App = atom()</v>
<v>Candidates = [NodeName]</v>
<v>NodeName = atom()</v>
<v>FailOnBadRPC = true | false</v>
<v>Cookie = atom()</v>
</type>
<desc><marker id="app_node-4"/>
<p>Same as
<seealso marker="#app_node-2"><c>ct_rpc:app_node/2</c></seealso>,
except that argument <c>FailOnBadRPC</c> determines if the search
for a candidate node is to stop if <c>badrpc</c> is received at
some point.</p>
<p>The cookie on the client node is set to <c>Cookie</c> for this
<c>rpc</c> operation (used to match the server node cookie).</p>
</desc>
</func>
<func>
<name>call(Node, Module, Function, Args) -> term() | {badrpc, Reason}</name>
<fsummary>Same as call(Node, Module, Function, Args, infinity).</fsummary>
<desc><marker id="call-4"/>
<p>Same as <c>call(Node, Module, Function, Args, infinity)</c>.</p>
</desc>
</func>
<func>
<name>call(Node, Module, Function, Args, TimeOut) -> term() | {badrpc, Reason}</name>
<fsummary>Evaluates apply(Module, Function, Args) on the node
Node.</fsummary>
<type>
<v>Node = NodeName | {Fun, FunArgs}</v>
<v>Fun = function()</v>
<v>FunArgs = term()</v>
<v>NodeName = atom()</v>
<v>Module = atom()</v>
<v>Function = atom()</v>
<v>Args = [term()]</v>
<v>Reason = timeout | term()</v>
</type>
<desc><marker id="call-5"/>
<p>Evaluates <c>apply(Module, Function, Args)</c> on the node
<c>Node</c>. Returns either whatever <c>Function</c> returns, or
<c>{badrpc, Reason}</c> if the remote procedure call fails. If
<c>Node</c> is <c>{Fun, FunArgs}</c>, applying <c>Fun</c> to
<c>FunArgs</c> is to return a node name.</p>
</desc>
</func>
<func>
<name>call(Node, Module, Function, Args, TimeOut, Cookie) -> term() | {badrpc, Reason}</name>
<fsummary>Evaluates apply(Module, Function, Args) on the node
Node.</fsummary>
<type>
<v>Node = NodeName | {Fun, FunArgs}</v>
<v>Fun = function()</v>
<v>FunArgs = term()</v>
<v>NodeName = atom()</v>
<v>Module = atom()</v>
<v>Function = atom()</v>
<v>Args = [term()]</v>
<v>Reason = timeout | term()</v>
<v>Cookie = atom()</v>
</type>
<desc><marker id="call-6"/>
<p>Evaluates <c>apply(Module, Function, Args)</c> on the node
<c>Node</c>. Returns either whatever <c>Function</c> returns, or
<c>{badrpc, Reason}</c> if the remote procedure call fails. If
<c>Node</c> is <c>{Fun, FunArgs}</c>, applying <c>Fun</c> to
<c>FunArgs</c> is to return a node name.</p>
<p>The cookie on the client node is set to <c>Cookie</c> for this
<c>rpc</c> operation (used to match the server node cookie).</p>
</desc>
</func>
<func>
<name>cast(Node, Module, Function, Args) -> ok</name>
<fsummary>Evaluates apply(Module, Function, Args) on the node
Node.</fsummary>
<type>
<v>Node = NodeName | {Fun, FunArgs}</v>
<v>Fun = function()</v>
<v>FunArgs = term()</v>
<v>NodeName = atom()</v>
<v>Module = atom()</v>
<v>Function = atom()</v>
<v>Args = [term()]</v>
<v>Reason = timeout | term()</v>
</type>
<desc><marker id="cast-4"/>
<p>Evaluates <c>apply(Module, Function, Args)</c> on the node
<c>Node</c>. No response is delivered and the process that makes
the call is not suspended until the evaluation is completed as in
the case of <c>call/3,4</c>. If <c>Node</c> is
<c>{Fun, FunArgs}</c>, applying <c>Fun</c> to <c>FunArgs</c> is to
return a node name.</p>
</desc>
</func>
<func>
<name>cast(Node, Module, Function, Args, Cookie) -> ok</name>
<fsummary>Evaluates apply(Module, Function, Args) on the node
Node.</fsummary>
<type>
<v>Node = NodeName | {Fun, FunArgs}</v>
<v>Fun = function()</v>
<v>FunArgs = term()</v>
<v>NodeName = atom()</v>
<v>Module = atom()</v>
<v>Function = atom()</v>
<v>Args = [term()]</v>
<v>Reason = timeout | term()</v>
<v>Cookie = atom()</v>
</type>
<desc><marker id="cast-5"/>
<p>Evaluates <c>apply(Module, Function, Args)</c> on the node
<c>Node</c>. No response is delivered and the process that makes
the call is not suspended until the evaluation is completed as in
the case of <c>call/3,4</c>. If <c>Node</c> is
<c>{Fun, FunArgs}</c>, applying <c>Fun</c> to <c>FunArgs</c> is to
return a node name.</p>
<p>The cookie on the client node is set to <c>Cookie</c> for this
<c>rpc</c> operation (used to match the server node cookie).</p>
</desc>
</func>
</funcs>
</erlref>
|
