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
|
<!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: event::DataPushService_1_0_1 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="namespaceevent.html">event</a></li><li class="navelem"><a class="el" href="interfaceevent_1_1DataPushService__1__0__1.html">DataPushService_1_0_1</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="interfaceevent_1_1DataPushService__1__0__1-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">event::DataPushService_1_0_1 Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Data push service configuration interface.
<a href="interfaceevent_1_1DataPushService__1__0__1.html#details">More...</a></p>
<p><code>import"<a class="el" href="DataPushService_8idl_source.html">DataPushService.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="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html">EntrySettings</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Data Push Entry Settings. <a href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.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="structevent_1_1DataPushService__1__0__1_1_1EntryStatus.html">EntryStatus</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Data Push Entry Status. <a href="structevent_1_1DataPushService__1__0__1_1_1EntryStatus.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:ad48147fc26f071a1b4956f0cfe9c92ee"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1DataPushService__1__0__1.html#ad48147fc26f071a1b4956f0cfe9c92ee">EntryType</a> { <br />
  <a class="el" href="interfaceevent_1_1DataPushService__1__0__1.html#ad48147fc26f071a1b4956f0cfe9c92eea4ecbb64f371b906192b8bcc1d66112be">SENSORLIST</a>,
<a class="el" href="interfaceevent_1_1DataPushService__1__0__1.html#ad48147fc26f071a1b4956f0cfe9c92eeab46cdcd8a8bf4abfbb3c21d50d6d9a0d">SENSORLOG</a>,
<a class="el" href="interfaceevent_1_1DataPushService__1__0__1.html#ad48147fc26f071a1b4956f0cfe9c92eea2134ae13f40f31e3c7fd1b25c04faf41">AMSLIST</a>,
<a class="el" href="interfaceevent_1_1DataPushService__1__0__1.html#ad48147fc26f071a1b4956f0cfe9c92eea7278b5c1d8876b97ceb6cabe9f2f1434">AMSLOG</a>,
<br />
  <a class="el" href="interfaceevent_1_1DataPushService__1__0__1.html#ad48147fc26f071a1b4956f0cfe9c92eea391c328903a144cfd0a5e64a6353dd87">AUDITLOG</a>
<br />
}</td></tr>
<tr class="memdesc:ad48147fc26f071a1b4956f0cfe9c92ee"><td class="mdescLeft"> </td><td class="mdescRight">Data Push Entry Types. <a href="interfaceevent_1_1DataPushService__1__0__1.html#ad48147fc26f071a1b4956f0cfe9c92ee">More...</a><br /></td></tr>
<tr class="separator:ad48147fc26f071a1b4956f0cfe9c92ee"><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:a8b07f67909d9a4c51147dc90f6b9cfc9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1DataPushService__1__0__1.html#a8b07f67909d9a4c51147dc90f6b9cfc9">addEntry</a> (out int entryId, in <a class="el" href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html">EntrySettings</a> entrySettings)</td></tr>
<tr class="memdesc:a8b07f67909d9a4c51147dc90f6b9cfc9"><td class="mdescLeft"> </td><td class="mdescRight">Add a new entry. <a href="#a8b07f67909d9a4c51147dc90f6b9cfc9">More...</a><br /></td></tr>
<tr class="separator:a8b07f67909d9a4c51147dc90f6b9cfc9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8d020410a04373dac6399a575cd6950f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1DataPushService__1__0__1.html#a8d020410a04373dac6399a575cd6950f">modifyEntry</a> (in int entryId, in <a class="el" href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html">EntrySettings</a> entrySettings)</td></tr>
<tr class="memdesc:a8d020410a04373dac6399a575cd6950f"><td class="mdescLeft"> </td><td class="mdescRight">Modify an existing entry. <a href="#a8d020410a04373dac6399a575cd6950f">More...</a><br /></td></tr>
<tr class="separator:a8d020410a04373dac6399a575cd6950f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac4d91f85e8fbc84124636738b33d9ba5"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1DataPushService__1__0__1.html#ac4d91f85e8fbc84124636738b33d9ba5">deleteEntry</a> (in int entryId)</td></tr>
<tr class="memdesc:ac4d91f85e8fbc84124636738b33d9ba5"><td class="mdescLeft"> </td><td class="mdescRight">Delete an entry. <a href="#ac4d91f85e8fbc84124636738b33d9ba5">More...</a><br /></td></tr>
<tr class="separator:ac4d91f85e8fbc84124636738b33d9ba5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4a498d0acda37a09616900d88bb68926"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1DataPushService__1__0__1.html#a4a498d0acda37a09616900d88bb68926">getEntry</a> (out <a class="el" href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html">EntrySettings</a> entrySettings, in int entryId)</td></tr>
<tr class="memdesc:a4a498d0acda37a09616900d88bb68926"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve an entry. <a href="#a4a498d0acda37a09616900d88bb68926">More...</a><br /></td></tr>
<tr class="separator:a4a498d0acda37a09616900d88bb68926"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adb77660b88a62284f2ef7cd94ee41554"><td class="memItemLeft" align="right" valign="top">map< int, <a class="el" href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html">EntrySettings</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1DataPushService__1__0__1.html#adb77660b88a62284f2ef7cd94ee41554">listEntries</a> ()</td></tr>
<tr class="memdesc:adb77660b88a62284f2ef7cd94ee41554"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve a list of entries. <a href="#adb77660b88a62284f2ef7cd94ee41554">More...</a><br /></td></tr>
<tr class="separator:adb77660b88a62284f2ef7cd94ee41554"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab8ae5f0ec8695c3261603559c0de59f8"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1DataPushService__1__0__1.html#ab8ae5f0ec8695c3261603559c0de59f8">pushData</a> (in int entryId)</td></tr>
<tr class="memdesc:ab8ae5f0ec8695c3261603559c0de59f8"><td class="mdescLeft"> </td><td class="mdescRight">Push data for one specified entry. <a href="#ab8ae5f0ec8695c3261603559c0de59f8">More...</a><br /></td></tr>
<tr class="separator:ab8ae5f0ec8695c3261603559c0de59f8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a54abada83259f60e74973f0c94f9e278"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1DataPushService__1__0__1.html#a54abada83259f60e74973f0c94f9e278">getEntryStatus</a> (out <a class="el" href="structevent_1_1DataPushService__1__0__1_1_1EntryStatus.html">EntryStatus</a> entryStatus, in int entryId)</td></tr>
<tr class="memdesc:a54abada83259f60e74973f0c94f9e278"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve an entry's status. <a href="#a54abada83259f60e74973f0c94f9e278">More...</a><br /></td></tr>
<tr class="separator:a54abada83259f60e74973f0c94f9e278"><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:a57d3dcd8df8ac8e5a330e714761ab354"><td class="memItemLeft" align="right" valign="top">constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1DataPushService__1__0__1.html#a57d3dcd8df8ac8e5a330e714761ab354">ERR_NO_SUCH_ID</a> = 1</td></tr>
<tr class="memdesc:a57d3dcd8df8ac8e5a330e714761ab354"><td class="mdescLeft"> </td><td class="mdescRight">Error codes. <a href="#a57d3dcd8df8ac8e5a330e714761ab354">More...</a><br /></td></tr>
<tr class="separator:a57d3dcd8df8ac8e5a330e714761ab354"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3e98f59861a65fe62ab6ab6cf392bc59"><td class="memItemLeft" align="right" valign="top"><a id="a3e98f59861a65fe62ab6ab6cf392bc59"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1DataPushService__1__0__1.html#a3e98f59861a65fe62ab6ab6cf392bc59">ERR_INVALID_PARAMS</a> = 2</td></tr>
<tr class="memdesc:a3e98f59861a65fe62ab6ab6cf392bc59"><td class="mdescLeft"> </td><td class="mdescRight">Invalid parameters. <br /></td></tr>
<tr class="separator:a3e98f59861a65fe62ab6ab6cf392bc59"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1e774d5dbda391cb627577b4eab563b2"><td class="memItemLeft" align="right" valign="top"><a id="a1e774d5dbda391cb627577b4eab563b2"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1DataPushService__1__0__1.html#a1e774d5dbda391cb627577b4eab563b2">ERR_MAX_ENTRIES_REACHED</a> = 3</td></tr>
<tr class="memdesc:a1e774d5dbda391cb627577b4eab563b2"><td class="mdescLeft"> </td><td class="mdescRight">Maximum number of entries reached. <br /></td></tr>
<tr class="separator:a1e774d5dbda391cb627577b4eab563b2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9c742da4caab63d7b447e3aec742ccad"><td class="memItemLeft" align="right" valign="top">valueobject </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1DataPushService__1__0__1.html#a9c742da4caab63d7b447e3aec742ccad">EntryAddedEvent</a>: <a class="el" href="namespaceevent.html#a2c124cd89f703231aa6031d409472a3e">UserEvent</a> { int entryId</td></tr>
<tr class="memdesc:a9c742da4caab63d7b447e3aec742ccad"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structevent_1_1Event.html" title="Event has a type: a STATE event indicates that a boolean state has been changed, i.e. ">Event</a>: A new push destination has been added. <a href="#a9c742da4caab63d7b447e3aec742ccad">More...</a><br /></td></tr>
<tr class="separator:a9c742da4caab63d7b447e3aec742ccad"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a23977cad0a2892a23bce7396d4197b09"><td class="memItemLeft" align="right" valign="top"><a id="a23977cad0a2892a23bce7396d4197b09"></a>
<a class="el" href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html">EntrySettings</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1DataPushService__1__0__1.html#a23977cad0a2892a23bce7396d4197b09">settings</a></td></tr>
<tr class="memdesc:a23977cad0a2892a23bce7396d4197b09"><td class="mdescLeft"> </td><td class="mdescRight">New entry settings. <br /></td></tr>
<tr class="separator:a23977cad0a2892a23bce7396d4197b09"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a236a988aae097c1eca4ed3bb85fff14b"><td class="memItemLeft" align="right" valign="top">valueobject </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1DataPushService__1__0__1.html#a236a988aae097c1eca4ed3bb85fff14b">EntryModifiedEvent</a>: <a class="el" href="namespaceevent.html#a2c124cd89f703231aa6031d409472a3e">UserEvent</a> { int entryId</td></tr>
<tr class="memdesc:a236a988aae097c1eca4ed3bb85fff14b"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structevent_1_1Event.html" title="Event has a type: a STATE event indicates that a boolean state has been changed, i.e. ">Event</a>: A configured push destination has been modified. <a href="#a236a988aae097c1eca4ed3bb85fff14b">More...</a><br /></td></tr>
<tr class="separator:a236a988aae097c1eca4ed3bb85fff14b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6462652925d70e3a038c6410a6bf768d"><td class="memItemLeft" align="right" valign="top"><a id="a6462652925d70e3a038c6410a6bf768d"></a>
<a class="el" href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html">EntrySettings</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1DataPushService__1__0__1.html#a6462652925d70e3a038c6410a6bf768d">oldSettings</a></td></tr>
<tr class="memdesc:a6462652925d70e3a038c6410a6bf768d"><td class="mdescLeft"> </td><td class="mdescRight">Settings before change. <br /></td></tr>
<tr class="separator:a6462652925d70e3a038c6410a6bf768d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad2051c8c7cf57681d61ca5e22a164757"><td class="memItemLeft" align="right" valign="top"><a id="ad2051c8c7cf57681d61ca5e22a164757"></a>
<a class="el" href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html">EntrySettings</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1DataPushService__1__0__1.html#ad2051c8c7cf57681d61ca5e22a164757">newSettings</a></td></tr>
<tr class="memdesc:ad2051c8c7cf57681d61ca5e22a164757"><td class="mdescLeft"> </td><td class="mdescRight">Settings after change. <br /></td></tr>
<tr class="separator:ad2051c8c7cf57681d61ca5e22a164757"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa5fac430bc5e288636eca91c454c8a1b"><td class="memItemLeft" align="right" valign="top">valueobject </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1DataPushService__1__0__1.html#aa5fac430bc5e288636eca91c454c8a1b">EntryDeletedEvent</a>: <a class="el" href="namespaceevent.html#a2c124cd89f703231aa6031d409472a3e">UserEvent</a> { int entryId</td></tr>
<tr class="memdesc:aa5fac430bc5e288636eca91c454c8a1b"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structevent_1_1Event.html" title="Event has a type: a STATE event indicates that a boolean state has been changed, i.e. ">Event</a>: A configured push destination has been deleted. <a href="#aa5fac430bc5e288636eca91c454c8a1b">More...</a><br /></td></tr>
<tr class="separator:aa5fac430bc5e288636eca91c454c8a1b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aab73649b6cb934edf9701a29fa5acd39"><td class="memItemLeft" align="right" valign="top">valueobject </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1DataPushService__1__0__1.html#aab73649b6cb934edf9701a29fa5acd39">EntryStatusChangedEvent</a>: <a class="el" href="namespaceidl.html#accbdf35b0c02d64ce223e912fc2b246f">idl::Event</a> { int entryId</td></tr>
<tr class="memdesc:aab73649b6cb934edf9701a29fa5acd39"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structevent_1_1Event.html" title="Event has a type: a STATE event indicates that a boolean state has been changed, i.e. ">Event</a>: The status of a configured push destination has changed. <a href="#aab73649b6cb934edf9701a29fa5acd39">More...</a><br /></td></tr>
<tr class="separator:aab73649b6cb934edf9701a29fa5acd39"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a00dd1795eed7c569e64d559921515c23"><td class="memItemLeft" align="right" valign="top"><a id="a00dd1795eed7c569e64d559921515c23"></a>
<a class="el" href="structevent_1_1DataPushService__1__0__1_1_1EntryStatus.html">EntryStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1DataPushService__1__0__1.html#a00dd1795eed7c569e64d559921515c23">newStatus</a></td></tr>
<tr class="memdesc:a00dd1795eed7c569e64d559921515c23"><td class="mdescLeft"> </td><td class="mdescRight">New status. <br /></td></tr>
<tr class="separator:a00dd1795eed7c569e64d559921515c23"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Data push service configuration interface. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="ad48147fc26f071a1b4956f0cfe9c92ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad48147fc26f071a1b4956f0cfe9c92ee">◆ </a></span>EntryType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="interfaceevent_1_1DataPushService__1__0__1.html#ad48147fc26f071a1b4956f0cfe9c92ee">event::DataPushService_1_0_1::EntryType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Data Push Entry Types. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ad48147fc26f071a1b4956f0cfe9c92eea4ecbb64f371b906192b8bcc1d66112be"></a>SENSORLIST </td><td class="fielddoc"><p>Sensor values for a set of sensors. </p>
</td></tr>
<tr><td class="fieldname"><a id="ad48147fc26f071a1b4956f0cfe9c92eeab46cdcd8a8bf4abfbb3c21d50d6d9a0d"></a>SENSORLOG </td><td class="fielddoc"><p>Sensor log. </p>
</td></tr>
<tr><td class="fieldname"><a id="ad48147fc26f071a1b4956f0cfe9c92eea2134ae13f40f31e3c7fd1b25c04faf41"></a>AMSLIST </td><td class="fielddoc"><p>Asset Management information for a set of AMS strips. </p>
</td></tr>
<tr><td class="fieldname"><a id="ad48147fc26f071a1b4956f0cfe9c92eea7278b5c1d8876b97ceb6cabe9f2f1434"></a>AMSLOG </td><td class="fielddoc"><p>Asset Management log. </p>
</td></tr>
<tr><td class="fieldname"><a id="ad48147fc26f071a1b4956f0cfe9c92eea391c328903a144cfd0a5e64a6353dd87"></a>AUDITLOG </td><td class="fielddoc"><p>Audit log. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a8b07f67909d9a4c51147dc90f6b9cfc9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b07f67909d9a4c51147dc90f6b9cfc9">◆ </a></span>addEntry()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int event::DataPushService_1_0_1::addEntry </td>
<td>(</td>
<td class="paramtype">out int </td>
<td class="paramname"><em>entryId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in <a class="el" href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html">EntrySettings</a> </td>
<td class="paramname"><em>entrySettings</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a new entry. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">entryId</td><td>Result: New entry id, automatically assigned </td></tr>
<tr><td class="paramname">entrySettings</td><td>New Model Push Entry settings</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </dd>
<dd>
2 if the settings are invalid </dd>
<dd>
3 if the maximum number of entries is reached </dd></dl>
</div>
</div>
<a id="ac4d91f85e8fbc84124636738b33d9ba5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4d91f85e8fbc84124636738b33d9ba5">◆ </a></span>deleteEntry()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int event::DataPushService_1_0_1::deleteEntry </td>
<td>(</td>
<td class="paramtype">in int </td>
<td class="paramname"><em>entryId</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Delete an entry. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">entryid</td><td>Entry id</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </dd>
<dd>
1 if the entry does not exist </dd></dl>
</div>
</div>
<a id="a4a498d0acda37a09616900d88bb68926"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a498d0acda37a09616900d88bb68926">◆ </a></span>getEntry()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int event::DataPushService_1_0_1::getEntry </td>
<td>(</td>
<td class="paramtype">out <a class="el" href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html">EntrySettings</a> </td>
<td class="paramname"><em>entrySettings</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in int </td>
<td class="paramname"><em>entryId</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve an entry. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">entrySettings</td><td>Result: Model Push Entry settings </td></tr>
<tr><td class="paramname">entryId</td><td>Entry id</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </dd>
<dd>
1 if the entry does not exist </dd></dl>
</div>
</div>
<a id="a54abada83259f60e74973f0c94f9e278"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a54abada83259f60e74973f0c94f9e278">◆ </a></span>getEntryStatus()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int event::DataPushService_1_0_1::getEntryStatus </td>
<td>(</td>
<td class="paramtype">out <a class="el" href="structevent_1_1DataPushService__1__0__1_1_1EntryStatus.html">EntryStatus</a> </td>
<td class="paramname"><em>entryStatus</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in int </td>
<td class="paramname"><em>entryId</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve an entry's status. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">entryStatus</td><td>Result: Entry status </td></tr>
<tr><td class="paramname">entryId</td><td>Entry id</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </dd>
<dd>
1 if the entry does not exist </dd></dl>
</div>
</div>
<a id="adb77660b88a62284f2ef7cd94ee41554"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adb77660b88a62284f2ef7cd94ee41554">◆ </a></span>listEntries()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">map<int, <a class="el" href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html">EntrySettings</a>> event::DataPushService_1_0_1::listEntries </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve a list of entries. </p>
<dl class="section return"><dt>Returns</dt><dd>List of Entry Settings </dd></dl>
</div>
</div>
<a id="a8d020410a04373dac6399a575cd6950f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d020410a04373dac6399a575cd6950f">◆ </a></span>modifyEntry()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int event::DataPushService_1_0_1::modifyEntry </td>
<td>(</td>
<td class="paramtype">in int </td>
<td class="paramname"><em>entryId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in <a class="el" href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html">EntrySettings</a> </td>
<td class="paramname"><em>entrySettings</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Modify an existing entry. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">entryId</td><td>Entry id </td></tr>
<tr><td class="paramname">entrySettings</td><td>New Model Push Entry settings</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </dd>
<dd>
1 if the entry does not exist </dd>
<dd>
2 if the settings are invalid </dd></dl>
</div>
</div>
<a id="ab8ae5f0ec8695c3261603559c0de59f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab8ae5f0ec8695c3261603559c0de59f8">◆ </a></span>pushData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int event::DataPushService_1_0_1::pushData </td>
<td>(</td>
<td class="paramtype">in int </td>
<td class="paramname"><em>entryId</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Push data for one specified entry. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">entryId</td><td>Entry id</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </dd>
<dd>
1 if entry does not exist </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a9c742da4caab63d7b447e3aec742ccad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9c742da4caab63d7b447e3aec742ccad">◆ </a></span>EntryAddedEvent</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">valueobject event::DataPushService_1_0_1::EntryAddedEvent</td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="structevent_1_1Event.html" title="Event has a type: a STATE event indicates that a boolean state has been changed, i.e. ">Event</a>: A new push destination has been added. </p>
<p>New entry id </p>
</div>
</div>
<a id="aa5fac430bc5e288636eca91c454c8a1b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa5fac430bc5e288636eca91c454c8a1b">◆ </a></span>EntryDeletedEvent</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">valueobject event::DataPushService_1_0_1::EntryDeletedEvent</td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="structevent_1_1Event.html" title="Event has a type: a STATE event indicates that a boolean state has been changed, i.e. ">Event</a>: A configured push destination has been deleted. </p>
<p>Deleted entry id </p>
</div>
</div>
<a id="a236a988aae097c1eca4ed3bb85fff14b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a236a988aae097c1eca4ed3bb85fff14b">◆ </a></span>EntryModifiedEvent</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">valueobject event::DataPushService_1_0_1::EntryModifiedEvent</td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="structevent_1_1Event.html" title="Event has a type: a STATE event indicates that a boolean state has been changed, i.e. ">Event</a>: A configured push destination has been modified. </p>
<p>Modified entry id </p>
</div>
</div>
<a id="aab73649b6cb934edf9701a29fa5acd39"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aab73649b6cb934edf9701a29fa5acd39">◆ </a></span>EntryStatusChangedEvent</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">valueobject event::DataPushService_1_0_1::EntryStatusChangedEvent</td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="structevent_1_1Event.html" title="Event has a type: a STATE event indicates that a boolean state has been changed, i.e. ">Event</a>: The status of a configured push destination has changed. </p>
<p>Entry id </p>
</div>
</div>
<a id="a57d3dcd8df8ac8e5a330e714761ab354"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a57d3dcd8df8ac8e5a330e714761ab354">◆ </a></span>ERR_NO_SUCH_ID</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">constant int event::DataPushService_1_0_1::ERR_NO_SUCH_ID = 1</td>
</tr>
</table>
</div><div class="memdoc">
<p>Error codes. </p>
<p>No such ID </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="DataPushService_8idl_source.html">DataPushService.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>
|
