<!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_linux 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_linux Class Reference</h1><!-- doxytag: class="fusb_ephandle_linux" --><!-- doxytag: inherits="fusb_ephandle" -->
<p>linux specific implementation of <a class="el" href="classfusb__ephandle.html" title="abstract usb end point handle">fusb_ephandle</a> using usbdevice_fs
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="fusb__linux_8h_source.html">fusb_linux.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for fusb_ephandle_linux:</div>
<div class="dynsection">
<div class="center"><img src="classfusb__ephandle__linux__inherit__graph.png" border="0" usemap="#fusb__ephandle__linux_inherit__map" alt="Inheritance graph"/></div>
<map name="fusb__ephandle__linux_inherit__map" id="fusb__ephandle__linux_inherit__map">
<area shape="rect" id="node2" href="classfusb__ephandle.html" title="abstract usb end point handle" alt="" coords="21,5,128,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classfusb__ephandle__linux-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__linux.html#af7000716d3733e2b4b3ed6510fd7ebcd">fusb_ephandle_linux</a> (<a class="el" href="classfusb__devhandle__linux.html">fusb_devhandle_linux</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__linux.html#a5664954fd3942978fc5edffbf90c0e6b">~fusb_ephandle_linux</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__linux.html#ad3b4fd0fe703bfc41b9450109270c3a8">start</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">begin streaming i/o <a href="#ad3b4fd0fe703bfc41b9450109270c3a8"></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__linux.html#affb663e8d315ac1cec6ed3a2b899117d">stop</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">stop streaming i/o <a href="#affb663e8d315ac1cec6ed3a2b899117d"></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__linux.html#ab4965dbc78419694a0e944b2c13025a9">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__linux.html#af6f9efb9b0e5a84d90127752c5ffbdf4">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__linux.html#afb983ac99b988c8da1fb1beffcafe2f4">wait_for_completion</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle__linux.html#a57c578355685f5b86d976c2204f38f36">free_list_add</a> (usbdevfs_urb *urb)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle__linux.html#a5d4f19af3499104c7e146d61afc3cbd5">completed_list_add</a> (usbdevfs_urb *urb)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">usbdevfs_urb * </td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle__linux.html#aa5e5ca23fe068342cdfa873f824d8451">free_list_get</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">usbdevfs_urb * </td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle__linux.html#a0ec691b828f3f76621e986c9544baaff">completed_list_get</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>linux specific implementation of <a class="el" href="classfusb__ephandle.html" title="abstract usb end point handle">fusb_ephandle</a> using usbdevice_fs </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="af7000716d3733e2b4b3ed6510fd7ebcd"></a><!-- doxytag: member="fusb_ephandle_linux::fusb_ephandle_linux" ref="af7000716d3733e2b4b3ed6510fd7ebcd" args="(fusb_devhandle_linux *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_linux::fusb_ephandle_linux </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classfusb__devhandle__linux.html">fusb_devhandle_linux</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="a5664954fd3942978fc5edffbf90c0e6b"></a><!-- doxytag: member="fusb_ephandle_linux::~fusb_ephandle_linux" ref="a5664954fd3942978fc5edffbf90c0e6b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual fusb_ephandle_linux::~fusb_ephandle_linux </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="a5d4f19af3499104c7e146d61afc3cbd5"></a><!-- doxytag: member="fusb_ephandle_linux::completed_list_add" ref="a5d4f19af3499104c7e146d61afc3cbd5" args="(usbdevfs_urb *urb)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void fusb_ephandle_linux::completed_list_add </td>
<td>(</td>
<td class="paramtype">usbdevfs_urb * </td>
<td class="paramname"> <em>urb</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a0ec691b828f3f76621e986c9544baaff"></a><!-- doxytag: member="fusb_ephandle_linux::completed_list_get" ref="a0ec691b828f3f76621e986c9544baaff" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">usbdevfs_urb* fusb_ephandle_linux::completed_list_get </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a57c578355685f5b86d976c2204f38f36"></a><!-- doxytag: member="fusb_ephandle_linux::free_list_add" ref="a57c578355685f5b86d976c2204f38f36" args="(usbdevfs_urb *urb)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void fusb_ephandle_linux::free_list_add </td>
<td>(</td>
<td class="paramtype">usbdevfs_urb * </td>
<td class="paramname"> <em>urb</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aa5e5ca23fe068342cdfa873f824d8451"></a><!-- doxytag: member="fusb_ephandle_linux::free_list_get" ref="aa5e5ca23fe068342cdfa873f824d8451" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">usbdevfs_urb* fusb_ephandle_linux::free_list_get </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="af6f9efb9b0e5a84d90127752c5ffbdf4"></a><!-- doxytag: member="fusb_ephandle_linux::read" ref="af6f9efb9b0e5a84d90127752c5ffbdf4" args="(void *buffer, int nbytes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int fusb_ephandle_linux::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="ad3b4fd0fe703bfc41b9450109270c3a8"></a><!-- doxytag: member="fusb_ephandle_linux::start" ref="ad3b4fd0fe703bfc41b9450109270c3a8" 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_linux::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="affb663e8d315ac1cec6ed3a2b899117d"></a><!-- doxytag: member="fusb_ephandle_linux::stop" ref="affb663e8d315ac1cec6ed3a2b899117d" 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_linux::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="afb983ac99b988c8da1fb1beffcafe2f4"></a><!-- doxytag: member="fusb_ephandle_linux::wait_for_completion" ref="afb983ac99b988c8da1fb1beffcafe2f4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void fusb_ephandle_linux::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>
</div>
</div>
<a class="anchor" id="ab4965dbc78419694a0e944b2c13025a9"></a><!-- doxytag: member="fusb_ephandle_linux::write" ref="ab4965dbc78419694a0e944b2c13025a9" args="(const void *buffer, int nbytes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int fusb_ephandle_linux::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__linux_8h_source.html">fusb_linux.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>
