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
|
<!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/AnalogModem.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">AnalogModem.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 2013 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 __ANALOGMODEM_IDL__</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#define __ANALOGMODEM_IDL__</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include <Event.idl></span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"></span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">/** Serial Ports */</span></div><div class="line"><a name="l00012"></a><span class="lineno"><a class="line" href="namespaceserial.html"> 12</a></span> module <a class="code" href="namespaceserial.html">serial</a> {</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"></span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> /**</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * Interface for communication with an analog modem attached</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * to a serial port</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"><a class="line" href="interfaceserial_1_1AnalogModem.html"> 18</a></span>  <span class="keyword">interface </span><a class="code" href="interfaceserial_1_1AnalogModem.html">AnalogModem</a> {<span class="comment"></span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> /**</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * Error codes</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> */</span></div><div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="interfaceserial_1_1AnalogModem.html#ac14e34315811cd2021bcfad1e7045016"> 22</a></span>  constant <span class="keywordtype">int</span> SUCCESS = 0; <span class="comment">///< No error</span></div><div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="interfaceserial_1_1AnalogModem.html#a04161b7ec04937bc1a0d31950ee87834"> 23</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_INVALID_VALUE = 1; <span class="comment">///< Invalid argument</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"></span></div><div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="structserial_1_1AnalogModem_1_1Settings.html"> 25</a></span>  structure <a class="code" href="structserial_1_1AnalogModem_1_1Settings.html">Settings</a> {</div><div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="structserial_1_1AnalogModem_1_1Settings.html#af8e900d1ccf4d65ab4d7f64c459a292b"> 26</a></span>  <span class="keywordtype">boolean</span> <a class="code" href="structserial_1_1AnalogModem_1_1Settings.html#af8e900d1ccf4d65ab4d7f64c459a292b">dialInEnabled</a>; <span class="comment">///< Whether dial-in to device is enabled </span></div><div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="structserial_1_1AnalogModem_1_1Settings.html#a655ecd82e6ae5298d03d7560a1866127"> 27</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structserial_1_1AnalogModem_1_1Settings.html#a655ecd82e6ae5298d03d7560a1866127">ringsUntilAnswer</a>; <span class="comment">///< Number of rings until incoming call is answered</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"></span> };</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"></span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> /**</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> * Dial-in event</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> */</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  valueobject DialInEvent extends <a class="code" href="namespaceidl.html">idl</a>.Event {</div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="interfaceserial_1_1AnalogModem.html#aa9b5cf048bdc69a8dc320404e027b950"> 34</a></span>  <span class="keywordtype">string</span> number; <span class="comment">///< The caller's phone number</span></div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="interfaceserial_1_1AnalogModem.html#aea299c9c01e3fb62f08d1251dafb47b0"> 35</a></span> <span class="comment"></span> };</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"></span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> /**</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * An event that's emitted when a dial-in call was answered</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>  valueobject CallReceivedEvent extends DialInEvent {</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> <span class="comment"></span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> /**</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> * An event that's emitted when a dial-in call was hung up</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> */</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  valueobject CallEndedEvent extends DialInEvent {</div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="interfaceserial_1_1AnalogModem.html#a1f21023d30606987df6e4db7f30b8d16"> 47</a></span>  <span class="keywordtype">boolean</span> disconnectedRemotely; <span class="comment">///< If true, the call was disconnected by the caller</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"></span><span class="comment"> ///< If false, the call was disconnected locally,</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"></span><span class="comment"> ///< e.g. due to a connection failure</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"></span> };</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"></span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> /**</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> * @brief Get modem settings</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> *</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> * @return -- Current modem settings</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> */</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  Settings getSettings();</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"></span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> /**</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> * @brief Set modem settings</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> *</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> * @param settings -- New settings</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> *</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> * @return SUCCESS -- on success</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> * @return ERR_INVALID_VALUE -- if any passed value was invalid</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> */</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">int</span> setSettings(in Settings settings);</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  };</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> }</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor">#endif </span><span class="comment">/* __ANALOGMODEM_IDL__ */</span><span class="preprocessor"></span></div><div class="ttc" id="structserial_1_1AnalogModem_1_1Settings_html_a655ecd82e6ae5298d03d7560a1866127"><div class="ttname"><a href="structserial_1_1AnalogModem_1_1Settings.html#a655ecd82e6ae5298d03d7560a1866127">serial::AnalogModem::Settings::ringsUntilAnswer</a></div><div class="ttdeci">int ringsUntilAnswer</div><div class="ttdoc">Number of rings until incoming call is answered. </div><div class="ttdef"><b>Definition:</b> AnalogModem.idl:27</div></div>
<div class="ttc" id="interfaceserial_1_1AnalogModem_html"><div class="ttname"><a href="interfaceserial_1_1AnalogModem.html">serial::AnalogModem</a></div><div class="ttdoc">Interface for communication with an analog modem attached to a serial port. </div><div class="ttdef"><b>Definition:</b> AnalogModem.idl:18</div></div>
<div class="ttc" id="namespaceserial_html"><div class="ttname"><a href="namespaceserial.html">serial</a></div><div class="ttdoc">Serial Ports. </div><div class="ttdef"><b>Definition:</b> AnalogModem.idl:12</div></div>
<div class="ttc" id="namespaceidl_html"><div class="ttname"><a href="namespaceidl.html">idl</a></div><div class="ttdoc">Basic IDL definitions. </div><div class="ttdef"><b>Definition:</b> Event.idl:10</div></div>
<div class="ttc" id="structserial_1_1AnalogModem_1_1Settings_html"><div class="ttname"><a href="structserial_1_1AnalogModem_1_1Settings.html">serial::AnalogModem::Settings</a></div><div class="ttdef"><b>Definition:</b> AnalogModem.idl:25</div></div>
<div class="ttc" id="structserial_1_1AnalogModem_1_1Settings_html_af8e900d1ccf4d65ab4d7f64c459a292b"><div class="ttname"><a href="structserial_1_1AnalogModem_1_1Settings.html#af8e900d1ccf4d65ab4d7f64c459a292b">serial::AnalogModem::Settings::dialInEnabled</a></div><div class="ttdeci">boolean dialInEnabled</div><div class="ttdoc">Whether dial-in to device is enabled. </div><div class="ttdef"><b>Definition:</b> AnalogModem.idl:26</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>
|