Sophie

Sophie

distrib > Fedora > 13 > x86_64 > by-pkgid > ae19f57cd4e306abd5716199a310070b > files > 2922

gnuradio-doc-3.2.2-3.fc13.x86_64.rpm

<!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"/>
<title>GNU Radio 3.2.2 C++ API: usrp2::pending_reply Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2 -->
  <div class="navpath"><b>usrp2</b>::<a class="el" href="classusrp2_1_1pending__reply.html">pending_reply</a>
  </div>
<div class="contents">
<h1>usrp2::pending_reply Class Reference</h1><!-- doxytag: class="usrp2::pending_reply" -->
<p><code>#include &lt;<a class="el" href="control_8h_source.html">control.h</a>&gt;</code></p>

<p><a href="classusrp2_1_1pending__reply-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classusrp2_1_1pending__reply.html#a8c3e31a0f94a87ef117904df195334f3">pending_reply</a> (unsigned int rid, void *buffer, size_t len)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classusrp2_1_1pending__reply.html#abdb19d21bab42e409d8e96f76088d477">~pending_reply</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classusrp2_1_1pending__reply.html#a414a1e44d4dd36a6c3669afcfde754f6">wait</a> (double secs)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classusrp2_1_1pending__reply.html#a7710c2bd1dbc8db9951c5d821b7f4f7b">signal</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classusrp2_1_1pending__reply.html#a8e2d214a13ec207cb47cfecb0ceff1b4">rid</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classusrp2_1_1pending__reply.html#a859e3b9e286eab8aa27c846832616149">buffer</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classusrp2_1_1pending__reply.html#a477d193bace79353d2fe4c4afbe45d8b">len</a> () const </td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Control mechanism to allow API calls to block waiting for reply packets </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a8c3e31a0f94a87ef117904df195334f3"></a><!-- doxytag: member="usrp2::pending_reply::pending_reply" ref="a8c3e31a0f94a87ef117904df195334f3" args="(unsigned int rid, void *buffer, size_t len)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">usrp2::pending_reply::pending_reply </td>
          <td>(</td>
          <td class="paramtype">unsigned int&nbsp;</td>
          <td class="paramname"> <em>rid</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&nbsp;</td>
          <td class="paramname"> <em>buffer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>len</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Construct a pending reply from the reply ID, response packet buffer, and buffer length. </p>

</div>
</div>
<a class="anchor" id="abdb19d21bab42e409d8e96f76088d477"></a><!-- doxytag: member="usrp2::pending_reply::~pending_reply" ref="abdb19d21bab42e409d8e96f76088d477" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">usrp2::pending_reply::~pending_reply </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Destructor. Signals creating thread. </p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a859e3b9e286eab8aa27c846832616149"></a><!-- doxytag: member="usrp2::pending_reply::buffer" ref="a859e3b9e286eab8aa27c846832616149" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void* usrp2::pending_reply::buffer </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Retrieve destination buffer address </p>

</div>
</div>
<a class="anchor" id="a477d193bace79353d2fe4c4afbe45d8b"></a><!-- doxytag: member="usrp2::pending_reply::len" ref="a477d193bace79353d2fe4c4afbe45d8b" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t usrp2::pending_reply::len </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Retrieve destination buffer length </p>

</div>
</div>
<a class="anchor" id="a8e2d214a13ec207cb47cfecb0ceff1b4"></a><!-- doxytag: member="usrp2::pending_reply::rid" ref="a8e2d214a13ec207cb47cfecb0ceff1b4" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned int usrp2::pending_reply::rid </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Retrieve pending reply ID </p>

</div>
</div>
<a class="anchor" id="a7710c2bd1dbc8db9951c5d821b7f4f7b"></a><!-- doxytag: member="usrp2::pending_reply::signal" ref="a7710c2bd1dbc8db9951c5d821b7f4f7b" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void usrp2::pending_reply::signal </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Allows creating thread to resume after copying reply into buffer </p>

</div>
</div>
<a class="anchor" id="a414a1e44d4dd36a6c3669afcfde754f6"></a><!-- doxytag: member="usrp2::pending_reply::wait" ref="a414a1e44d4dd36a6c3669afcfde754f6" args="(double secs)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int usrp2::pending_reply::wait </td>
          <td>(</td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>secs</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Block, waiting for reply packet. Returns: 1 = ok, reply packet in buffer 0 = timeout </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="control_8h_source.html">control.h</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>