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
|
<!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/Log.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">Log.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">#ifndef __LOG_IDL__</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#define __LOG_IDL__</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"></span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">/** Device Logging */</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> module <a class="code" href="namespacelogging.html">logging</a> {</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"></span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> /** General log info */</span></div><div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="structlogging_1_1LogInfo.html"> 13</a></span>  structure <a class="code" href="structlogging_1_1LogInfo.html">LogInfo</a> {</div><div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="structlogging_1_1LogInfo.html#a6d588606301bf12b0a3ff922e60a378e"> 14</a></span>  <span class="keywordtype">long</span> <a class="code" href="structlogging_1_1LogInfo.html#a6d588606301bf12b0a3ff922e60a378e">creationTime</a>; <span class="comment">///< Creation time of log; changed by clear()</span></div><div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="structlogging_1_1LogInfo.html#a520da232d7929588a42f4f5fed2711b7"> 15</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structlogging_1_1LogInfo.html#a520da232d7929588a42f4f5fed2711b7">idFirst</a>; <span class="comment">///< Serial number of first entry of the log</span></div><div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="structlogging_1_1LogInfo.html#ad5b0dd78a447046f5603115b4eacfd05"> 16</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structlogging_1_1LogInfo.html#ad5b0dd78a447046f5603115b4eacfd05">idNext</a>; <span class="comment">///< Next unused serial number of the log</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"></span> };</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"></span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> /** A log entry */</span></div><div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="structlogging_1_1LogEntry.html"> 20</a></span>  structure <a class="code" href="structlogging_1_1LogEntry.html">LogEntry</a> {</div><div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="structlogging_1_1LogEntry.html#a4e5a6698a3638eb1b48709b631cbf1c1"> 21</a></span>  <span class="keywordtype">int</span> <a class="code" href="structlogging_1_1LogEntry.html#a4e5a6698a3638eb1b48709b631cbf1c1">id</a>; <span class="comment">///< Serial number</span></div><div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="structlogging_1_1LogEntry.html#aaa2c1b66d4d095eb96864099fa15846b"> 22</a></span> <span class="comment"></span> time <a class="code" href="structlogging_1_1LogEntry.html#aaa2c1b66d4d095eb96864099fa15846b">timestamp</a>; <span class="comment">///< Time stamp</span></div><div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="structlogging_1_1LogEntry.html#a164bc7b248b1dddb0a8d02c33d312202"> 23</a></span> <span class="comment"></span> <span class="keywordtype">string</span> <a class="code" href="structlogging_1_1LogEntry.html#a164bc7b248b1dddb0a8d02c33d312202">eventClass</a>; <span class="comment">///< Category (aka event class)</span></div><div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="structlogging_1_1LogEntry.html#a30caf0a77772cf7821de6ec151c5c361"> 24</a></span> <span class="comment"></span> <span class="keywordtype">string</span> <a class="code" href="structlogging_1_1LogEntry.html#a30caf0a77772cf7821de6ec151c5c361">message</a>; <span class="comment">///< Message</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"></span> };</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> /** A log chunk */</span></div><div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="structlogging_1_1LogChunk.html"> 28</a></span>  structure <a class="code" href="structlogging_1_1LogChunk.html">LogChunk</a> {</div><div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="structlogging_1_1LogChunk.html#a5aa606e715895386f59d1a5e843ac6d5"> 29</a></span>  <span class="keywordtype">long</span> <a class="code" href="structlogging_1_1LogChunk.html#a5aa606e715895386f59d1a5e843ac6d5">logCreationTime</a>; <span class="comment">///< Creation time of log at chunk generation</span></div><div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="structlogging_1_1LogChunk.html#a2582e0835f837a14987fbfb68101a764"> 30</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structlogging_1_1LogChunk.html#a2582e0835f837a14987fbfb68101a764">idFirst</a>; <span class="comment">///< Serial number of first entry in the chunk</span></div><div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="structlogging_1_1LogChunk.html#a14d4023d16e7a944696c31c253b8c9a5"> 31</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structlogging_1_1LogChunk.html#a14d4023d16e7a944696c31c253b8c9a5">allEntryCnt</a>; <span class="comment">///< Number of all entries in the chunk</span></div><div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="structlogging_1_1LogChunk.html#a53faf7f9bfb674a226b242d0e461176c"> 32</a></span> <span class="comment"></span> vector<LogEntry> <a class="code" href="structlogging_1_1LogChunk.html#a53faf7f9bfb674a226b242d0e461176c">selEntries</a>; <span class="comment">///< Selected entries of the chunk</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"></span> };</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"></span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> /** Range direction when fetching log entries */</span></div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="namespacelogging.html#abfa315ed23d6867a293d1a22c8bfe6a8"> 36</a></span>  enumeration <a class="code" href="namespacelogging.html#abfa315ed23d6867a293d1a22c8bfe6a8">RangeDirection</a> {</div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="namespacelogging.html#abfa315ed23d6867a293d1a22c8bfe6a8a025d9a5788e8b2c385643a3e3d39c503"> 37</a></span>  <a class="code" href="namespacelogging.html#abfa315ed23d6867a293d1a22c8bfe6a8a025d9a5788e8b2c385643a3e3d39c503">FORWARD</a>, <span class="comment">///< Ascending serial numbers</span></div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="namespacelogging.html#abfa315ed23d6867a293d1a22c8bfe6a8aa67a3be70320bf75fadda2528cbad8cb"> 38</a></span> <span class="comment"></span> <a class="code" href="namespacelogging.html#abfa315ed23d6867a293d1a22c8bfe6a8aa67a3be70320bf75fadda2528cbad8cb">BACKWARD</a> <span class="comment">///< Descending serial numbers</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"></span> };</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> }</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor">#endif </span><span class="comment">/* __LOG_IDL__ */</span><span class="preprocessor"></span></div><div class="ttc" id="structlogging_1_1LogEntry_html_aaa2c1b66d4d095eb96864099fa15846b"><div class="ttname"><a href="structlogging_1_1LogEntry.html#aaa2c1b66d4d095eb96864099fa15846b">logging::LogEntry::timestamp</a></div><div class="ttdeci">time timestamp</div><div class="ttdoc">Time stamp. </div><div class="ttdef"><b>Definition:</b> Log.idl:22</div></div>
<div class="ttc" id="structlogging_1_1LogEntry_html_a30caf0a77772cf7821de6ec151c5c361"><div class="ttname"><a href="structlogging_1_1LogEntry.html#a30caf0a77772cf7821de6ec151c5c361">logging::LogEntry::message</a></div><div class="ttdeci">string message</div><div class="ttdoc">Message. </div><div class="ttdef"><b>Definition:</b> Log.idl:24</div></div>
<div class="ttc" id="namespacelogging_html"><div class="ttname"><a href="namespacelogging.html">logging</a></div><div class="ttdoc">Device Logging. </div><div class="ttdef"><b>Definition:</b> DebugLog.idl:14</div></div>
<div class="ttc" id="structlogging_1_1LogChunk_html"><div class="ttname"><a href="structlogging_1_1LogChunk.html">logging::LogChunk</a></div><div class="ttdoc">A log chunk. </div><div class="ttdef"><b>Definition:</b> Log.idl:28</div></div>
<div class="ttc" id="structlogging_1_1LogInfo_html_ad5b0dd78a447046f5603115b4eacfd05"><div class="ttname"><a href="structlogging_1_1LogInfo.html#ad5b0dd78a447046f5603115b4eacfd05">logging::LogInfo::idNext</a></div><div class="ttdeci">int idNext</div><div class="ttdoc">Next unused serial number of the log. </div><div class="ttdef"><b>Definition:</b> Log.idl:16</div></div>
<div class="ttc" id="structlogging_1_1LogChunk_html_a2582e0835f837a14987fbfb68101a764"><div class="ttname"><a href="structlogging_1_1LogChunk.html#a2582e0835f837a14987fbfb68101a764">logging::LogChunk::idFirst</a></div><div class="ttdeci">int idFirst</div><div class="ttdoc">Serial number of first entry in the chunk. </div><div class="ttdef"><b>Definition:</b> Log.idl:30</div></div>
<div class="ttc" id="structlogging_1_1LogChunk_html_a53faf7f9bfb674a226b242d0e461176c"><div class="ttname"><a href="structlogging_1_1LogChunk.html#a53faf7f9bfb674a226b242d0e461176c">logging::LogChunk::selEntries</a></div><div class="ttdeci">vector< LogEntry > selEntries</div><div class="ttdoc">Selected entries of the chunk. </div><div class="ttdef"><b>Definition:</b> Log.idl:32</div></div>
<div class="ttc" id="structlogging_1_1LogInfo_html_a520da232d7929588a42f4f5fed2711b7"><div class="ttname"><a href="structlogging_1_1LogInfo.html#a520da232d7929588a42f4f5fed2711b7">logging::LogInfo::idFirst</a></div><div class="ttdeci">int idFirst</div><div class="ttdoc">Serial number of first entry of the log. </div><div class="ttdef"><b>Definition:</b> Log.idl:15</div></div>
<div class="ttc" id="structlogging_1_1LogInfo_html_a6d588606301bf12b0a3ff922e60a378e"><div class="ttname"><a href="structlogging_1_1LogInfo.html#a6d588606301bf12b0a3ff922e60a378e">logging::LogInfo::creationTime</a></div><div class="ttdeci">long creationTime</div><div class="ttdoc">Creation time of log; changed by clear() </div><div class="ttdef"><b>Definition:</b> Log.idl:14</div></div>
<div class="ttc" id="structlogging_1_1LogEntry_html_a4e5a6698a3638eb1b48709b631cbf1c1"><div class="ttname"><a href="structlogging_1_1LogEntry.html#a4e5a6698a3638eb1b48709b631cbf1c1">logging::LogEntry::id</a></div><div class="ttdeci">int id</div><div class="ttdoc">Serial number. </div><div class="ttdef"><b>Definition:</b> Log.idl:21</div></div>
<div class="ttc" id="namespacelogging_html_abfa315ed23d6867a293d1a22c8bfe6a8"><div class="ttname"><a href="namespacelogging.html#abfa315ed23d6867a293d1a22c8bfe6a8">logging::RangeDirection</a></div><div class="ttdeci">RangeDirection</div><div class="ttdoc">Range direction when fetching log entries. </div><div class="ttdef"><b>Definition:</b> Log.idl:36</div></div>
<div class="ttc" id="structlogging_1_1LogInfo_html"><div class="ttname"><a href="structlogging_1_1LogInfo.html">logging::LogInfo</a></div><div class="ttdoc">General log info. </div><div class="ttdef"><b>Definition:</b> Log.idl:13</div></div>
<div class="ttc" id="structlogging_1_1LogChunk_html_a14d4023d16e7a944696c31c253b8c9a5"><div class="ttname"><a href="structlogging_1_1LogChunk.html#a14d4023d16e7a944696c31c253b8c9a5">logging::LogChunk::allEntryCnt</a></div><div class="ttdeci">int allEntryCnt</div><div class="ttdoc">Number of all entries in the chunk. </div><div class="ttdef"><b>Definition:</b> Log.idl:31</div></div>
<div class="ttc" id="namespacelogging_html_abfa315ed23d6867a293d1a22c8bfe6a8a025d9a5788e8b2c385643a3e3d39c503"><div class="ttname"><a href="namespacelogging.html#abfa315ed23d6867a293d1a22c8bfe6a8a025d9a5788e8b2c385643a3e3d39c503">logging::FORWARD</a></div><div class="ttdoc">Ascending serial numbers. </div><div class="ttdef"><b>Definition:</b> Log.idl:37</div></div>
<div class="ttc" id="structlogging_1_1LogChunk_html_a5aa606e715895386f59d1a5e843ac6d5"><div class="ttname"><a href="structlogging_1_1LogChunk.html#a5aa606e715895386f59d1a5e843ac6d5">logging::LogChunk::logCreationTime</a></div><div class="ttdeci">long logCreationTime</div><div class="ttdoc">Creation time of log at chunk generation. </div><div class="ttdef"><b>Definition:</b> Log.idl:29</div></div>
<div class="ttc" id="structlogging_1_1LogEntry_html"><div class="ttname"><a href="structlogging_1_1LogEntry.html">logging::LogEntry</a></div><div class="ttdoc">A log entry. </div><div class="ttdef"><b>Definition:</b> Log.idl:20</div></div>
<div class="ttc" id="namespacelogging_html_abfa315ed23d6867a293d1a22c8bfe6a8aa67a3be70320bf75fadda2528cbad8cb"><div class="ttname"><a href="namespacelogging.html#abfa315ed23d6867a293d1a22c8bfe6a8aa67a3be70320bf75fadda2528cbad8cb">logging::BACKWARD</a></div><div class="ttdoc">Descending serial numbers. </div><div class="ttdef"><b>Definition:</b> Log.idl:38</div></div>
<div class="ttc" id="structlogging_1_1LogEntry_html_a164bc7b248b1dddb0a8d02c33d312202"><div class="ttname"><a href="structlogging_1_1LogEntry.html#a164bc7b248b1dddb0a8d02c33d312202">logging::LogEntry::eventClass</a></div><div class="ttdeci">string eventClass</div><div class="ttdoc">Category (aka event class) </div><div class="ttdef"><b>Definition:</b> Log.idl:23</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>
|
