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
|
<!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: pdu-json-rpc-api/idl/DataPushService.idl Source File</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="dir_6f2e57e4ed4c9ccdca310d1229964312.html">pdu-json-rpc-api</a></li><li class="navelem"><a class="el" href="dir_8ea0db9e05c169824aafe6441489b6ed.html">idl</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">DataPushService.idl</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* SPDX-License-Identifier: BSD-3-Clause */</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright 2014 Raritan Inc. All rights reserved.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> */</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#include <UserEvent.idl></span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"></span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">/** Event interface */</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> module <span class="keyword">event</span> {</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"></span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> /** Data push service configuration interface */</span></div><div class="line"><a name="l00012"></a><span class="lineno"><a class="line" href="interfaceevent_1_1DataPushService__1__0__1.html"> 12</a></span>  <span class="keyword">interface </span><a class="code" href="interfaceevent_1_1DataPushService__1__0__1.html">DataPushService_1_0_1</a> {</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"></span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> /**</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * Data Push Entry Types</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> */</span></div><div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="interfaceevent_1_1DataPushService__1__0__1.html#ad48147fc26f071a1b4956f0cfe9c92ee"> 17</a></span>  enumeration <a class="code" href="interfaceevent_1_1DataPushService__1__0__1.html#ad48147fc26f071a1b4956f0cfe9c92ee">EntryType</a> {</div><div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="interfaceevent_1_1DataPushService__1__0__1.html#ad48147fc26f071a1b4956f0cfe9c92eea4ecbb64f371b906192b8bcc1d66112be"> 18</a></span>  <a class="code" href="interfaceevent_1_1DataPushService__1__0__1.html#ad48147fc26f071a1b4956f0cfe9c92eea4ecbb64f371b906192b8bcc1d66112be">SENSORLIST</a>, <span class="comment">///< Sensor values for a set of sensors</span></div><div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="interfaceevent_1_1DataPushService__1__0__1.html#ad48147fc26f071a1b4956f0cfe9c92eeab46cdcd8a8bf4abfbb3c21d50d6d9a0d"> 19</a></span> <span class="comment"></span> <a class="code" href="interfaceevent_1_1DataPushService__1__0__1.html#ad48147fc26f071a1b4956f0cfe9c92eeab46cdcd8a8bf4abfbb3c21d50d6d9a0d">SENSORLOG</a>, <span class="comment">///< Sensor log</span></div><div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="interfaceevent_1_1DataPushService__1__0__1.html#ad48147fc26f071a1b4956f0cfe9c92eea2134ae13f40f31e3c7fd1b25c04faf41"> 20</a></span> <span class="comment"></span> <a class="code" href="interfaceevent_1_1DataPushService__1__0__1.html#ad48147fc26f071a1b4956f0cfe9c92eea2134ae13f40f31e3c7fd1b25c04faf41">AMSLIST</a>, <span class="comment">///< Asset Management information for a set of AMS strips</span></div><div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="interfaceevent_1_1DataPushService__1__0__1.html#ad48147fc26f071a1b4956f0cfe9c92eea7278b5c1d8876b97ceb6cabe9f2f1434"> 21</a></span> <span class="comment"></span> <a class="code" href="interfaceevent_1_1DataPushService__1__0__1.html#ad48147fc26f071a1b4956f0cfe9c92eea7278b5c1d8876b97ceb6cabe9f2f1434">AMSLOG</a>, <span class="comment">///< Asset Management log</span></div><div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="interfaceevent_1_1DataPushService__1__0__1.html#ad48147fc26f071a1b4956f0cfe9c92eea391c328903a144cfd0a5e64a6353dd87"> 22</a></span> <span class="comment"></span> AUDITLOG <span class="comment">///< Audit log</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"></span> };</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> /** Error codes */</span></div><div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="interfaceevent_1_1DataPushService__1__0__1.html#a57d3dcd8df8ac8e5a330e714761ab354"> 26</a></span>  constant <span class="keywordtype">int</span> ERR_NO_SUCH_ID = 1; <span class="comment">///< No such ID</span></div><div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="interfaceevent_1_1DataPushService__1__0__1.html#a3e98f59861a65fe62ab6ab6cf392bc59"> 27</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_INVALID_PARAMS = 2; <span class="comment">///< Invalid parameters</span></div><div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="interfaceevent_1_1DataPushService__1__0__1.html#a1e774d5dbda391cb627577b4eab563b2"> 28</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_MAX_ENTRIES_REACHED = 3; <span class="comment">///< Maximum number of entries reached</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"></span><span class="comment"></span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> /**</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> * Data Push Entry Settings</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> */</span></div><div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html"> 33</a></span>  structure <a class="code" href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html">EntrySettings</a> {</div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html#af59b7ede8a9e68665d3887c320f54a3c"> 34</a></span>  <span class="keywordtype">string</span> <a class="code" href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html#af59b7ede8a9e68665d3887c320f54a3c">url</a>; <span class="comment">///< Destination host</span></div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html#a8e01245de61cee98c7e2b9c1453e0f18"> 35</a></span> <span class="comment"></span> <span class="keywordtype">boolean</span> <a class="code" href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html#a8e01245de61cee98c7e2b9c1453e0f18">allowOffTimeRangeCerts</a>; <span class="comment">///< allow expired and not yet valid TLS certificates</span></div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html#a16752c34aab8617675a9fa01f4e0b080"> 36</a></span> <span class="comment"></span> <span class="keywordtype">string</span> <a class="code" href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html#a16752c34aab8617675a9fa01f4e0b080">caCertChain</a>; <span class="comment">///< TLS CA certificate chain</span></div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html#a35b546acbd593bd60b91c65c06aa862f"> 37</a></span> <span class="comment"></span> <span class="keywordtype">boolean</span> <a class="code" href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html#a35b546acbd593bd60b91c65c06aa862f">useAuth</a>; <span class="comment">///< \c true to use HTTP basic authentication</span></div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html#ae03dc9209623ef43be3c8a3d572b3615"> 38</a></span> <span class="comment"></span> <span class="keywordtype">string</span> <a class="code" href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html#ae03dc9209623ef43be3c8a3d572b3615">username</a>; <span class="comment">///< Authentication user name</span></div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html#a9e1da3fdea46ca66506bafebd9af0b3d"> 39</a></span> <span class="comment"></span> <span class="keywordtype">string</span> <a class="code" href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html#a9e1da3fdea46ca66506bafebd9af0b3d">password</a>; <span class="comment">///< Password; write-only, empty to leave unchanged</span></div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html#a98bf07cf97937516954755f84b49787e"> 40</a></span> <span class="comment"></span> <a class="code" href="interfaceevent_1_1DataPushService__1__0__1.html#ad48147fc26f071a1b4956f0cfe9c92ee">EntryType</a> <a class="code" href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html#a98bf07cf97937516954755f84b49787e">type</a>; <span class="comment">///< Type of data</span></div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html#a10201be9fbacbf69bfdbe8c5ff9baf76"> 41</a></span> <span class="comment"></span> vector<string> <a class="code" href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html#a10201be9fbacbf69bfdbe8c5ff9baf76">items</a>; <span class="comment">///< Included items (e.g. list of sensors) depending on type</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"></span> };</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"></span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> /**</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> * Data Push Entry Status</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> */</span></div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="structevent_1_1DataPushService__1__0__1_1_1EntryStatus.html"> 47</a></span>  structure <a class="code" href="structevent_1_1DataPushService__1__0__1_1_1EntryStatus.html">EntryStatus</a> {</div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="structevent_1_1DataPushService__1__0__1_1_1EntryStatus.html#aa370b318874a30af53df0ae82ab4347b"> 48</a></span>  <span class="keywordtype">boolean</span> <a class="code" href="structevent_1_1DataPushService__1__0__1_1_1EntryStatus.html#aa370b318874a30af53df0ae82ab4347b">busy</a>; <span class="comment">///< \c true if the entry is currently being pushed</span></div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="structevent_1_1DataPushService__1__0__1_1_1EntryStatus.html#a296038ca5d48e98fb6817c88b9608a56"> 49</a></span> <span class="comment"></span> <span class="keywordtype">boolean</span> <a class="code" href="structevent_1_1DataPushService__1__0__1_1_1EntryStatus.html#a296038ca5d48e98fb6817c88b9608a56">rescheduled</a>; <span class="comment">///< \c true if the entry is set to be pushed again</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"></span><span class="comment"> ///< immediately after completion</span></div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="structevent_1_1DataPushService__1__0__1_1_1EntryStatus.html#a599629f2fcdd83dc4dcc5d4caa55ec96"> 51</a></span> <span class="comment"></span> time <a class="code" href="structevent_1_1DataPushService__1__0__1_1_1EntryStatus.html#a599629f2fcdd83dc4dcc5d4caa55ec96">lastAttemptTime</a>; <span class="comment">///< Timestamp of the last push attempt (0 = never)</span></div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="structevent_1_1DataPushService__1__0__1_1_1EntryStatus.html#ab22d8bc5abdd2a874aff6949b7554700"> 52</a></span> <span class="comment"></span> time <a class="code" href="structevent_1_1DataPushService__1__0__1_1_1EntryStatus.html#ab22d8bc5abdd2a874aff6949b7554700">lastSuccessTime</a>; <span class="comment">///< Timestamp of last successful push (0 = never)</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"></span> };</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"></span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> /**</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> * Event: A new push destination has been added</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> */</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  valueobject EntryAddedEvent extends <a class="code" href="namespaceevent.html#a2c124cd89f703231aa6031d409472a3e">UserEvent</a> {</div><div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="interfaceevent_1_1DataPushService__1__0__1.html#a9c742da4caab63d7b447e3aec742ccad"> 59</a></span>  <span class="keywordtype">int</span> entryId; <span class="comment">///< New entry id</span></div><div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="interfaceevent_1_1DataPushService__1__0__1.html#a23977cad0a2892a23bce7396d4197b09"> 60</a></span> <span class="comment"></span> <a class="code" href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html">EntrySettings</a> <a class="code" href="interfaceevent_1_1DataPushService__1__0__1.html#a23977cad0a2892a23bce7396d4197b09">settings</a>; <span class="comment">///< New entry settings</span></div><div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="interfaceevent_1_1DataPushService__1__0__1.html#a236a988aae097c1eca4ed3bb85fff14b"> 61</a></span> <span class="comment"></span> };</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"></span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> /**</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> * Event: A configured push destination has been modified</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> */</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  valueobject EntryModifiedEvent extends <a class="code" href="namespaceevent.html#a2c124cd89f703231aa6031d409472a3e">UserEvent</a> {</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">int</span> entryId; <span class="comment">///< Modified entry id</span></div><div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="interfaceevent_1_1DataPushService__1__0__1.html#a6462652925d70e3a038c6410a6bf768d"> 68</a></span> <span class="comment"></span> <a class="code" href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html">EntrySettings</a> <a class="code" href="interfaceevent_1_1DataPushService__1__0__1.html#a6462652925d70e3a038c6410a6bf768d">oldSettings</a>; <span class="comment">///< Settings before change</span></div><div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="interfaceevent_1_1DataPushService__1__0__1.html#ad2051c8c7cf57681d61ca5e22a164757"> 69</a></span> <span class="comment"></span> <a class="code" href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html">EntrySettings</a> <a class="code" href="interfaceevent_1_1DataPushService__1__0__1.html#ad2051c8c7cf57681d61ca5e22a164757">newSettings</a>; <span class="comment">///< Settings after change</span></div><div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="interfaceevent_1_1DataPushService__1__0__1.html#aa5fac430bc5e288636eca91c454c8a1b"> 70</a></span> <span class="comment"></span> };</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"></span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> /**</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> * Event: A configured push destination has been deleted</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> */</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  valueobject EntryDeletedEvent extends <a class="code" href="namespaceevent.html#a2c124cd89f703231aa6031d409472a3e">UserEvent</a> {</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordtype">int</span> entryId; <span class="comment">///< Deleted entry id</span></div><div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="interfaceevent_1_1DataPushService__1__0__1.html#aab73649b6cb934edf9701a29fa5acd39"> 77</a></span> <span class="comment"></span> };</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"></span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> /**</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> * Event: The status of a configured push destination has changed</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> */</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  valueobject EntryStatusChangedEvent extends <a class="code" href="namespaceidl.html">idl</a>.Event {</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordtype">int</span> entryId; <span class="comment">///< Entry id</span></div><div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="interfaceevent_1_1DataPushService__1__0__1.html#a00dd1795eed7c569e64d559921515c23"> 84</a></span> <span class="comment"></span> <a class="code" href="structevent_1_1DataPushService__1__0__1_1_1EntryStatus.html">EntryStatus</a> <a class="code" href="interfaceevent_1_1DataPushService__1__0__1.html#a00dd1795eed7c569e64d559921515c23">newStatus</a>; <span class="comment">///< New status</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"></span> };</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"></span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> /**</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> * Add a new entry.</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> *</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> * @param entryId Result: New entry id, automatically assigned</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> * @param entrySettings New Model Push Entry settings</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> *</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> * @return 0 if OK</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> * @return 2 if the settings are invalid</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> * @return 3 if the maximum number of entries is reached</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> */</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordtype">int</span> addEntry(out <span class="keywordtype">int</span> entryId, in EntrySettings entrySettings);</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"></span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> /**</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> * Modify an existing entry.</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> *</span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> * @param entryId Entry id</span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> * @param entrySettings New Model Push Entry settings</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> *</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> * @return 0 if OK</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> * @return 1 if the entry does not exist</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> * @return 2 if the settings are invalid</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> */</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keywordtype">int</span> modifyEntry(in <span class="keywordtype">int</span> entryId, in EntrySettings entrySettings);</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"></span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> /**</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> * Delete an entry.</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> *</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"> * @param entryid Entry id</span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> *</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> * @return 0 if OK</span></div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> * @return 1 if the entry does not exist</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> */</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keywordtype">int</span> deleteEntry(in <span class="keywordtype">int</span> entryId);</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"></span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> /**</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> * Retrieve an entry.</span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> *</span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> * @param entrySettings Result: Model Push Entry settings</span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> * @param entryId Entry id</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> *</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> * @return 0 if OK</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"> * @return 1 if the entry does not exist</span></div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> */</span></div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <span class="keywordtype">int</span> getEntry(out EntrySettings entrySettings, in <span class="keywordtype">int</span> entryId);</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"></span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> /**</span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"> * Retrieve a list of entries.</span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"> *</span></div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"> * @return List of Entry Settings</span></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"> */</span></div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  map<int, EntrySettings> listEntries();</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"></span></div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"> /**</span></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"> * Push data for one specified entry</span></div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> *</span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> * @param entryId Entry id</span></div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> *</span></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> * @return 0 if OK</span></div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"> * @return 1 if entry does not exist</span></div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> *</span></div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"> */</span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <span class="keywordtype">int</span> pushData(in <span class="keywordtype">int</span> entryId);</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"></span></div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> /**</span></div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> * Retrieve an entry's status.</span></div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> *</span></div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"> * @param entryStatus Result: Entry status</span></div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"> * @param entryId Entry id</span></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"> *</span></div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> * @return 0 if OK</span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"> * @return 1 if the entry does not exist</span></div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"> */</span></div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <span class="keywordtype">int</span> getEntryStatus(out EntryStatus entryStatus, in <span class="keywordtype">int</span> entryId);</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> </div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  };</div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> </div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> }</div><div class="ttc" id="interfaceevent_1_1DataPushService__1__0__1_html_a6462652925d70e3a038c6410a6bf768d"><div class="ttname"><a href="interfaceevent_1_1DataPushService__1__0__1.html#a6462652925d70e3a038c6410a6bf768d">event::DataPushService_1_0_1::oldSettings</a></div><div class="ttdeci">EntrySettings oldSettings</div><div class="ttdoc">Settings before change. </div><div class="ttdef"><b>Definition:</b> DataPushService.idl:68</div></div>
<div class="ttc" id="structevent_1_1DataPushService__1__0__1_1_1EntrySettings_html_a8e01245de61cee98c7e2b9c1453e0f18"><div class="ttname"><a href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html#a8e01245de61cee98c7e2b9c1453e0f18">event::DataPushService_1_0_1::EntrySettings::allowOffTimeRangeCerts</a></div><div class="ttdeci">boolean allowOffTimeRangeCerts</div><div class="ttdoc">allow expired and not yet valid TLS certificates </div><div class="ttdef"><b>Definition:</b> DataPushService.idl:35</div></div>
<div class="ttc" id="interfaceevent_1_1DataPushService__1__0__1_html_a00dd1795eed7c569e64d559921515c23"><div class="ttname"><a href="interfaceevent_1_1DataPushService__1__0__1.html#a00dd1795eed7c569e64d559921515c23">event::DataPushService_1_0_1::newStatus</a></div><div class="ttdeci">EntryStatus newStatus</div><div class="ttdoc">New status. </div><div class="ttdef"><b>Definition:</b> DataPushService.idl:84</div></div>
<div class="ttc" id="structevent_1_1DataPushService__1__0__1_1_1EntrySettings_html_a16752c34aab8617675a9fa01f4e0b080"><div class="ttname"><a href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html#a16752c34aab8617675a9fa01f4e0b080">event::DataPushService_1_0_1::EntrySettings::caCertChain</a></div><div class="ttdeci">string caCertChain</div><div class="ttdoc">TLS CA certificate chain. </div><div class="ttdef"><b>Definition:</b> DataPushService.idl:36</div></div>
<div class="ttc" id="interfaceevent_1_1DataPushService__1__0__1_html_ad48147fc26f071a1b4956f0cfe9c92eea2134ae13f40f31e3c7fd1b25c04faf41"><div class="ttname"><a href="interfaceevent_1_1DataPushService__1__0__1.html#ad48147fc26f071a1b4956f0cfe9c92eea2134ae13f40f31e3c7fd1b25c04faf41">event::DataPushService_1_0_1::AMSLIST</a></div><div class="ttdoc">Asset Management information for a set of AMS strips. </div><div class="ttdef"><b>Definition:</b> DataPushService.idl:20</div></div>
<div class="ttc" id="structevent_1_1DataPushService__1__0__1_1_1EntryStatus_html"><div class="ttname"><a href="structevent_1_1DataPushService__1__0__1_1_1EntryStatus.html">event::DataPushService_1_0_1::EntryStatus</a></div><div class="ttdoc">Data Push Entry Status. </div><div class="ttdef"><b>Definition:</b> DataPushService.idl:47</div></div>
<div class="ttc" id="structevent_1_1DataPushService__1__0__1_1_1EntrySettings_html_ae03dc9209623ef43be3c8a3d572b3615"><div class="ttname"><a href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html#ae03dc9209623ef43be3c8a3d572b3615">event::DataPushService_1_0_1::EntrySettings::username</a></div><div class="ttdeci">string username</div><div class="ttdoc">Authentication user name. </div><div class="ttdef"><b>Definition:</b> DataPushService.idl:38</div></div>
<div class="ttc" id="interfaceevent_1_1DataPushService__1__0__1_html_ad48147fc26f071a1b4956f0cfe9c92eea4ecbb64f371b906192b8bcc1d66112be"><div class="ttname"><a href="interfaceevent_1_1DataPushService__1__0__1.html#ad48147fc26f071a1b4956f0cfe9c92eea4ecbb64f371b906192b8bcc1d66112be">event::DataPushService_1_0_1::SENSORLIST</a></div><div class="ttdoc">Sensor values for a set of sensors. </div><div class="ttdef"><b>Definition:</b> DataPushService.idl:18</div></div>
<div class="ttc" id="namespaceidl_html"><div class="ttname"><a href="namespaceidl.html">idl</a></div><div class="ttdoc">Basic IDL definitions. </div><div class="ttdef"><b>Definition:</b> Event.idl:10</div></div>
<div class="ttc" id="structevent_1_1DataPushService__1__0__1_1_1EntryStatus_html_a599629f2fcdd83dc4dcc5d4caa55ec96"><div class="ttname"><a href="structevent_1_1DataPushService__1__0__1_1_1EntryStatus.html#a599629f2fcdd83dc4dcc5d4caa55ec96">event::DataPushService_1_0_1::EntryStatus::lastAttemptTime</a></div><div class="ttdeci">time lastAttemptTime</div><div class="ttdoc">Timestamp of the last push attempt (0 = never) </div><div class="ttdef"><b>Definition:</b> DataPushService.idl:51</div></div>
<div class="ttc" id="structevent_1_1DataPushService__1__0__1_1_1EntrySettings_html_a10201be9fbacbf69bfdbe8c5ff9baf76"><div class="ttname"><a href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html#a10201be9fbacbf69bfdbe8c5ff9baf76">event::DataPushService_1_0_1::EntrySettings::items</a></div><div class="ttdeci">vector< string > items</div><div class="ttdoc">Included items (e.g. list of sensors) depending on type. </div><div class="ttdef"><b>Definition:</b> DataPushService.idl:41</div></div>
<div class="ttc" id="interfaceevent_1_1DataPushService__1__0__1_html_ad48147fc26f071a1b4956f0cfe9c92ee"><div class="ttname"><a href="interfaceevent_1_1DataPushService__1__0__1.html#ad48147fc26f071a1b4956f0cfe9c92ee">event::DataPushService_1_0_1::EntryType</a></div><div class="ttdeci">EntryType</div><div class="ttdoc">Data Push Entry Types. </div><div class="ttdef"><b>Definition:</b> DataPushService.idl:17</div></div>
<div class="ttc" id="structevent_1_1DataPushService__1__0__1_1_1EntrySettings_html_a35b546acbd593bd60b91c65c06aa862f"><div class="ttname"><a href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html#a35b546acbd593bd60b91c65c06aa862f">event::DataPushService_1_0_1::EntrySettings::useAuth</a></div><div class="ttdeci">boolean useAuth</div><div class="ttdoc">true to use HTTP basic authentication </div><div class="ttdef"><b>Definition:</b> DataPushService.idl:37</div></div>
<div class="ttc" id="structevent_1_1DataPushService__1__0__1_1_1EntryStatus_html_a296038ca5d48e98fb6817c88b9608a56"><div class="ttname"><a href="structevent_1_1DataPushService__1__0__1_1_1EntryStatus.html#a296038ca5d48e98fb6817c88b9608a56">event::DataPushService_1_0_1::EntryStatus::rescheduled</a></div><div class="ttdeci">boolean rescheduled</div><div class="ttdoc">true if the entry is set to be pushed again immediately after completion </div><div class="ttdef"><b>Definition:</b> DataPushService.idl:49</div></div>
<div class="ttc" id="interfaceevent_1_1DataPushService__1__0__1_html_ad2051c8c7cf57681d61ca5e22a164757"><div class="ttname"><a href="interfaceevent_1_1DataPushService__1__0__1.html#ad2051c8c7cf57681d61ca5e22a164757">event::DataPushService_1_0_1::newSettings</a></div><div class="ttdeci">EntrySettings newSettings</div><div class="ttdoc">Settings after change. </div><div class="ttdef"><b>Definition:</b> DataPushService.idl:69</div></div>
<div class="ttc" id="interfaceevent_1_1DataPushService__1__0__1_html_ad48147fc26f071a1b4956f0cfe9c92eeab46cdcd8a8bf4abfbb3c21d50d6d9a0d"><div class="ttname"><a href="interfaceevent_1_1DataPushService__1__0__1.html#ad48147fc26f071a1b4956f0cfe9c92eeab46cdcd8a8bf4abfbb3c21d50d6d9a0d">event::DataPushService_1_0_1::SENSORLOG</a></div><div class="ttdoc">Sensor log. </div><div class="ttdef"><b>Definition:</b> DataPushService.idl:19</div></div>
<div class="ttc" id="structevent_1_1DataPushService__1__0__1_1_1EntryStatus_html_ab22d8bc5abdd2a874aff6949b7554700"><div class="ttname"><a href="structevent_1_1DataPushService__1__0__1_1_1EntryStatus.html#ab22d8bc5abdd2a874aff6949b7554700">event::DataPushService_1_0_1::EntryStatus::lastSuccessTime</a></div><div class="ttdeci">time lastSuccessTime</div><div class="ttdoc">Timestamp of last successful push (0 = never) </div><div class="ttdef"><b>Definition:</b> DataPushService.idl:52</div></div>
<div class="ttc" id="interfaceevent_1_1DataPushService__1__0__1_html_a23977cad0a2892a23bce7396d4197b09"><div class="ttname"><a href="interfaceevent_1_1DataPushService__1__0__1.html#a23977cad0a2892a23bce7396d4197b09">event::DataPushService_1_0_1::settings</a></div><div class="ttdeci">EntrySettings settings</div><div class="ttdoc">New entry settings. </div><div class="ttdef"><b>Definition:</b> DataPushService.idl:60</div></div>
<div class="ttc" id="structevent_1_1DataPushService__1__0__1_1_1EntrySettings_html_a98bf07cf97937516954755f84b49787e"><div class="ttname"><a href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html#a98bf07cf97937516954755f84b49787e">event::DataPushService_1_0_1::EntrySettings::type</a></div><div class="ttdeci">EntryType type</div><div class="ttdoc">Type of data. </div><div class="ttdef"><b>Definition:</b> DataPushService.idl:40</div></div>
<div class="ttc" id="structevent_1_1DataPushService__1__0__1_1_1EntrySettings_html_a9e1da3fdea46ca66506bafebd9af0b3d"><div class="ttname"><a href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html#a9e1da3fdea46ca66506bafebd9af0b3d">event::DataPushService_1_0_1::EntrySettings::password</a></div><div class="ttdeci">string password</div><div class="ttdoc">Password; write-only, empty to leave unchanged. </div><div class="ttdef"><b>Definition:</b> DataPushService.idl:39</div></div>
<div class="ttc" id="structevent_1_1DataPushService__1__0__1_1_1EntryStatus_html_aa370b318874a30af53df0ae82ab4347b"><div class="ttname"><a href="structevent_1_1DataPushService__1__0__1_1_1EntryStatus.html#aa370b318874a30af53df0ae82ab4347b">event::DataPushService_1_0_1::EntryStatus::busy</a></div><div class="ttdeci">boolean busy</div><div class="ttdoc">true if the entry is currently being pushed </div><div class="ttdef"><b>Definition:</b> DataPushService.idl:48</div></div>
<div class="ttc" id="interfaceevent_1_1DataPushService__1__0__1_html"><div class="ttname"><a href="interfaceevent_1_1DataPushService__1__0__1.html">event::DataPushService_1_0_1</a></div><div class="ttdoc">Data push service configuration interface. </div><div class="ttdef"><b>Definition:</b> DataPushService.idl:12</div></div>
<div class="ttc" id="namespaceevent_html_a2c124cd89f703231aa6031d409472a3e"><div class="ttname"><a href="namespaceevent.html#a2c124cd89f703231aa6031d409472a3e">event::UserEvent</a></div><div class="ttdeci">valueobject UserEvent</div><div class="ttdoc">This UserEvent may be used as base valueobject for all concrete events that are triggered because of ...</div><div class="ttdef"><b>Definition:</b> UserEvent.idl:20</div></div>
<div class="ttc" id="structevent_1_1DataPushService__1__0__1_1_1EntrySettings_html"><div class="ttname"><a href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html">event::DataPushService_1_0_1::EntrySettings</a></div><div class="ttdoc">Data Push Entry Settings. </div><div class="ttdef"><b>Definition:</b> DataPushService.idl:33</div></div>
<div class="ttc" id="interfaceevent_1_1DataPushService__1__0__1_html_ad48147fc26f071a1b4956f0cfe9c92eea7278b5c1d8876b97ceb6cabe9f2f1434"><div class="ttname"><a href="interfaceevent_1_1DataPushService__1__0__1.html#ad48147fc26f071a1b4956f0cfe9c92eea7278b5c1d8876b97ceb6cabe9f2f1434">event::DataPushService_1_0_1::AMSLOG</a></div><div class="ttdoc">Asset Management log. </div><div class="ttdef"><b>Definition:</b> DataPushService.idl:21</div></div>
<div class="ttc" id="structevent_1_1DataPushService__1__0__1_1_1EntrySettings_html_af59b7ede8a9e68665d3887c320f54a3c"><div class="ttname"><a href="structevent_1_1DataPushService__1__0__1_1_1EntrySettings.html#af59b7ede8a9e68665d3887c320f54a3c">event::DataPushService_1_0_1::EntrySettings::url</a></div><div class="ttdeci">string url</div><div class="ttdoc">Destination host. </div><div class="ttdef"><b>Definition:</b> DataPushService.idl:34</div></div>
</div><!-- fragment --></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>
|
