File: interfacetest_1_1Ethernet.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 (215 lines) | stat: -rw-r--r-- 12,859 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
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
<!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: test::Ethernet 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="namespacetest.html">test</a></li><li class="navelem"><a class="el" href="interfacetest_1_1Ethernet.html">Ethernet</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="interfacetest_1_1Ethernet-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">test::Ethernet Interface Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>test routines for RJ45 <a class="el" href="interfacetest_1_1Ethernet.html" title="test routines for RJ45 Ethernet port This is low level interface using ethtool that does not persist ...">Ethernet</a> port This is low level interface using ethtool that does not persist any of the settings made (TODO: this interface may be combined with a 'decent' network interface.  
 <a href="interfacetest_1_1Ethernet.html#details">More...</a></p>

<p><code>import&quot;<a class="el" href="testrpc_8idl_source.html">testrpc.idl</a>&quot;;</code></p>
<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:a7068d47affdfd12830387cffcb2565e7"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacetest_1_1Ethernet.html#a7068d47affdfd12830387cffcb2565e7">Speed</a> { <a class="el" href="interfacetest_1_1Ethernet.html#a7068d47affdfd12830387cffcb2565e7a0b0effddf634c8fc1f4dc3ab4c4526a5">SPD_10</a>, 
<a class="el" href="interfacetest_1_1Ethernet.html#a7068d47affdfd12830387cffcb2565e7a2eee97cd117ac0635c4ea8a15a8716c3">SPD_100</a>, 
<a class="el" href="interfacetest_1_1Ethernet.html#a7068d47affdfd12830387cffcb2565e7a6cb2bff22a262ceee314aba0361bd696">SPD_1000</a>
 }</td></tr>
<tr class="memdesc:a7068d47affdfd12830387cffcb2565e7"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="interfacetest_1_1Ethernet.html" title="test routines for RJ45 Ethernet port This is low level interface using ethtool that does not persist ...">Ethernet</a> Speed.  <a href="interfacetest_1_1Ethernet.html#a7068d47affdfd12830387cffcb2565e7">More...</a><br /></td></tr>
<tr class="separator:a7068d47affdfd12830387cffcb2565e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a98b12f5c2d49d98357afcfd444a4a292"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacetest_1_1Ethernet.html#a98b12f5c2d49d98357afcfd444a4a292">Duplex</a> { <a class="el" href="interfacetest_1_1Ethernet.html#a98b12f5c2d49d98357afcfd444a4a292a8fae1d3bdaa768f075e516ae7eeff454">DPX_HALF</a>, 
<a class="el" href="interfacetest_1_1Ethernet.html#a98b12f5c2d49d98357afcfd444a4a292a9f328663b012e5ee2aa348c198b914e8">DPX_FULL</a>
 }</td></tr>
<tr class="memdesc:a98b12f5c2d49d98357afcfd444a4a292"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="interfacetest_1_1Ethernet.html" title="test routines for RJ45 Ethernet port This is low level interface using ethtool that does not persist ...">Ethernet</a> Duplex Mode.  <a href="interfacetest_1_1Ethernet.html#a98b12f5c2d49d98357afcfd444a4a292">More...</a><br /></td></tr>
<tr class="separator:a98b12f5c2d49d98357afcfd444a4a292"><td class="memSeparator" colspan="2">&#160;</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:a02689dc34918c1de01650acd85b5af9d"><td class="memItemLeft" align="right" valign="top"><a id="a02689dc34918c1de01650acd85b5af9d"></a>
vector&lt; string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacetest_1_1Ethernet.html#a02689dc34918c1de01650acd85b5af9d">getDevices</a> ()</td></tr>
<tr class="memdesc:a02689dc34918c1de01650acd85b5af9d"><td class="mdescLeft">&#160;</td><td class="mdescRight">returns a a list of valid network interface devices <br /></td></tr>
<tr class="separator:a02689dc34918c1de01650acd85b5af9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a696d2f32aae35319a538834436a6b873"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacetest_1_1Ethernet.html#a696d2f32aae35319a538834436a6b873">setParameters</a> (in string device, in <a class="el" href="interfacetest_1_1Ethernet.html#a7068d47affdfd12830387cffcb2565e7">Speed</a> speed, in <a class="el" href="interfacetest_1_1Ethernet.html#a98b12f5c2d49d98357afcfd444a4a292">Duplex</a> duplex, in boolean isAutoNeg)</td></tr>
<tr class="memdesc:a696d2f32aae35319a538834436a6b873"><td class="mdescLeft">&#160;</td><td class="mdescRight">transiently sets the interface to the desired parameters  <a href="#a696d2f32aae35319a538834436a6b873">More...</a><br /></td></tr>
<tr class="separator:a696d2f32aae35319a538834436a6b873"><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>test routines for RJ45 <a class="el" href="interfacetest_1_1Ethernet.html" title="test routines for RJ45 Ethernet port This is low level interface using ethtool that does not persist ...">Ethernet</a> port This is low level interface using ethtool that does not persist any of the settings made (TODO: this interface may be combined with a 'decent' network interface. </p>
<p>Currently the network interface is dedicated to special use cases) </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a98b12f5c2d49d98357afcfd444a4a292"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a98b12f5c2d49d98357afcfd444a4a292">&#9670;&nbsp;</a></span>Duplex</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="interfacetest_1_1Ethernet.html#a98b12f5c2d49d98357afcfd444a4a292">test::Ethernet::Duplex</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><a class="el" href="interfacetest_1_1Ethernet.html" title="test routines for RJ45 Ethernet port This is low level interface using ethtool that does not persist ...">Ethernet</a> Duplex Mode. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a98b12f5c2d49d98357afcfd444a4a292a8fae1d3bdaa768f075e516ae7eeff454"></a>DPX_HALF&#160;</td><td class="fielddoc"><p>Half Duplex. </p>
</td></tr>
<tr><td class="fieldname"><a id="a98b12f5c2d49d98357afcfd444a4a292a9f328663b012e5ee2aa348c198b914e8"></a>DPX_FULL&#160;</td><td class="fielddoc"><p>Full Duplex. </p>
</td></tr>
</table>

</div>
</div>
<a id="a7068d47affdfd12830387cffcb2565e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7068d47affdfd12830387cffcb2565e7">&#9670;&nbsp;</a></span>Speed</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="interfacetest_1_1Ethernet.html#a7068d47affdfd12830387cffcb2565e7">test::Ethernet::Speed</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><a class="el" href="interfacetest_1_1Ethernet.html" title="test routines for RJ45 Ethernet port This is low level interface using ethtool that does not persist ...">Ethernet</a> Speed. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a7068d47affdfd12830387cffcb2565e7a0b0effddf634c8fc1f4dc3ab4c4526a5"></a>SPD_10&#160;</td><td class="fielddoc"><p>10 Mbit/s </p>
</td></tr>
<tr><td class="fieldname"><a id="a7068d47affdfd12830387cffcb2565e7a2eee97cd117ac0635c4ea8a15a8716c3"></a>SPD_100&#160;</td><td class="fielddoc"><p>100 Mbit/s </p>
</td></tr>
<tr><td class="fieldname"><a id="a7068d47affdfd12830387cffcb2565e7a6cb2bff22a262ceee314aba0361bd696"></a>SPD_1000&#160;</td><td class="fielddoc"><p>1 Gbit/s </p>
</td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a696d2f32aae35319a538834436a6b873"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a696d2f32aae35319a538834436a6b873">&#9670;&nbsp;</a></span>setParameters()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int test::Ethernet::setParameters </td>
          <td>(</td>
          <td class="paramtype">in string&#160;</td>
          <td class="paramname"><em>device</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">in <a class="el" href="interfacetest_1_1Ethernet.html#a7068d47affdfd12830387cffcb2565e7">Speed</a>&#160;</td>
          <td class="paramname"><em>speed</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">in <a class="el" href="interfacetest_1_1Ethernet.html#a98b12f5c2d49d98357afcfd444a4a292">Duplex</a>&#160;</td>
          <td class="paramname"><em>duplex</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">in boolean&#160;</td>
          <td class="paramname"><em>isAutoNeg</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>transiently sets the interface to the desired parameters </p>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </dd>
<dd>
1 if invalid param </dd>
<dd>
2 if system error executing operation </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="testrpc_8idl_source.html">testrpc.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>