<!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_generic 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.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Universal Software Radio Peripheral</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<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 id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>fusb_ephandle_generic Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="fusb_ephandle_generic" --><!-- 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__generic_8h_source.html">fusb_generic.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for fusb_ephandle_generic:</div>
<div class="dyncontent">
<div class="center"><img src="classfusb__ephandle__generic__inherit__graph.png" border="0" usemap="#fusb__ephandle__generic_inherit__map" alt="Inheritance graph"/></div>
<map name="fusb__ephandle__generic_inherit__map" id="fusb__ephandle__generic_inherit__map">
<area shape="rect" id="node2" href="classfusb__ephandle.html" title="abstract usb end point handle" alt="" coords="29,5,136,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for fusb_ephandle_generic:</div>
<div class="dyncontent">
<div class="center"><img src="classfusb__ephandle__generic__coll__graph.png" border="0" usemap="#fusb__ephandle__generic_coll__map" alt="Collaboration graph"/></div>
<map name="fusb__ephandle__generic_coll__map" id="fusb__ephandle__generic_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__generic.html" title="generic implementation of fusb_devhandle using only libusb" alt="" coords="136,181,299,211"/><area shape="rect" id="node6" href="classfusb__devhandle.html" title="abstract usb device handle" alt="" coords="161,101,273,131"/><area shape="rect" id="node8" href="structusb__dev__handle.html" title="usb_dev_handle" alt="" coords="160,5,275,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classfusb__ephandle__generic-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
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__generic.html#a830f0afd5a768fef69afaf68c26791f3">fusb_ephandle_generic</a> (<a class="el" href="classfusb__devhandle__generic.html">fusb_devhandle_generic</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__generic.html#a635b17f1e2744b5f4c15aaac8d6f2a91">~fusb_ephandle_generic</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__generic.html#afc2befea2e3b5db48442e941f08598fc">start</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">begin streaming i/o <a href="#afc2befea2e3b5db48442e941f08598fc"></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__generic.html#a6749139e3548f2ea7df88b60b690c920">stop</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">stop streaming i/o <a href="#a6749139e3548f2ea7df88b60b690c920"></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__generic.html#a403c783754e14f4156befe1d15287ef7">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__generic.html#ab70ff883ab176743e989427858d08bd1">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__generic.html#a7a7ef010b4fb8307ba4c6c29c88a020a">wait_for_completion</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>generic implementation of <a class="el" href="classfusb__ephandle.html" title="abstract usb end point handle">fusb_ephandle</a> using only libusb </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a830f0afd5a768fef69afaf68c26791f3"></a><!-- doxytag: member="fusb_ephandle_generic::fusb_ephandle_generic" ref="a830f0afd5a768fef69afaf68c26791f3" args="(fusb_devhandle_generic *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_generic::fusb_ephandle_generic </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classfusb__devhandle__generic.html">fusb_devhandle_generic</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>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a635b17f1e2744b5f4c15aaac8d6f2a91"></a><!-- doxytag: member="fusb_ephandle_generic::~fusb_ephandle_generic" ref="a635b17f1e2744b5f4c15aaac8d6f2a91" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">fusb_ephandle_generic::~fusb_ephandle_generic </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="ab70ff883ab176743e989427858d08bd1"></a><!-- doxytag: member="fusb_ephandle_generic::read" ref="ab70ff883ab176743e989427858d08bd1" args="(void *buffer, int nbytes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fusb_ephandle_generic::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>
</tr>
<tr>
<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="classfusb__ephandle.html#a136e1ab7ba9e180a78ea5085739dd018">fusb_ephandle::d_endpoint</a>, <a class="el" href="classfusb__ephandle.html#a123fcada49a57077500fab084e537643">fusb_ephandle::d_input_p</a>, <a class="el" href="classfusb__ephandle.html#ad6506c0efdf8eea1dcd8df8d65ecc609">fusb_ephandle::d_started</a>, and <a class="el" href="classfusb__devhandle.html#a1efb2b5a5c155cb1cb7843cf9144d6f3">fusb_devhandle::get_usb_dev_handle()</a>.</p>
</div>
</div>
<a class="anchor" id="afc2befea2e3b5db48442e941f08598fc"></a><!-- doxytag: member="fusb_ephandle_generic::start" ref="afc2befea2e3b5db48442e941f08598fc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool fusb_ephandle_generic::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="classfusb__ephandle.html#ad6506c0efdf8eea1dcd8df8d65ecc609">fusb_ephandle::d_started</a>.</p>
</div>
</div>
<a class="anchor" id="a6749139e3548f2ea7df88b60b690c920"></a><!-- doxytag: member="fusb_ephandle_generic::stop" ref="a6749139e3548f2ea7df88b60b690c920" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool fusb_ephandle_generic::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="classfusb__ephandle.html#ad6506c0efdf8eea1dcd8df8d65ecc609">fusb_ephandle::d_started</a>.</p>
</div>
</div>
<a class="anchor" id="a7a7ef010b4fb8307ba4c6c29c88a020a"></a><!-- doxytag: member="fusb_ephandle_generic::wait_for_completion" ref="a7a7ef010b4fb8307ba4c6c29c88a020a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void fusb_ephandle_generic::wait_for_completion </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, 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="a403c783754e14f4156befe1d15287ef7"></a><!-- doxytag: member="fusb_ephandle_generic::write" ref="a403c783754e14f4156befe1d15287ef7" args="(const void *buffer, int nbytes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fusb_ephandle_generic::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>
</tr>
<tr>
<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="classfusb__ephandle.html#a136e1ab7ba9e180a78ea5085739dd018">fusb_ephandle::d_endpoint</a>, <a class="el" href="classfusb__ephandle.html#a123fcada49a57077500fab084e537643">fusb_ephandle::d_input_p</a>, <a class="el" href="classfusb__ephandle.html#ad6506c0efdf8eea1dcd8df8d65ecc609">fusb_ephandle::d_started</a>, and <a class="el" href="classfusb__devhandle.html#a1efb2b5a5c155cb1cb7843cf9144d6f3">fusb_devhandle::get_usb_dev_handle()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="fusb__generic_8h_source.html">fusb_generic.h</a></li>
<li><a class="el" href="fusb__generic_8cc.html">fusb_generic.cc</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Thu Feb 17 2011 for Universal Software Radio Peripheral by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
6e7a2755bd78c9deedab199b86e675f3
>
files
>
9550
