Sophie

Sophie

distrib > Mandriva > 2010.2 > i586 > by-pkgid > def0228095a1541e2d3632b6b6da7c38 > files > 976

gnuradio-doc-3.3.0-8mdv2010.1.i586.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.3.0 C++ API: fusb_ephandle_win32 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.3 -->
<div class="contents">
<h1>fusb_ephandle_win32 Class Reference</h1><!-- doxytag: class="fusb_ephandle_win32" --><!-- doxytag: inherits="fusb_ephandle" -->
<p>win32 implementation of <a class="el" href="classfusb__ephandle.html" title="abstract usb end point handle">fusb_ephandle</a> using libusb-win32  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="fusb__win32_8h_source.html">fusb_win32.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for fusb_ephandle_win32:</div>
<div class="dynsection">
<div class="center"><img src="classfusb__ephandle__win32__inherit__graph.png" border="0" usemap="#fusb__ephandle__win32_inherit__map" alt="Inheritance graph"/></div>
<map name="fusb__ephandle__win32_inherit__map" id="fusb__ephandle__win32_inherit__map">
<area shape="rect" id="node2" href="classfusb__ephandle.html" title="abstract usb end point handle" alt="" coords="25,5,132,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classfusb__ephandle__win32-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="classfusb__ephandle__win32.html#a7b96c50d3f5237716fb982870d7981b1">fusb_ephandle_win32</a> (<a class="el" href="classfusb__devhandle__win32.html">fusb_devhandle_win32</a> *dh, int endpoint, <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> input_p, int block_size=0, int nblocks=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle__win32.html#a64b21b0c9ff7b261bcca8561c43bb42c">~fusb_ephandle_win32</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle__win32.html#a6528a238f3f19d84d4dd2e7d0a9a8de3">start</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">begin streaming i/o  <a href="#a6528a238f3f19d84d4dd2e7d0a9a8de3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle__win32.html#a1a26fbc871834e3730789b8575d3714b">stop</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">stop streaming i/o  <a href="#a1a26fbc871834e3730789b8575d3714b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle__win32.html#a2b4d0892ae085ae52a005ccec3efaab6">write</a> (const void *buffer, int nbytes)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle__win32.html#a2189b5c79aab4f36c779242f22589368">read</a> (void *buffer, int nbytes)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle__win32.html#a385c96d5f778ac688af634ca999b1fa3">wait_for_completion</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>win32 implementation of <a class="el" href="classfusb__ephandle.html" title="abstract usb end point handle">fusb_ephandle</a> using libusb-win32 </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a7b96c50d3f5237716fb982870d7981b1"></a><!-- doxytag: member="fusb_ephandle_win32::fusb_ephandle_win32" ref="a7b96c50d3f5237716fb982870d7981b1" args="(fusb_devhandle_win32 *dh, int endpoint, bool input_p, int block_size=0, int nblocks=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">fusb_ephandle_win32::fusb_ephandle_win32 </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classfusb__devhandle__win32.html">fusb_devhandle_win32</a> *&nbsp;</td>
          <td class="paramname"> <em>dh</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>endpoint</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a>&nbsp;</td>
          <td class="paramname"> <em>input_p</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>block_size</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>nblocks</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a64b21b0c9ff7b261bcca8561c43bb42c"></a><!-- doxytag: member="fusb_ephandle_win32::~fusb_ephandle_win32" ref="a64b21b0c9ff7b261bcca8561c43bb42c" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual fusb_ephandle_win32::~fusb_ephandle_win32 </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a2189b5c79aab4f36c779242f22589368"></a><!-- doxytag: member="fusb_ephandle_win32::read" ref="a2189b5c79aab4f36c779242f22589368" args="(void *buffer, int nbytes)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int fusb_ephandle_win32::read </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">int&nbsp;</td>
          <td class="paramname"> <em>nbytes</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>number of bytes read or -1 if error. number of bytes read will be &lt;= nbytes. Will block if no input available. </dd></dl>

<p>Implements <a class="el" href="classfusb__ephandle.html#a835533e974fb159174c44f2ec0d5668d">fusb_ephandle</a>.</p>

</div>
</div>
<a class="anchor" id="a6528a238f3f19d84d4dd2e7d0a9a8de3"></a><!-- doxytag: member="fusb_ephandle_win32::start" ref="a6528a238f3f19d84d4dd2e7d0a9a8de3" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> fusb_ephandle_win32::start </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>begin streaming i/o </p>

<p>Implements <a class="el" href="classfusb__ephandle.html#aac0498804e009ab78c47f2265f34a054">fusb_ephandle</a>.</p>

</div>
</div>
<a class="anchor" id="a1a26fbc871834e3730789b8575d3714b"></a><!-- doxytag: member="fusb_ephandle_win32::stop" ref="a1a26fbc871834e3730789b8575d3714b" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> fusb_ephandle_win32::stop </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>stop streaming i/o </p>

<p>Implements <a class="el" href="classfusb__ephandle.html#a3cfe2cbb78870a6ce0ec8f696ebe45ab">fusb_ephandle</a>.</p>

</div>
</div>
<a class="anchor" id="a385c96d5f778ac688af634ca999b1fa3"></a><!-- doxytag: member="fusb_ephandle_win32::wait_for_completion" ref="a385c96d5f778ac688af634ca999b1fa3" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void fusb_ephandle_win32::wait_for_completion </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Implements <a class="el" href="classfusb__ephandle.html#a1e1a2c7173a14aea99686fad7c0e061c">fusb_ephandle</a>.</p>

</div>
</div>
<a class="anchor" id="a2b4d0892ae085ae52a005ccec3efaab6"></a><!-- doxytag: member="fusb_ephandle_win32::write" ref="a2b4d0892ae085ae52a005ccec3efaab6" args="(const void *buffer, int nbytes)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int fusb_ephandle_win32::write </td>
          <td>(</td>
          <td class="paramtype">const void *&nbsp;</td>
          <td class="paramname"> <em>buffer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>nbytes</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd><code>nbytes</code> if write was successfully enqueued, else -1. Will block if no free buffers available. </dd></dl>

<p>Implements <a class="el" href="classfusb__ephandle.html#ab2a965c0f5fea6632bc08ea59c8c8fe1">fusb_ephandle</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="fusb__win32_8h_source.html">fusb_win32.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Dec 29 19:52:36 2010 for GNU Radio 3.3.0 C++ API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>