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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Raritan PX2/PX3 JSON-RPC API: cascading::CascadeManager Interface Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Raritan PX2/PX3 JSON-RPC API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacecascading.html">cascading</a></li><li class="navelem"><a class="el" href="interfacecascading_1_1CascadeManager.html">CascadeManager</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="interfacecascading_1_1CascadeManager-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">cascading::CascadeManager Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>JSON-RPC Cascade Manager.
<a href="interfacecascading_1_1CascadeManager.html#details">More...</a></p>
<p><code>import"<a class="el" href="CascadeManager_8idl_source.html">CascadeManager.idl</a>";</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structcascading_1_1CascadeManager_1_1LinkUnit.html">LinkUnit</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Link Unit <a class="el" href="structcascading_1_1CascadeManager_1_1Status.html" title="Full Cascading Status. ">Status</a>. <a href="structcascading_1_1CascadeManager_1_1LinkUnit.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structcascading_1_1CascadeManager_1_1Status.html">Status</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Full Cascading <a class="el" href="structcascading_1_1CascadeManager_1_1Status.html" title="Full Cascading Status. ">Status</a>. <a href="structcascading_1_1CascadeManager_1_1Status.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ac32f6dcd167f653202d2a9937b7cbb46"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecascading_1_1CascadeManager.html#ac32f6dcd167f653202d2a9937b7cbb46">Role</a> { <a class="el" href="interfacecascading_1_1CascadeManager.html#ac32f6dcd167f653202d2a9937b7cbb46aacbeaafcf583a7d9ce2bb19427a7c17e">STANDALONE</a>,
<a class="el" href="interfacecascading_1_1CascadeManager.html#ac32f6dcd167f653202d2a9937b7cbb46afe2e11ea4ccc4076751a988ff9047b96">MASTER</a>,
<a class="el" href="interfacecascading_1_1CascadeManager.html#ac32f6dcd167f653202d2a9937b7cbb46a94c8a3007c80a155a6b1b66ff2040ead">LINK_UNIT</a>
}</td></tr>
<tr class="memdesc:ac32f6dcd167f653202d2a9937b7cbb46"><td class="mdescLeft"> </td><td class="mdescRight">JSON-RPC Cascade Role. <a href="interfacecascading_1_1CascadeManager.html#ac32f6dcd167f653202d2a9937b7cbb46">More...</a><br /></td></tr>
<tr class="separator:ac32f6dcd167f653202d2a9937b7cbb46"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae63b7b53cff90c05985942029e386933"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecascading_1_1CascadeManager.html#ae63b7b53cff90c05985942029e386933">LinkUnitStatus</a> { <br />
  <a class="el" href="interfacecascading_1_1CascadeManager.html#ae63b7b53cff90c05985942029e386933a7c174ba7608996f9df405eeef4d68127">UNKNOWN</a>,
<a class="el" href="interfacecascading_1_1CascadeManager.html#ae63b7b53cff90c05985942029e386933a52441218bc3c8d4ff2346a2597d59cdf">OK</a>,
<a class="el" href="interfacecascading_1_1CascadeManager.html#ae63b7b53cff90c05985942029e386933a7e4a954fb63791f13e228ca5c124dc13">UNREACHABLE</a>,
<a class="el" href="interfacecascading_1_1CascadeManager.html#ae63b7b53cff90c05985942029e386933a41b2ba98a825e9dd7f522ce59634a944">ACCESS_DENIED</a>,
<br />
  <a class="el" href="interfacecascading_1_1CascadeManager.html#ae63b7b53cff90c05985942029e386933a1b2ba8c3150a3c98456640569b542f42">FIRMWARE_UPDATE</a>
<br />
}</td></tr>
<tr class="memdesc:ae63b7b53cff90c05985942029e386933"><td class="mdescLeft"> </td><td class="mdescRight">Link Unit Communication <a class="el" href="structcascading_1_1CascadeManager_1_1Status.html" title="Full Cascading Status. ">Status</a>. <a href="interfacecascading_1_1CascadeManager.html#ae63b7b53cff90c05985942029e386933">More...</a><br /></td></tr>
<tr class="separator:ae63b7b53cff90c05985942029e386933"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a2b8c3adeeaf33c933d244e50cbb10918"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcascading_1_1CascadeManager_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecascading_1_1CascadeManager.html#a2b8c3adeeaf33c933d244e50cbb10918">getStatus</a> ()</td></tr>
<tr class="memdesc:a2b8c3adeeaf33c933d244e50cbb10918"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the full cascading status for this unit. <a href="#a2b8c3adeeaf33c933d244e50cbb10918">More...</a><br /></td></tr>
<tr class="separator:a2b8c3adeeaf33c933d244e50cbb10918"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a468c511e73feb9cded9d4e65b453d669"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecascading_1_1CascadeManager.html#a468c511e73feb9cded9d4e65b453d669">addLinkUnit</a> (in int linkId, in string <a class="el" href="interfacecascading_1_1CascadeManager.html#ae252069b1bcca22aee7af286ffd6647d">host</a>, in string login, in string password, in string newPassword)</td></tr>
<tr class="memdesc:a468c511e73feb9cded9d4e65b453d669"><td class="mdescLeft"> </td><td class="mdescRight">Put a new link unit under this master's control. <a href="#a468c511e73feb9cded9d4e65b453d669">More...</a><br /></td></tr>
<tr class="separator:a468c511e73feb9cded9d4e65b453d669"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afa23d8d883b8c264f300e035cfe425e0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecascading_1_1CascadeManager.html#afa23d8d883b8c264f300e035cfe425e0">releaseLinkUnit</a> (in int linkId)</td></tr>
<tr class="memdesc:afa23d8d883b8c264f300e035cfe425e0"><td class="mdescLeft"> </td><td class="mdescRight">Release a link unit from this master's control. <a href="#afa23d8d883b8c264f300e035cfe425e0">More...</a><br /></td></tr>
<tr class="separator:afa23d8d883b8c264f300e035cfe425e0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a716fd2c9104279995ca820cb4b6aba41"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecascading_1_1CascadeManager.html#a716fd2c9104279995ca820cb4b6aba41">requestLink</a> (in string token)</td></tr>
<tr class="memdesc:a716fd2c9104279995ca820cb4b6aba41"><td class="mdescLeft"> </td><td class="mdescRight">Request to make this unit a link unit and put it under the remote master's control. <a href="#a716fd2c9104279995ca820cb4b6aba41">More...</a><br /></td></tr>
<tr class="separator:a716fd2c9104279995ca820cb4b6aba41"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acb8e67f7c0d69eaa32b3909db7aadce4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecascading_1_1CascadeManager.html#acb8e67f7c0d69eaa32b3909db7aadce4">finalizeLink</a> (in string token)</td></tr>
<tr class="memdesc:acb8e67f7c0d69eaa32b3909db7aadce4"><td class="mdescLeft"> </td><td class="mdescRight">Finalize the link with this link unit. <a href="#acb8e67f7c0d69eaa32b3909db7aadce4">More...</a><br /></td></tr>
<tr class="separator:acb8e67f7c0d69eaa32b3909db7aadce4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae575117db1a1a2aea3d2b5d26db1542a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecascading_1_1CascadeManager.html#ae575117db1a1a2aea3d2b5d26db1542a">unlink</a> ()</td></tr>
<tr class="memdesc:ae575117db1a1a2aea3d2b5d26db1542a"><td class="mdescLeft"> </td><td class="mdescRight">Release this link unit from the remote master's control. <a href="#ae575117db1a1a2aea3d2b5d26db1542a">More...</a><br /></td></tr>
<tr class="separator:ae575117db1a1a2aea3d2b5d26db1542a"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a823cdd8c6b3df03d5249a1939f714455"><td class="memItemLeft" align="right" valign="top"><a id="a823cdd8c6b3df03d5249a1939f714455"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecascading_1_1CascadeManager.html#a823cdd8c6b3df03d5249a1939f714455">NO_ERROR</a> = 0</td></tr>
<tr class="memdesc:a823cdd8c6b3df03d5249a1939f714455"><td class="mdescLeft"> </td><td class="mdescRight">Operation successful, no error. <br /></td></tr>
<tr class="separator:a823cdd8c6b3df03d5249a1939f714455"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1a36ca845ad66e3fb1f2e3eaa323c764"><td class="memItemLeft" align="right" valign="top"><a id="a1a36ca845ad66e3fb1f2e3eaa323c764"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecascading_1_1CascadeManager.html#a1a36ca845ad66e3fb1f2e3eaa323c764">ERR_INVALID_PARAM</a> = 1</td></tr>
<tr class="memdesc:a1a36ca845ad66e3fb1f2e3eaa323c764"><td class="mdescLeft"> </td><td class="mdescRight">A parameter was invalid. <br /></td></tr>
<tr class="separator:a1a36ca845ad66e3fb1f2e3eaa323c764"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a55b32da08e81aaa513628cdccb32bbdc"><td class="memItemLeft" align="right" valign="top"><a id="a55b32da08e81aaa513628cdccb32bbdc"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecascading_1_1CascadeManager.html#a55b32da08e81aaa513628cdccb32bbdc">ERR_UNSUPPORTED_ON_MASTER</a> = 2</td></tr>
<tr class="memdesc:a55b32da08e81aaa513628cdccb32bbdc"><td class="mdescLeft"> </td><td class="mdescRight">Operation not allowed for a master unit. <br /></td></tr>
<tr class="separator:a55b32da08e81aaa513628cdccb32bbdc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9f59a729637207e49b5eb00740f3677c"><td class="memItemLeft" align="right" valign="top"><a id="a9f59a729637207e49b5eb00740f3677c"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecascading_1_1CascadeManager.html#a9f59a729637207e49b5eb00740f3677c">ERR_UNSUPPORTED_ON_LINK_UNIT</a> = 3</td></tr>
<tr class="memdesc:a9f59a729637207e49b5eb00740f3677c"><td class="mdescLeft"> </td><td class="mdescRight">Operation not allowed for a link unit. <br /></td></tr>
<tr class="separator:a9f59a729637207e49b5eb00740f3677c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a795aa112a7ff55a6d7abb539dd124814"><td class="memItemLeft" align="right" valign="top"><a id="a795aa112a7ff55a6d7abb539dd124814"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecascading_1_1CascadeManager.html#a795aa112a7ff55a6d7abb539dd124814">ERR_LINK_ID_IN_USE</a> = 4</td></tr>
<tr class="memdesc:a795aa112a7ff55a6d7abb539dd124814"><td class="mdescLeft"> </td><td class="mdescRight">The specified link ID is already used. <br /></td></tr>
<tr class="separator:a795aa112a7ff55a6d7abb539dd124814"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a003e67ecd55126b22d12969eed2cd450"><td class="memItemLeft" align="right" valign="top"><a id="a003e67ecd55126b22d12969eed2cd450"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecascading_1_1CascadeManager.html#a003e67ecd55126b22d12969eed2cd450">ERR_HOST_IN_USE</a> = 5</td></tr>
<tr class="memdesc:a003e67ecd55126b22d12969eed2cd450"><td class="mdescLeft"> </td><td class="mdescRight">The specified host is already in use. <br /></td></tr>
<tr class="separator:a003e67ecd55126b22d12969eed2cd450"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0e72d8460e23142a2a5f3411cb652f1a"><td class="memItemLeft" align="right" valign="top"><a id="a0e72d8460e23142a2a5f3411cb652f1a"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecascading_1_1CascadeManager.html#a0e72d8460e23142a2a5f3411cb652f1a">ERR_LINK_UNIT_UNREACHABLE</a> = 6</td></tr>
<tr class="memdesc:a0e72d8460e23142a2a5f3411cb652f1a"><td class="mdescLeft"> </td><td class="mdescRight">Could not connect to the link device. <br /></td></tr>
<tr class="separator:a0e72d8460e23142a2a5f3411cb652f1a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a60c505b2c6fa940b3955680879121ae9"><td class="memItemLeft" align="right" valign="top"><a id="a60c505b2c6fa940b3955680879121ae9"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecascading_1_1CascadeManager.html#a60c505b2c6fa940b3955680879121ae9">ERR_LINK_UNIT_ACCESS_DENIED</a> = 7</td></tr>
<tr class="memdesc:a60c505b2c6fa940b3955680879121ae9"><td class="mdescLeft"> </td><td class="mdescRight">Login to link device failed. <br /></td></tr>
<tr class="separator:a60c505b2c6fa940b3955680879121ae9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0c5e00f3b22305cf4c57dddab54a065b"><td class="memItemLeft" align="right" valign="top"><a id="a0c5e00f3b22305cf4c57dddab54a065b"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecascading_1_1CascadeManager.html#a0c5e00f3b22305cf4c57dddab54a065b">ERR_LINK_UNIT_REFUSED</a> = 8</td></tr>
<tr class="memdesc:a0c5e00f3b22305cf4c57dddab54a065b"><td class="mdescLeft"> </td><td class="mdescRight">Remote device refused to become a link unit. <br /></td></tr>
<tr class="separator:a0c5e00f3b22305cf4c57dddab54a065b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abf3fb941bb6502321c88779da8b529a0"><td class="memItemLeft" align="right" valign="top"><a id="abf3fb941bb6502321c88779da8b529a0"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecascading_1_1CascadeManager.html#abf3fb941bb6502321c88779da8b529a0">ERR_UNIT_BUSY</a> = 9</td></tr>
<tr class="memdesc:abf3fb941bb6502321c88779da8b529a0"><td class="mdescLeft"> </td><td class="mdescRight">The unit could not respond because it was busy. <br /></td></tr>
<tr class="separator:abf3fb941bb6502321c88779da8b529a0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad28f33625e4ff122ac777e4dc7cdba3d"><td class="memItemLeft" align="right" valign="top"><a id="ad28f33625e4ff122ac777e4dc7cdba3d"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecascading_1_1CascadeManager.html#ad28f33625e4ff122ac777e4dc7cdba3d">ERR_NOT_SUPPORTED</a> = 10</td></tr>
<tr class="memdesc:ad28f33625e4ff122ac777e4dc7cdba3d"><td class="mdescLeft"> </td><td class="mdescRight">Operation not supported on this device. <br /></td></tr>
<tr class="separator:ad28f33625e4ff122ac777e4dc7cdba3d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af5edc37c772b56d40a559b6b45efa1d4"><td class="memItemLeft" align="right" valign="top"><a id="af5edc37c772b56d40a559b6b45efa1d4"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecascading_1_1CascadeManager.html#af5edc37c772b56d40a559b6b45efa1d4">ERR_PASSWORD_CHANGE_REQUIRED</a> = 11</td></tr>
<tr class="memdesc:af5edc37c772b56d40a559b6b45efa1d4"><td class="mdescLeft"> </td><td class="mdescRight">The unit requires a password change. <br /></td></tr>
<tr class="separator:af5edc37c772b56d40a559b6b45efa1d4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad17b0a4f35361d003f1c854b3115e2a3"><td class="memItemLeft" align="right" valign="top"><a id="ad17b0a4f35361d003f1c854b3115e2a3"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecascading_1_1CascadeManager.html#ad17b0a4f35361d003f1c854b3115e2a3">ERR_PASSWORD_POLICY</a> = 12</td></tr>
<tr class="memdesc:ad17b0a4f35361d003f1c854b3115e2a3"><td class="mdescLeft"> </td><td class="mdescRight">The given password did not meet the requirements. <br /></td></tr>
<tr class="separator:ad17b0a4f35361d003f1c854b3115e2a3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae9eb723e24f7c1b48f873cb193ca3d10"><td class="memItemLeft" align="right" valign="top">valueobject </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecascading_1_1CascadeManager.html#ae9eb723e24f7c1b48f873cb193ca3d10">RoleChangedEvent</a>: <a class="el" href="namespaceidl.html#accbdf35b0c02d64ce223e912fc2b246f">idl::Event</a> { <a class="el" href="interfacecascading_1_1CascadeManager.html#ac32f6dcd167f653202d2a9937b7cbb46">Role</a> oldRole</td></tr>
<tr class="memdesc:ae9eb723e24f7c1b48f873cb193ca3d10"><td class="mdescLeft"> </td><td class="mdescRight">Event: This unit's role in the cascade has changed. <a href="#ae9eb723e24f7c1b48f873cb193ca3d10">More...</a><br /></td></tr>
<tr class="separator:ae9eb723e24f7c1b48f873cb193ca3d10"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa3efbaf5b35ce40ea5fe48e7f40f2e1a"><td class="memItemLeft" align="right" valign="top"><a id="aa3efbaf5b35ce40ea5fe48e7f40f2e1a"></a>
<a class="el" href="interfacecascading_1_1CascadeManager.html#ac32f6dcd167f653202d2a9937b7cbb46">Role</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecascading_1_1CascadeManager.html#aa3efbaf5b35ce40ea5fe48e7f40f2e1a">newRole</a></td></tr>
<tr class="memdesc:aa3efbaf5b35ce40ea5fe48e7f40f2e1a"><td class="mdescLeft"> </td><td class="mdescRight">New role after the change. <br /></td></tr>
<tr class="separator:aa3efbaf5b35ce40ea5fe48e7f40f2e1a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4f927b36151b6536dcf04d675c822ed5"><td class="memItemLeft" align="right" valign="top"><a id="a4f927b36151b6536dcf04d675c822ed5"></a>
string </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecascading_1_1CascadeManager.html#a4f927b36151b6536dcf04d675c822ed5">master</a></td></tr>
<tr class="memdesc:a4f927b36151b6536dcf04d675c822ed5"><td class="mdescLeft"> </td><td class="mdescRight">Master IP address (if new role is link unit) <br /></td></tr>
<tr class="separator:a4f927b36151b6536dcf04d675c822ed5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9be07994177986374515642b923b51ca"><td class="memItemLeft" align="right" valign="top">valueobject </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecascading_1_1CascadeManager.html#a9be07994177986374515642b923b51ca">LinkUnitAddedEvent</a>: <a class="el" href="namespaceevent.html#a2c124cd89f703231aa6031d409472a3e">event::UserEvent</a> { int linkId</td></tr>
<tr class="memdesc:a9be07994177986374515642b923b51ca"><td class="mdescLeft"> </td><td class="mdescRight">Event: A new link unit has been added. <a href="#a9be07994177986374515642b923b51ca">More...</a><br /></td></tr>
<tr class="separator:a9be07994177986374515642b923b51ca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae252069b1bcca22aee7af286ffd6647d"><td class="memItemLeft" align="right" valign="top"><a id="ae252069b1bcca22aee7af286ffd6647d"></a>
string </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecascading_1_1CascadeManager.html#ae252069b1bcca22aee7af286ffd6647d">host</a></td></tr>
<tr class="memdesc:ae252069b1bcca22aee7af286ffd6647d"><td class="mdescLeft"> </td><td class="mdescRight">Host name or IP address. <br /></td></tr>
<tr class="separator:ae252069b1bcca22aee7af286ffd6647d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac12f0cea76778efe514c02b846c69360"><td class="memItemLeft" align="right" valign="top">valueobject </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecascading_1_1CascadeManager.html#ac12f0cea76778efe514c02b846c69360">LinkUnitReleasedEvent</a>: <a class="el" href="namespaceevent.html#a2c124cd89f703231aa6031d409472a3e">event::UserEvent</a> { int linkId</td></tr>
<tr class="memdesc:ac12f0cea76778efe514c02b846c69360"><td class="mdescLeft"> </td><td class="mdescRight">Event: A link unit has been released. <a href="#ac12f0cea76778efe514c02b846c69360">More...</a><br /></td></tr>
<tr class="separator:ac12f0cea76778efe514c02b846c69360"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7e2e3122164052c609591a9b1cc4eaf8"><td class="memItemLeft" align="right" valign="top">valueobject </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecascading_1_1CascadeManager.html#a7e2e3122164052c609591a9b1cc4eaf8">LinkUnitStatusChangedEvent</a>: <a class="el" href="namespaceidl.html#accbdf35b0c02d64ce223e912fc2b246f">idl::Event</a> { int linkId</td></tr>
<tr class="memdesc:a7e2e3122164052c609591a9b1cc4eaf8"><td class="mdescLeft"> </td><td class="mdescRight">Event: A link unit's communication status has changed. <a href="#a7e2e3122164052c609591a9b1cc4eaf8">More...</a><br /></td></tr>
<tr class="separator:a7e2e3122164052c609591a9b1cc4eaf8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad7b2bca0a3f296293119d951bc008a67"><td class="memItemLeft" align="right" valign="top"><a id="ad7b2bca0a3f296293119d951bc008a67"></a>
<a class="el" href="interfacecascading_1_1CascadeManager.html#ae63b7b53cff90c05985942029e386933">LinkUnitStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecascading_1_1CascadeManager.html#ad7b2bca0a3f296293119d951bc008a67">oldStatus</a></td></tr>
<tr class="memdesc:ad7b2bca0a3f296293119d951bc008a67"><td class="mdescLeft"> </td><td class="mdescRight">Previous communication status. <br /></td></tr>
<tr class="separator:ad7b2bca0a3f296293119d951bc008a67"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a25d83a0143be00415913f4b52e2ffb36"><td class="memItemLeft" align="right" valign="top"><a id="a25d83a0143be00415913f4b52e2ffb36"></a>
<a class="el" href="interfacecascading_1_1CascadeManager.html#ae63b7b53cff90c05985942029e386933">LinkUnitStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecascading_1_1CascadeManager.html#a25d83a0143be00415913f4b52e2ffb36">newStatus</a></td></tr>
<tr class="memdesc:a25d83a0143be00415913f4b52e2ffb36"><td class="mdescLeft"> </td><td class="mdescRight">New communication status. <br /></td></tr>
<tr class="separator:a25d83a0143be00415913f4b52e2ffb36"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>JSON-RPC Cascade Manager. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="ae63b7b53cff90c05985942029e386933"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae63b7b53cff90c05985942029e386933">◆ </a></span>LinkUnitStatus</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="interfacecascading_1_1CascadeManager.html#ae63b7b53cff90c05985942029e386933">cascading::CascadeManager::LinkUnitStatus</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Link Unit Communication <a class="el" href="structcascading_1_1CascadeManager_1_1Status.html" title="Full Cascading Status. ">Status</a>. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ae63b7b53cff90c05985942029e386933a7c174ba7608996f9df405eeef4d68127"></a>UNKNOWN </td><td class="fielddoc"><p>The status of the link unit is unknown. </p>
</td></tr>
<tr><td class="fieldname"><a id="ae63b7b53cff90c05985942029e386933a52441218bc3c8d4ff2346a2597d59cdf"></a>OK </td><td class="fielddoc"><p>The link unit operates normally. </p>
</td></tr>
<tr><td class="fieldname"><a id="ae63b7b53cff90c05985942029e386933a7e4a954fb63791f13e228ca5c124dc13"></a>UNREACHABLE </td><td class="fielddoc"><p>The link unit is unreachable. </p>
</td></tr>
<tr><td class="fieldname"><a id="ae63b7b53cff90c05985942029e386933a41b2ba98a825e9dd7f522ce59634a944"></a>ACCESS_DENIED </td><td class="fielddoc"><p>The link unit denies access. </p>
</td></tr>
<tr><td class="fieldname"><a id="ae63b7b53cff90c05985942029e386933a1b2ba8c3150a3c98456640569b542f42"></a>FIRMWARE_UPDATE </td><td class="fielddoc"><p>Ths link unit is performing a firmware update. </p>
</td></tr>
</table>
</div>
</div>
<a id="ac32f6dcd167f653202d2a9937b7cbb46"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac32f6dcd167f653202d2a9937b7cbb46">◆ </a></span>Role</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="interfacecascading_1_1CascadeManager.html#ac32f6dcd167f653202d2a9937b7cbb46">cascading::CascadeManager::Role</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>JSON-RPC Cascade Role. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ac32f6dcd167f653202d2a9937b7cbb46aacbeaafcf583a7d9ce2bb19427a7c17e"></a>STANDALONE </td><td class="fielddoc"><p>Standalone unit, not in cascade. </p>
</td></tr>
<tr><td class="fieldname"><a id="ac32f6dcd167f653202d2a9937b7cbb46afe2e11ea4ccc4076751a988ff9047b96"></a>MASTER </td><td class="fielddoc"><p>Master unit controlling other devices. </p>
</td></tr>
<tr><td class="fieldname"><a id="ac32f6dcd167f653202d2a9937b7cbb46a94c8a3007c80a155a6b1b66ff2040ead"></a>LINK_UNIT </td><td class="fielddoc"><p>link unit under master control </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a468c511e73feb9cded9d4e65b453d669"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a468c511e73feb9cded9d4e65b453d669">◆ </a></span>addLinkUnit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int cascading::CascadeManager::addLinkUnit </td>
<td>(</td>
<td class="paramtype">in int </td>
<td class="paramname"><em>linkId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in string </td>
<td class="paramname"><em>host</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in string </td>
<td class="paramname"><em>login</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in string </td>
<td class="paramname"><em>password</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in string </td>
<td class="paramname"><em>newPassword</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Put a new link unit under this master's control. </p>
<p>The login credentials must have administrator privileges on the link unit. They are only used to establish a trust relationship between master and link unit and not stored.</p>
<p>This method can also be used to re-authenticate a link unit that denies access. In that case the linkId and host parameter must exactly match the existing values.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">linkId</td><td>The ID for the new link unit </td></tr>
<tr><td class="paramname">host</td><td>The link unit's host name or IP address </td></tr>
<tr><td class="paramname">login</td><td>The administrator login for the link unit </td></tr>
<tr><td class="paramname">password</td><td>The administrator password for the link unit </td></tr>
<tr><td class="paramname">newPassword</td><td>The new administrator password for the unit. This is needed for adding a link unit that still has default settings and requires a password change. Otherwise it can be left empty.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>NO_ERROR The operation was successful </dd>
<dd>
ERR_INVALID_PARAM One of the parameters had an invalid value </dd>
<dd>
ERR_UNSUPPORTED_ON_LINK_UNIT This unit is currently a link unit and can't have link units of its own </dd>
<dd>
ERR_LINK_ID_IN_USE The specified link ID is already in use </dd>
<dd>
ERR_HOST_IN_USE The specified host is already in use </dd>
<dd>
ERR_LINK_UNIT_UNREACHABLE Connection to the link unit failed </dd>
<dd>
ERR_LINK_UNIT_ACCESS_DENIED The credentials for the link unit were invalid </dd>
<dd>
ERR_LINK_UNIT_REFUSED The remote unit refused to become our link unit, e.g. because it's a master itself </dd>
<dd>
ERR_UNIT_BUSY This unit is currently busy with handling another request </dd>
<dd>
ERR_NOT_SUPPORTED This device does not support PDU linking </dd>
<dd>
ERR_PASSWORD_CHANGE_REQUIRED The specified link unit requires a password change </dd>
<dd>
ERR_PASSWORD_POLICY The new password did not meet the requirements </dd></dl>
</div>
</div>
<a id="acb8e67f7c0d69eaa32b3909db7aadce4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acb8e67f7c0d69eaa32b3909db7aadce4">◆ </a></span>finalizeLink()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cascading::CascadeManager::finalizeLink </td>
<td>(</td>
<td class="paramtype">in string </td>
<td class="paramname"><em>token</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Finalize the link with this link unit. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">token</td><td>same authorization token as used for <a class="el" href="interfacecascading_1_1CascadeManager.html#a716fd2c9104279995ca820cb4b6aba41" title="Request to make this unit a link unit and put it under the remote master's control. ">requestLink()</a></td></tr>
</table>
</dd>
</dl>
<p>This method should only be called by the master unit in order to acknowledge the establishment of the link to the link unit and finalize the link build-up. The linking will only take effect once the link unit received this acknowledgement.</p>
<p>If this method fails, you will get the ACCESS_DENIED status for this link unit and you will have to re-authenticate it. </p>
</div>
</div>
<a id="a2b8c3adeeaf33c933d244e50cbb10918"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b8c3adeeaf33c933d244e50cbb10918">◆ </a></span>getStatus()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structcascading_1_1CascadeManager_1_1Status.html">Status</a> cascading::CascadeManager::getStatus </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the full cascading status for this unit. </p>
<dl class="section return"><dt>Returns</dt><dd>Full cascading status </dd></dl>
</div>
</div>
<a id="afa23d8d883b8c264f300e035cfe425e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afa23d8d883b8c264f300e035cfe425e0">◆ </a></span>releaseLinkUnit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int cascading::CascadeManager::releaseLinkUnit </td>
<td>(</td>
<td class="paramtype">in int </td>
<td class="paramname"><em>linkId</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Release a link unit from this master's control. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">linkId</td><td>The ID of the link unit</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>NO_ERROR The operation was successful </dd>
<dd>
ERR_INVALID_PARAM The specified link ID is invalid </dd></dl>
</div>
</div>
<a id="a716fd2c9104279995ca820cb4b6aba41"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a716fd2c9104279995ca820cb4b6aba41">◆ </a></span>requestLink()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int cascading::CascadeManager::requestLink </td>
<td>(</td>
<td class="paramtype">in string </td>
<td class="paramname"><em>token</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Request to make this unit a link unit and put it under the remote master's control. </p>
<p>This method is usually called by the master unit when adding a new link unit. The link will only be established once <a class="el" href="interfacecascading_1_1CascadeManager.html#acb8e67f7c0d69eaa32b3909db7aadce4" title="Finalize the link with this link unit. ">finalizeLink()</a> is successfully called.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">token</td><td>Authorization token for future requests</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>NO_ERROR The operation was successful </dd>
<dd>
ERR_UNSUPPORTED_ON_MASTER This unit is a master and can't become a link unit </dd>
<dd>
ERR_NOT_SUPPORTED This device does not support PDU linking </dd></dl>
</div>
</div>
<a id="ae575117db1a1a2aea3d2b5d26db1542a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae575117db1a1a2aea3d2b5d26db1542a">◆ </a></span>unlink()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cascading::CascadeManager::unlink </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Release this link unit from the remote master's control. </p>
<p>This method is usually called by the master unit when releasing a link unit. This unit will become a standalone unit. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a9be07994177986374515642b923b51ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9be07994177986374515642b923b51ca">◆ </a></span>LinkUnitAddedEvent</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">valueobject cascading::CascadeManager::LinkUnitAddedEvent</td>
</tr>
</table>
</div><div class="memdoc">
<p>Event: A new link unit has been added. </p>
<p>Link ID </p>
</div>
</div>
<a id="ac12f0cea76778efe514c02b846c69360"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac12f0cea76778efe514c02b846c69360">◆ </a></span>LinkUnitReleasedEvent</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">valueobject cascading::CascadeManager::LinkUnitReleasedEvent</td>
</tr>
</table>
</div><div class="memdoc">
<p>Event: A link unit has been released. </p>
<p>Link ID </p>
</div>
</div>
<a id="a7e2e3122164052c609591a9b1cc4eaf8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7e2e3122164052c609591a9b1cc4eaf8">◆ </a></span>LinkUnitStatusChangedEvent</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">valueobject cascading::CascadeManager::LinkUnitStatusChangedEvent</td>
</tr>
</table>
</div><div class="memdoc">
<p>Event: A link unit's communication status has changed. </p>
<p>Link ID </p>
</div>
</div>
<a id="ae9eb723e24f7c1b48f873cb193ca3d10"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae9eb723e24f7c1b48f873cb193ca3d10">◆ </a></span>RoleChangedEvent</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">valueobject cascading::CascadeManager::RoleChangedEvent</td>
</tr>
</table>
</div><div class="memdoc">
<p>Event: This unit's role in the cascade has changed. </p>
<p>Previous role before the change </p>
</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>pdu-json-rpc-api/idl/<a class="el" href="CascadeManager_8idl_source.html">CascadeManager.idl</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Aug 21 2020 10:20:37 for Raritan PX2/PX3 JSON-RPC API by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
|
