<!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.8"/> <title>UHD: include/uhd/transport/nirio/rpc/usrprio_rpc_client.hpp 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/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </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 style="padding-left: 0.5em;"> <div id="projectname">UHD  <span id="projectnumber">003.007.002-0-unknown</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.8 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>File Members</span></a></li> </ul> </div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Macros</a></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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_9b536c30bc5a9db2084d75e9c271ba6f.html">uhd</a></li><li class="navelem"><a class="el" href="dir_72c1d58d372b837697c1167a99ca9c7a.html">transport</a></li><li class="navelem"><a class="el" href="dir_be2297a73b52af268c2bf69bdd7f76c4.html">nirio</a></li><li class="navelem"><a class="el" href="dir_a1fc8044cb879c193ef51c2be1b09e78.html">rpc</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">usrprio_rpc_client.hpp</div> </div> </div><!--header--> <div class="contents"> <a href="usrprio__rpc__client_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// Copyright 2013 Ettus Research LLC</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">//</span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// This program is free software: you can redistribute it and/or modify</span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// it under the terms of the GNU General Public License as published by</span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// the Free Software Foundation, either version 3 of the License, or</span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// (at your option) any later version.</span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">//</span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// This program is distributed in the hope that it will be useful,</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// GNU General Public License for more details.</span></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">// You should have received a copy of the GNU General Public License</span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// along with this program. If not, see <http://www.gnu.org/licenses/>.</span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">//</span></div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#ifndef INCLUDED_USRPRIO_RPC_CLIENT_HPP</span></div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#define INCLUDED_USRPRIO_RPC_CLIENT_HPP</span></div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <<a class="code" href="rpc__common_8hpp.html">uhd/transport/nirio/rpc/rpc_common.hpp</a>></span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <<a class="code" href="rpc__client_8hpp.html">uhd/transport/nirio/rpc/rpc_client.hpp</a>></span></div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <<a class="code" href="usrprio__rpc__common_8hpp.html">uhd/transport/nirio/rpc/usrprio_rpc_common.hpp</a>></span></div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <uhd/transport/nirio/status.h></span></div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">namespace </span><a class="code" href="namespaceuhd.html">uhd</a> { <span class="keyword">namespace </span>usrprio_rpc {</div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div> <div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="classuhd_1_1usrprio__rpc_1_1usrprio__rpc__client.html"> 28</a></span> <span class="keyword">class </span><a class="code" href="config_8hpp.html#adc68e1c030efb88af856decedf19aedf">UHD_API</a> <a class="code" href="classuhd_1_1usrprio__rpc_1_1usrprio__rpc__client.html">usrprio_rpc_client</a> {</div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">public</span>:</div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <a class="code" href="classuhd_1_1usrprio__rpc_1_1usrprio__rpc__client.html">usrprio_rpc_client</a>(</div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  std::string server,</div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  std::string port);</div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  ~<a class="code" href="classuhd_1_1usrprio__rpc_1_1usrprio__rpc__client.html">usrprio_rpc_client</a>();</div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div> <div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classuhd_1_1usrprio__rpc_1_1usrprio__rpc__client.html#a5818892b557b65b7dd51c79ff7d356db"> 35</a></span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classuhd_1_1usrprio__rpc_1_1usrprio__rpc__client.html#a5818892b557b65b7dd51c79ff7d356db">set_rpc_timeout</a>(boost::posix_time::milliseconds timeout_in_ms) {</div> <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  _timeout = timeout_in_ms;</div> <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  }</div> <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div> <div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classuhd_1_1usrprio__rpc_1_1usrprio__rpc__client.html#a7d089f9e44d362b8cccabfbcaea2f30b"> 39</a></span>  <span class="keyword">inline</span> nirio_status <a class="code" href="classuhd_1_1usrprio__rpc_1_1usrprio__rpc__client.html#a7d089f9e44d362b8cccabfbcaea2f30b">get_ctor_status</a>() {</div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordflow">return</span> _ctor_status;</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> </div> <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  nirio_status niusrprio_enumerate(</div> <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a class="code" href="usrprio__rpc__common_8hpp.html#a9ab9e9c7052695948b565f2e8b8b89a2">NIUSRPRIO_ENUMERATE_ARGS</a>);</div> <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  nirio_status niusrprio_open_session(</div> <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <a class="code" href="usrprio__rpc__common_8hpp.html#a90ec836b6c2a5846e4aa4389d2b14f4c">NIUSRPRIO_OPEN_SESSION_ARGS</a>);</div> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  nirio_status niusrprio_close_session(</div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <a class="code" href="usrprio__rpc__common_8hpp.html#afd34843173d5156d5e0e671e3732af77">NIUSRPRIO_CLOSE_SESSION_ARGS</a>);</div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  nirio_status niusrprio_reset_device(</div> <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <a class="code" href="usrprio__rpc__common_8hpp.html#a15221974babd6f99842f0bf6831c678c">NIUSRPRIO_RESET_SESSION_ARGS</a>);</div> <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  nirio_status niusrprio_download_bitstream_to_fpga(</div> <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <a class="code" href="usrprio__rpc__common_8hpp.html#a3c3aaa06a1834dba9c6b358cd2eaf1a0">NIUSRPRIO_DOWNLOAD_BITSTREAM_TO_FPGA_ARGS</a>);</div> <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  nirio_status niusrprio_get_interface_path(</div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <a class="code" href="usrprio__rpc__common_8hpp.html#a57894e3db008d346fb3119b006f11de7">NIUSRPRIO_GET_INTERFACE_PATH_ARGS</a>);</div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  nirio_status niusrprio_download_fpga_to_flash(</div> <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <a class="code" href="usrprio__rpc__common_8hpp.html#ad3b19dec42bad107af078b971f0e7145">NIUSRPRIO_DOWNLOAD_FPGA_TO_FLASH_ARGS</a>);</div> <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div> <div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="classuhd_1_1usrprio__rpc_1_1usrprio__rpc__client.html#a348bda1adde9b2746dc09a216f684bb8"> 58</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> boost::int64_t DEFAULT_TIMEOUT_IN_MS = 5000;</div> <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="keyword">private</span>:</div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">static</span> nirio_status _boost_error_to_nirio_status(<span class="keyword">const</span> boost::system::error_code& err);</div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <a class="code" href="classuhd_1_1usrprio__rpc_1_1rpc__client.html">rpc_client</a> _rpc_client;</div> <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  boost::posix_time::milliseconds _timeout;</div> <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  nirio_status _ctor_status;</div> <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> };</div> <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </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> <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_USRPRIO_RPC_CLIENT_HPP */</span><span class="preprocessor"></span></div> <div class="ttc" id="classuhd_1_1usrprio__rpc_1_1rpc__client_html"><div class="ttname"><a href="classuhd_1_1usrprio__rpc_1_1rpc__client.html">uhd::usrprio_rpc::rpc_client</a></div><div class="ttdef"><b>Definition:</b> rpc_client.hpp:30</div></div> <div class="ttc" id="usrprio__rpc__common_8hpp_html_ad3b19dec42bad107af078b971f0e7145"><div class="ttname"><a href="usrprio__rpc__common_8hpp.html#ad3b19dec42bad107af078b971f0e7145">NIUSRPRIO_DOWNLOAD_FPGA_TO_FLASH_ARGS</a></div><div class="ttdeci">#define NIUSRPRIO_DOWNLOAD_FPGA_TO_FLASH_ARGS</div><div class="ttdef"><b>Definition:</b> usrprio_rpc_common.hpp:80</div></div> <div class="ttc" id="usrprio__rpc__common_8hpp_html_a90ec836b6c2a5846e4aa4389d2b14f4c"><div class="ttname"><a href="usrprio__rpc__common_8hpp.html#a90ec836b6c2a5846e4aa4389d2b14f4c">NIUSRPRIO_OPEN_SESSION_ARGS</a></div><div class="ttdeci">#define NIUSRPRIO_OPEN_SESSION_ARGS</div><div class="ttdef"><b>Definition:</b> usrprio_rpc_common.hpp:61</div></div> <div class="ttc" id="usrprio__rpc__common_8hpp_html"><div class="ttname"><a href="usrprio__rpc__common_8hpp.html">usrprio_rpc_common.hpp</a></div></div> <div class="ttc" id="classuhd_1_1usrprio__rpc_1_1usrprio__rpc__client_html_a7d089f9e44d362b8cccabfbcaea2f30b"><div class="ttname"><a href="classuhd_1_1usrprio__rpc_1_1usrprio__rpc__client.html#a7d089f9e44d362b8cccabfbcaea2f30b">uhd::usrprio_rpc::usrprio_rpc_client::get_ctor_status</a></div><div class="ttdeci">nirio_status get_ctor_status()</div><div class="ttdef"><b>Definition:</b> usrprio_rpc_client.hpp:39</div></div> <div class="ttc" id="config_8hpp_html_adc68e1c030efb88af856decedf19aedf"><div class="ttname"><a href="config_8hpp.html#adc68e1c030efb88af856decedf19aedf">UHD_API</a></div><div class="ttdeci">#define UHD_API</div><div class="ttdef"><b>Definition:</b> config.hpp:79</div></div> <div class="ttc" id="namespaceuhd_html"><div class="ttname"><a href="namespaceuhd.html">uhd</a></div><div class="ttdef"><b>Definition:</b> convert.hpp:28</div></div> <div class="ttc" id="usrprio__rpc__common_8hpp_html_a3c3aaa06a1834dba9c6b358cd2eaf1a0"><div class="ttname"><a href="usrprio__rpc__common_8hpp.html#a3c3aaa06a1834dba9c6b358cd2eaf1a0">NIUSRPRIO_DOWNLOAD_BITSTREAM_TO_FPGA_ARGS</a></div><div class="ttdeci">#define NIUSRPRIO_DOWNLOAD_BITSTREAM_TO_FPGA_ARGS</div><div class="ttdef"><b>Definition:</b> usrprio_rpc_common.hpp:73</div></div> <div class="ttc" id="rpc__client_8hpp_html"><div class="ttname"><a href="rpc__client_8hpp.html">rpc_client.hpp</a></div></div> <div class="ttc" id="usrprio__rpc__common_8hpp_html_a15221974babd6f99842f0bf6831c678c"><div class="ttname"><a href="usrprio__rpc__common_8hpp.html#a15221974babd6f99842f0bf6831c678c">NIUSRPRIO_RESET_SESSION_ARGS</a></div><div class="ttdeci">#define NIUSRPRIO_RESET_SESSION_ARGS</div><div class="ttdef"><b>Definition:</b> usrprio_rpc_common.hpp:70</div></div> <div class="ttc" id="rpc__common_8hpp_html"><div class="ttname"><a href="rpc__common_8hpp.html">rpc_common.hpp</a></div></div> <div class="ttc" id="classuhd_1_1usrprio__rpc_1_1usrprio__rpc__client_html_a5818892b557b65b7dd51c79ff7d356db"><div class="ttname"><a href="classuhd_1_1usrprio__rpc_1_1usrprio__rpc__client.html#a5818892b557b65b7dd51c79ff7d356db">uhd::usrprio_rpc::usrprio_rpc_client::set_rpc_timeout</a></div><div class="ttdeci">void set_rpc_timeout(boost::posix_time::milliseconds timeout_in_ms)</div><div class="ttdef"><b>Definition:</b> usrprio_rpc_client.hpp:35</div></div> <div class="ttc" id="usrprio__rpc__common_8hpp_html_afd34843173d5156d5e0e671e3732af77"><div class="ttname"><a href="usrprio__rpc__common_8hpp.html#afd34843173d5156d5e0e671e3732af77">NIUSRPRIO_CLOSE_SESSION_ARGS</a></div><div class="ttdeci">#define NIUSRPRIO_CLOSE_SESSION_ARGS</div><div class="ttdef"><b>Definition:</b> usrprio_rpc_common.hpp:67</div></div> <div class="ttc" id="usrprio__rpc__common_8hpp_html_a57894e3db008d346fb3119b006f11de7"><div class="ttname"><a href="usrprio__rpc__common_8hpp.html#a57894e3db008d346fb3119b006f11de7">NIUSRPRIO_GET_INTERFACE_PATH_ARGS</a></div><div class="ttdeci">#define NIUSRPRIO_GET_INTERFACE_PATH_ARGS</div><div class="ttdef"><b>Definition:</b> usrprio_rpc_common.hpp:76</div></div> <div class="ttc" id="classuhd_1_1usrprio__rpc_1_1usrprio__rpc__client_html"><div class="ttname"><a href="classuhd_1_1usrprio__rpc_1_1usrprio__rpc__client.html">uhd::usrprio_rpc::usrprio_rpc_client</a></div><div class="ttdef"><b>Definition:</b> usrprio_rpc_client.hpp:28</div></div> <div class="ttc" id="usrprio__rpc__common_8hpp_html_a9ab9e9c7052695948b565f2e8b8b89a2"><div class="ttname"><a href="usrprio__rpc__common_8hpp.html#a9ab9e9c7052695948b565f2e8b8b89a2">NIUSRPRIO_ENUMERATE_ARGS</a></div><div class="ttdeci">#define NIUSRPRIO_ENUMERATE_ARGS</div><div class="ttdef"><b>Definition:</b> usrprio_rpc_common.hpp:58</div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Wed Oct 15 2014 11:47:53 for UHD by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.8 </small></address> </body> </html>