<!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: 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.6.2 -->
<div class="contents">
<h1>fusb_ephandle_generic Class Reference</h1><!-- 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="dynsection">
<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 target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classfusb__ephandle__generic-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__generic.html#a830f0afd5a768fef69afaf68c26791f3">fusb_ephandle_generic</a> (<a class="el" href="classfusb__devhandle__generic.html">fusb_devhandle_generic</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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle__generic.html#a46e53a8ce5446542ec27ecf8b8009e3c">~fusb_ephandle_generic</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle__generic.html#a9fc2262b4072a85a835942723b8f39c6">start</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">begin streaming i/o <a href="#a9fc2262b4072a85a835942723b8f39c6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle__generic.html#aa563a49a03165b2b23a1b9f8529db942">stop</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">stop streaming i/o <a href="#aa563a49a03165b2b23a1b9f8529db942"></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#a2af659b1b0c8a74a59e9059878a1e496">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#a893ea1a1d60ba9f0a41b6a1bba31edaf">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>
<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="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"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </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="a46e53a8ce5446542ec27ecf8b8009e3c"></a><!-- doxytag: member="fusb_ephandle_generic::~fusb_ephandle_generic" ref="a46e53a8ce5446542ec27ecf8b8009e3c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual 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="a893ea1a1d60ba9f0a41b6a1bba31edaf"></a><!-- doxytag: member="fusb_ephandle_generic::read" ref="a893ea1a1d60ba9f0a41b6a1bba31edaf" args="(void *buffer, int nbytes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual 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><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>
</div>
</div>
<a class="anchor" id="a9fc2262b4072a85a835942723b8f39c6"></a><!-- doxytag: member="fusb_ephandle_generic::start" ref="a9fc2262b4072a85a835942723b8f39c6" 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_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>
</div>
</div>
<a class="anchor" id="aa563a49a03165b2b23a1b9f8529db942"></a><!-- doxytag: member="fusb_ephandle_generic::stop" ref="aa563a49a03165b2b23a1b9f8529db942" 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_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>
</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="a2af659b1b0c8a74a59e9059878a1e496"></a><!-- doxytag: member="fusb_ephandle_generic::write" ref="a2af659b1b0c8a74a59e9059878a1e496" args="(const void *buffer, int nbytes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual 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><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>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="fusb__generic_8h_source.html">fusb_generic.h</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>
