File: interfacenet_1_1Services.html

package info (click to toggle)
raritan-json-rpc-sdk 3.6.1%2Bds1-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 41,748 kB
  • sloc: cs: 162,629; perl: 85,818; python: 24,275; javascript: 5,937; makefile: 21
file content (168 lines) | stat: -rw-r--r-- 8,531 bytes parent folder | download
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
<!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: net::Services 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&amp;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&amp;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="namespacenet.html">net</a></li><li class="navelem"><a class="el" href="interfacenet_1_1Services.html">Services</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="interfacenet_1_1Services-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">net::Services Interface Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Network services configuration interface.  
 <a href="interfacenet_1_1Services.html#details">More...</a></p>

<p><code>import&quot;<a class="el" href="Services_8idl_source.html">Services.idl</a>&quot;;</code></p>
<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:a00b82036c2f7d4d7bc34a35c0dc1c8ab"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacenet_1_1Services.html#a00b82036c2f7d4d7bc34a35c0dc1c8ab">getSettings</a> (out vector&lt; <a class="el" href="structnet_1_1ServiceSettings.html">ServiceSettings</a> &gt; servicesSettings)</td></tr>
<tr class="memdesc:a00b82036c2f7d4d7bc34a35c0dc1c8ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the network services settings.  <a href="#a00b82036c2f7d4d7bc34a35c0dc1c8ab">More...</a><br /></td></tr>
<tr class="separator:a00b82036c2f7d4d7bc34a35c0dc1c8ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac710f667f629858d3c3d535a3d335340"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacenet_1_1Services.html#ac710f667f629858d3c3d535a3d335340">setSettings</a> (in vector&lt; <a class="el" href="structnet_1_1ServiceSettings.html">ServiceSettings</a> &gt; servicesSettings)</td></tr>
<tr class="memdesc:ac710f667f629858d3c3d535a3d335340"><td class="mdescLeft">&#160;</td><td class="mdescRight">Change the network services settings.  <a href="#ac710f667f629858d3c3d535a3d335340">More...</a><br /></td></tr>
<tr class="separator:ac710f667f629858d3c3d535a3d335340"><td class="memSeparator" colspan="2">&#160;</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:aa51c8bfc26447ab2277f8df99d1f0ced"><td class="memItemLeft" align="right" valign="top"><a id="aa51c8bfc26447ab2277f8df99d1f0ced"></a>
constant int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacenet_1_1Services.html#aa51c8bfc26447ab2277f8df99d1f0ced">ERR_INVALID_PARAMS</a> = 1</td></tr>
<tr class="memdesc:aa51c8bfc26447ab2277f8df99d1f0ced"><td class="mdescLeft">&#160;</td><td class="mdescRight">Invalid parameters. <br /></td></tr>
<tr class="separator:aa51c8bfc26447ab2277f8df99d1f0ced"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Network services configuration interface. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a00b82036c2f7d4d7bc34a35c0dc1c8ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a00b82036c2f7d4d7bc34a35c0dc1c8ab">&#9670;&nbsp;</a></span>getSettings()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void net::Services::getSettings </td>
          <td>(</td>
          <td class="paramtype">out vector&lt; <a class="el" href="structnet_1_1ServiceSettings.html">ServiceSettings</a> &gt;&#160;</td>
          <td class="paramname"><em>servicesSettings</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Retrieve the network services settings. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">servicesSettings</td><td>List of all network services settings </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ac710f667f629858d3c3d535a3d335340"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac710f667f629858d3c3d535a3d335340">&#9670;&nbsp;</a></span>setSettings()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int net::Services::setSettings </td>
          <td>(</td>
          <td class="paramtype">in vector&lt; <a class="el" href="structnet_1_1ServiceSettings.html">ServiceSettings</a> &gt;&#160;</td>
          <td class="paramname"><em>servicesSettings</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Change the network services settings. </p>
<p>This call changes the settings of one or more network services identified by name. Other services are not affected. The resulting configuration of all enabled services must be consistent, i.e. there must be not port collisions.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">servicesSettings</td><td>List of network services settings to be changed</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </dd>
<dd>
1 if any parameters were invalid </dd></dl>

</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="Services_8idl_source.html">Services.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 &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>