<!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>Universal Software Radio Peripheral: fusb_ephandle_ra_wb 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="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> </div> <div class="contents"> <h1>fusb_ephandle_ra_wb Class Reference</h1><!-- doxytag: class="fusb_ephandle_ra_wb" --><!-- doxytag: inherits="fusb_ephandle" --> <p>generic implementation of <a class="el" href="classfusb__ephandle.html" title="abstract usb end point handle">fusb_ephandle</a> using only libusb <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="fusb__ra__wb_8h_source.html">fusb_ra_wb.h</a>></code></p> <div class="dynheader"> Inheritance diagram for fusb_ephandle_ra_wb:</div> <div class="dynsection"> <div class="center"><img src="classfusb__ephandle__ra__wb__inherit__graph.png" border="0" usemap="#fusb__ephandle__ra__wb_inherit__map" alt="Inheritance graph"/></div> <map name="fusb__ephandle__ra__wb_inherit__map" id="fusb__ephandle__ra__wb_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 href="graph_legend.html">legend</a>]</span></center></div> <div class="dynheader"> Collaboration diagram for fusb_ephandle_ra_wb:</div> <div class="dynsection"> <div class="center"><img src="classfusb__ephandle__ra__wb__coll__graph.png" border="0" usemap="#fusb__ephandle__ra__wb_coll__map" alt="Collaboration graph"/></div> <map name="fusb__ephandle__ra__wb_coll__map" id="fusb__ephandle__ra__wb_coll__map"> <area shape="rect" id="node2" href="classfusb__ephandle.html" title="abstract usb end point handle" alt="" coords="5,181,112,211"/><area shape="rect" id="node4" href="classfusb__devhandle__ra__wb.html" title="generic implementation of fusb_devhandle using only libusb" alt="" coords="136,181,291,211"/><area shape="rect" id="node6" href="classfusb__devhandle.html" title="abstract usb device handle" alt="" coords="157,101,269,131"/><area shape="rect" id="node8" href="structusb__dev__handle.html" title="usb_dev_handle" alt="" coords="156,5,271,35"/></map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classfusb__ephandle__ra__wb-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle__ra__wb.html#a45fe615379716a663eb9c08f2f0430df">fusb_ephandle_ra_wb</a> (<a class="el" href="classfusb__devhandle__ra__wb.html">fusb_devhandle_ra_wb</a> *dh, int endpoint, bool input_p, int block_size=0, int nblocks=0)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle__ra__wb.html#a32cf3b58c935cfb1ec6527087b511db0">~fusb_ephandle_ra_wb</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle__ra__wb.html#a91f857a0b30c44131a39f09f4b6f0a00">start</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">begin streaming i/o <a href="#a91f857a0b30c44131a39f09f4b6f0a00"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle__ra__wb.html#a0051aeecc7661099f6099cfcf1dfed2c">stop</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">stop streaming i/o <a href="#a0051aeecc7661099f6099cfcf1dfed2c"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle__ra__wb.html#a676dee0f85cd80f6e1832cc815a159c8">write</a> (const void *buffer, int nbytes)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle__ra__wb.html#a7c12de8f49b5ad0c0a3d5a247fc0faa4">read</a> (void *buffer, int nbytes)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle__ra__wb.html#af99aba7bd66cd6d212725b1fed6f18bc">wait_for_completion</a> ()</td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>generic implementation of <a class="el" href="classfusb__ephandle.html" title="abstract usb end point handle">fusb_ephandle</a> using only libusb </p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a45fe615379716a663eb9c08f2f0430df"></a><!-- doxytag: member="fusb_ephandle_ra_wb::fusb_ephandle_ra_wb" ref="a45fe615379716a663eb9c08f2f0430df" args="(fusb_devhandle_ra_wb *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_ra_wb::fusb_ephandle_ra_wb </td> <td>(</td> <td class="paramtype"><a class="el" href="classfusb__devhandle__ra__wb.html">fusb_devhandle_ra_wb</a> * </td> <td class="paramname"> <em>dh</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>endpoint</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>input_p</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>block_size</em> = <code>0</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>nblocks</em> = <code>0</code></td><td> </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="a32cf3b58c935cfb1ec6527087b511db0"></a><!-- doxytag: member="fusb_ephandle_ra_wb::~fusb_ephandle_ra_wb" ref="a32cf3b58c935cfb1ec6527087b511db0" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">fusb_ephandle_ra_wb::~fusb_ephandle_ra_wb </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a7c12de8f49b5ad0c0a3d5a247fc0faa4"></a><!-- doxytag: member="fusb_ephandle_ra_wb::read" ref="a7c12de8f49b5ad0c0a3d5a247fc0faa4" args="(void *buffer, int nbytes)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int fusb_ephandle_ra_wb::read </td> <td>(</td> <td class="paramtype">void * </td> <td class="paramname"> <em>buffer</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>nbytes</em></td><td> </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 <= nbytes. Will block if no input available. </dd></dl> <p>Implements <a class="el" href="classfusb__ephandle.html#a835533e974fb159174c44f2ec0d5668d">fusb_ephandle</a>.</p> <p>References <a class="el" href="fusb_8h_source.html#l00072">fusb_ephandle::d_endpoint</a>, <a class="el" href="fusb_8h_source.html#l00073">fusb_ephandle::d_input_p</a>, <a class="el" href="fusb_8h_source.html#l00076">fusb_ephandle::d_started</a>, and <a class="el" href="fusb_8h_source.html#l00058">fusb_devhandle::get_usb_dev_handle()</a>.</p> <p>Referenced by <a class="el" href="fusb__ra__wb_8cc_source.html#l00114">start()</a>.</p> </div> </div> <a class="anchor" id="a91f857a0b30c44131a39f09f4b6f0a00"></a><!-- doxytag: member="fusb_ephandle_ra_wb::start" ref="a91f857a0b30c44131a39f09f4b6f0a00" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool fusb_ephandle_ra_wb::start </td> <td>(</td> <td class="paramname"></td> <td> ) </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> <p>References <a class="el" href="fusb_8h_source.html#l00074">fusb_ephandle::d_block_size</a>, <a class="el" href="fusb_8h_source.html#l00072">fusb_ephandle::d_endpoint</a>, <a class="el" href="fusb_8h_source.html#l00073">fusb_ephandle::d_input_p</a>, <a class="el" href="fusb_8h_source.html#l00075">fusb_ephandle::d_nblocks</a>, <a class="el" href="fusb_8h_source.html#l00076">fusb_ephandle::d_started</a>, <a class="el" href="fusb_8h_source.html#l00058">fusb_devhandle::get_usb_dev_handle()</a>, <a class="el" href="fusb__ra__wb_8cc_source.html#l00215">read()</a>, and <a class="el" href="fusb__ra__wb_8cc_source.html#l00202">write()</a>.</p> </div> </div> <a class="anchor" id="a0051aeecc7661099f6099cfcf1dfed2c"></a><!-- doxytag: member="fusb_ephandle_ra_wb::stop" ref="a0051aeecc7661099f6099cfcf1dfed2c" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool fusb_ephandle_ra_wb::stop </td> <td>(</td> <td class="paramname"></td> <td> ) </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> <p>References <a class="el" href="fusb_8h_source.html#l00072">fusb_ephandle::d_endpoint</a>, <a class="el" href="fusb_8h_source.html#l00073">fusb_ephandle::d_input_p</a>, <a class="el" href="fusb_8h_source.html#l00076">fusb_ephandle::d_started</a>, and <a class="el" href="fusb_8h_source.html#l00058">fusb_devhandle::get_usb_dev_handle()</a>.</p> </div> </div> <a class="anchor" id="af99aba7bd66cd6d212725b1fed6f18bc"></a><!-- doxytag: member="fusb_ephandle_ra_wb::wait_for_completion" ref="af99aba7bd66cd6d212725b1fed6f18bc" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void fusb_ephandle_ra_wb::wait_for_completion </td> <td>(</td> <td class="paramname"></td> <td> ) </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> <p>References <a class="el" href="fusb_8h_source.html#l00074">fusb_ephandle::d_block_size</a>, <a class="el" href="fusb_8h_source.html#l00072">fusb_ephandle::d_endpoint</a>, <a class="el" href="fusb_8h_source.html#l00073">fusb_ephandle::d_input_p</a>, <a class="el" href="fusb_8h_source.html#l00075">fusb_ephandle::d_nblocks</a>, and <a class="el" href="fusb_8h_source.html#l00058">fusb_devhandle::get_usb_dev_handle()</a>.</p> </div> </div> <a class="anchor" id="a676dee0f85cd80f6e1832cc815a159c8"></a><!-- doxytag: member="fusb_ephandle_ra_wb::write" ref="a676dee0f85cd80f6e1832cc815a159c8" args="(const void *buffer, int nbytes)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int fusb_ephandle_ra_wb::write </td> <td>(</td> <td class="paramtype">const void * </td> <td class="paramname"> <em>buffer</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>nbytes</em></td><td> </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> <p>References <a class="el" href="fusb_8h_source.html#l00072">fusb_ephandle::d_endpoint</a>, <a class="el" href="fusb_8h_source.html#l00073">fusb_ephandle::d_input_p</a>, <a class="el" href="fusb_8h_source.html#l00076">fusb_ephandle::d_started</a>, and <a class="el" href="fusb_8h_source.html#l00058">fusb_devhandle::get_usb_dev_handle()</a>.</p> <p>Referenced by <a class="el" href="fusb__ra__wb_8cc_source.html#l00114">start()</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="fusb__ra__wb_8h_source.html">fusb_ra_wb.h</a></li> <li><a class="el" href="fusb__ra__wb_8cc.html">fusb_ra_wb.cc</a></li> </ul> </div> <hr size="1"/><address style="text-align: right;"><small>Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address> </body> </html>