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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
|
<!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: serial::AnalogModem 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&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="namespaceserial.html">serial</a></li><li class="navelem"><a class="el" href="interfaceserial_1_1AnalogModem.html">AnalogModem</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="interfaceserial_1_1AnalogModem-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">serial::AnalogModem Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Interface for communication with an analog modem attached to a serial port.
<a href="interfaceserial_1_1AnalogModem.html#details">More...</a></p>
<p><code>import"<a class="el" href="AnalogModem_8idl_source.html">AnalogModem.idl</a>";</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structserial_1_1AnalogModem_1_1Settings.html">Settings</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </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:aeec3fe0feb4309d5b6ea83fa4ee85038"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structserial_1_1AnalogModem_1_1Settings.html">Settings</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1AnalogModem.html#aeec3fe0feb4309d5b6ea83fa4ee85038">getSettings</a> ()</td></tr>
<tr class="memdesc:aeec3fe0feb4309d5b6ea83fa4ee85038"><td class="mdescLeft"> </td><td class="mdescRight">Get modem settings. <a href="#aeec3fe0feb4309d5b6ea83fa4ee85038">More...</a><br /></td></tr>
<tr class="separator:aeec3fe0feb4309d5b6ea83fa4ee85038"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae9d72609a28bef98e96bfa5ff1c7a9c7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1AnalogModem.html#ae9d72609a28bef98e96bfa5ff1c7a9c7">setSettings</a> (in <a class="el" href="structserial_1_1AnalogModem_1_1Settings.html">Settings</a> settings)</td></tr>
<tr class="memdesc:ae9d72609a28bef98e96bfa5ff1c7a9c7"><td class="mdescLeft"> </td><td class="mdescRight">Set modem settings. <a href="#ae9d72609a28bef98e96bfa5ff1c7a9c7">More...</a><br /></td></tr>
<tr class="separator:ae9d72609a28bef98e96bfa5ff1c7a9c7"><td class="memSeparator" colspan="2"> </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:ac14e34315811cd2021bcfad1e7045016"><td class="memItemLeft" align="right" valign="top">constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1AnalogModem.html#ac14e34315811cd2021bcfad1e7045016">SUCCESS</a> = 0</td></tr>
<tr class="memdesc:ac14e34315811cd2021bcfad1e7045016"><td class="mdescLeft"> </td><td class="mdescRight">Error codes. <a href="#ac14e34315811cd2021bcfad1e7045016">More...</a><br /></td></tr>
<tr class="separator:ac14e34315811cd2021bcfad1e7045016"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a04161b7ec04937bc1a0d31950ee87834"><td class="memItemLeft" align="right" valign="top"><a id="a04161b7ec04937bc1a0d31950ee87834"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1AnalogModem.html#a04161b7ec04937bc1a0d31950ee87834">ERR_INVALID_VALUE</a> = 1</td></tr>
<tr class="memdesc:a04161b7ec04937bc1a0d31950ee87834"><td class="mdescLeft"> </td><td class="mdescRight">Invalid argument. <br /></td></tr>
<tr class="separator:a04161b7ec04937bc1a0d31950ee87834"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa9b5cf048bdc69a8dc320404e027b950"><td class="memItemLeft" align="right" valign="top">valueobject </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1AnalogModem.html#aa9b5cf048bdc69a8dc320404e027b950">DialInEvent</a>: <a class="el" href="namespaceidl.html#accbdf35b0c02d64ce223e912fc2b246f">idl::Event</a> { string number</td></tr>
<tr class="memdesc:aa9b5cf048bdc69a8dc320404e027b950"><td class="mdescLeft"> </td><td class="mdescRight">Dial-in event. <a href="#aa9b5cf048bdc69a8dc320404e027b950">More...</a><br /></td></tr>
<tr class="separator:aa9b5cf048bdc69a8dc320404e027b950"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aea299c9c01e3fb62f08d1251dafb47b0"><td class="memItemLeft" align="right" valign="top"><a id="aea299c9c01e3fb62f08d1251dafb47b0"></a>
valueobject </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1AnalogModem.html#aea299c9c01e3fb62f08d1251dafb47b0">CallReceivedEvent</a>: <a class="el" href="interfaceserial_1_1AnalogModem.html#aa9b5cf048bdc69a8dc320404e027b950">DialInEvent</a> { }</td></tr>
<tr class="memdesc:aea299c9c01e3fb62f08d1251dafb47b0"><td class="mdescLeft"> </td><td class="mdescRight">An event that's emitted when a dial-in call was answered. <br /></td></tr>
<tr class="separator:aea299c9c01e3fb62f08d1251dafb47b0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1f21023d30606987df6e4db7f30b8d16"><td class="memItemLeft" align="right" valign="top">valueobject </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1AnalogModem.html#a1f21023d30606987df6e4db7f30b8d16">CallEndedEvent</a>: <a class="el" href="interfaceserial_1_1AnalogModem.html#aa9b5cf048bdc69a8dc320404e027b950">DialInEvent</a> { boolean disconnectedRemotely</td></tr>
<tr class="memdesc:a1f21023d30606987df6e4db7f30b8d16"><td class="mdescLeft"> </td><td class="mdescRight">An event that's emitted when a dial-in call was hung up. <a href="#a1f21023d30606987df6e4db7f30b8d16">More...</a><br /></td></tr>
<tr class="separator:a1f21023d30606987df6e4db7f30b8d16"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Interface for communication with an analog modem attached to a serial port. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="aeec3fe0feb4309d5b6ea83fa4ee85038"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeec3fe0feb4309d5b6ea83fa4ee85038">◆ </a></span>getSettings()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structserial_1_1AnalogModem_1_1Settings.html">Settings</a> serial::AnalogModem::getSettings </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get modem settings. </p>
<dl class="section return"><dt>Returns</dt><dd>– Current modem settings </dd></dl>
</div>
</div>
<a id="ae9d72609a28bef98e96bfa5ff1c7a9c7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae9d72609a28bef98e96bfa5ff1c7a9c7">◆ </a></span>setSettings()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int serial::AnalogModem::setSettings </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="structserial_1_1AnalogModem_1_1Settings.html">Settings</a> </td>
<td class="paramname"><em>settings</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set modem settings. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">settings</td><td>– New settings</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SUCCESS – on success </dd>
<dd>
ERR_INVALID_VALUE – if any passed value was invalid </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a1f21023d30606987df6e4db7f30b8d16"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1f21023d30606987df6e4db7f30b8d16">◆ </a></span>CallEndedEvent</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">valueobject serial::AnalogModem::CallEndedEvent</td>
</tr>
</table>
</div><div class="memdoc">
<p>An event that's emitted when a dial-in call was hung up. </p>
<p>If true, the call was disconnected by the caller If false, the call was disconnected locally, e.g. due to a connection failure </p>
</div>
</div>
<a id="aa9b5cf048bdc69a8dc320404e027b950"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa9b5cf048bdc69a8dc320404e027b950">◆ </a></span>DialInEvent</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">valueobject serial::AnalogModem::DialInEvent</td>
</tr>
</table>
</div><div class="memdoc">
<p>Dial-in event. </p>
<p>The caller's phone number </p>
</div>
</div>
<a id="ac14e34315811cd2021bcfad1e7045016"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac14e34315811cd2021bcfad1e7045016">◆ </a></span>SUCCESS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">constant int serial::AnalogModem::SUCCESS = 0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Error codes. </p>
<p>No error </p>
</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="AnalogModem_8idl_source.html">AnalogModem.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  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
|
