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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Raritan / Server Technology Xerus™ PDU JSON-RPC API: IDL Interface Versioning</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 / Server Technology Xerus™ PDU JSON-RPC API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<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','.html');
/* @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><!-- top -->
<div class="PageDoc"><div class="header">
<div class="headertitle">
<div class="title">IDL Interface Versioning </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p><a class="anchor" id="md__home_builds_gitlab_builds_QjAyd6bt_0_gitlab_main_firmware_mkdist_tmp_build_pdu_px2_final_documentation_json_rpc_api_versioning"></a></p>
<p>Interfaces defined in IDL have version numbers that are incremented whenever the interface is changed. Version numbers consist of three numbers appended to the interface identifier with underscores, for example <code>sensors.Logger_2_3_7</code>. If an interface identifier does not contain an explicitly specified version number the version defaults to <code>_1_0_0</code>.</p>
<p>The three version components signify different types of interface changes:</p>
<ul>
<li><p class="startli">The last component (<b>minor version</b>) is incremented whenever an interface is changed in a <b>backwards-compatible</b> manner. Compatible means that an existing client program will continue to work with a server implementing the newer interface version.</p>
<p class="startli">Examples for compatible changes are new methods or added fields in structures that are sent from the server to the client (as method return value or <em>out</em> parameter).</p>
</li>
<li><p class="startli">The first component (<b>major version</b>) is incremented when an interface change <b>breaks compatibility</b>. Existing client programs may need to be adapted to work with a server implementing the newer interface.</p>
<p class="startli">Examples for incompatible changes are changed method parameters or extra fields in structures that are sent from client to server (<em>in</em> parameter).</p>
</li>
<li><p class="startli">The middle component (<b>sub-major version</b>) is incremented whenever a <b>referenced interface</b> is changed in an <b>incompatible</b> manner.</p>
<p class="startli">A client program that uses only methods of the interface itself will continue to work unchanged. A program that retrieves references to other interfaces from this one may need to be reviewed and updated.</p>
<p class="startli">For example, a change from <code>Pdu_3_0_0</code> to <code>Pdu_3_1_0</code> indicates that a client program using only methods of the <a class="el" href="interfacepdumodel_1_1Pdu.html">Pdu</a> interface will continue to work without changes. The <a class="el" href="interfacepdumodel_1_1Outlet.html">Outlet</a> interface may have been changed in an incompatible manner, though, so references returned by <a class="el" href="interfacepdumodel_1_1Pdu.html#a75fb0612a24e495ab6459bf9745dfca8">getOutlets()</a> may no longer work as expected.</p>
</li>
</ul>
<h2><a class="anchor" id="autotoc_md163"></a>
History of Interface Changes</h2>
<p>A full list of interface changes in all firmware releases can be found in <a href="Changelog.txt">Changelog.txt</a>.</p>
<h2><a class="anchor" id="autotoc_md164"></a>
Latest Version Numbers</h2>
<p>A list of current version numbers for all supported interfaces is available as <a href="interface_versions.txt">interface_versions.txt</a>. </p>
</div></div><!-- contents -->
</div><!-- PageDoc -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Oct 17 2022 00:25:43 for Raritan / Server Technology Xerus™ PDU JSON-RPC API by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
|
