<!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_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.3 -->
<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_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 href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for fusb_ephandle_linux:</div>
<div class="dynsection">
<div class="center"><img src="classfusb__ephandle__linux__coll__graph.png" border="0" usemap="#fusb__ephandle__linux_coll__map" alt="Collaboration graph"/></div>
<map name="fusb__ephandle__linux_coll__map" id="fusb__ephandle__linux_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__linux.html" title="linux specific implementation of fusb_devhandle using usbdevice_fs" alt="" coords="136,181,283,211"/><area shape="rect" id="node6" href="classfusb__devhandle.html" title="abstract usb device handle" alt="" coords="153,101,265,131"/><area shape="rect" id="node8" href="structusb__dev__handle.html" title="usb_dev_handle" alt="" coords="152,5,267,35"/></map>
<center><span class="legend">[<a 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, 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__linux.html#a5978d6295cbfe0f8fa8961d0a24e7ba3">~fusb_ephandle_linux</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__linux.html#a765993be306d930b5c0fda742d21e87e">start</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">begin streaming i/o <a href="#a765993be306d930b5c0fda742d21e87e"></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__linux.html#a0ab27c7fa6bacaa042a89de22cb36e91">stop</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">stop streaming i/o <a href="#a0ab27c7fa6bacaa042a89de22cb36e91"></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#adfe7bf7550c1a8f19308de1d889ecc37">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#a7dff0426304357101b6e34e5918d6098">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#ad84618ba52ecfe49c8848cba69b0a04c">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#ab8edb43836585a3f1f1ae817686e4231">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#a668168194e27bfd84a708acd93560df7">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">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">
<p>References <a class="el" href="fusb_8h_source.html#l00073">fusb_ephandle::d_block_size</a>, <a class="el" href="fusb_8h_source.html#l00071">fusb_ephandle::d_endpoint</a>, <a class="el" href="fusb_8h_source.html#l00072">fusb_ephandle::d_input_p</a>, <a class="el" href="fusb_8h_source.html#l00074">fusb_ephandle::d_nblocks</a>, and <a class="el" href="fusb__libusb1_8cc_source.html#l00038">MINIMIZE_TX_BUFFERING</a>.</p>
</div>
</div>
<a class="anchor" id="a5978d6295cbfe0f8fa8961d0a24e7ba3"></a><!-- doxytag: member="fusb_ephandle_linux::~fusb_ephandle_linux" ref="a5978d6295cbfe0f8fa8961d0a24e7ba3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">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">
<p>References <a class="el" href="fusb__linux_8cc_source.html#l00669">completed_list_get()</a>, <a class="el" href="fusb__linux_8cc_source.html#l00651">free_list_get()</a>, and <a class="el" href="fusb__linux_8cc_source.html#l00387">stop()</a>.</p>
</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">
<p>Referenced by <a class="el" href="fusb__linux_8cc_source.html#l00253">fusb_devhandle_linux::_reap()</a>.</p>
</div>
</div>
<a class="anchor" id="a668168194e27bfd84a708acd93560df7"></a><!-- doxytag: member="fusb_ephandle_linux::completed_list_get" ref="a668168194e27bfd84a708acd93560df7" 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">
<p>Referenced by <a class="el" href="fusb__linux_8cc_source.html#l00387">stop()</a>, and <a class="el" href="fusb__linux_8cc_source.html#l00338">~fusb_ephandle_linux()</a>.</p>
</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">
<p>Referenced by <a class="el" href="fusb__linux_8cc_source.html#l00387">stop()</a>.</p>
</div>
</div>
<a class="anchor" id="ab8edb43836585a3f1f1ae817686e4231"></a><!-- doxytag: member="fusb_ephandle_linux::free_list_get" ref="ab8edb43836585a3f1f1ae817686e4231" 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">
<p>Referenced by <a class="el" href="fusb__linux_8cc_source.html#l00362">start()</a>, and <a class="el" href="fusb__linux_8cc_source.html#l00338">~fusb_ephandle_linux()</a>.</p>
</div>
</div>
<a class="anchor" id="a7dff0426304357101b6e34e5918d6098"></a><!-- doxytag: member="fusb_ephandle_linux::read" ref="a7dff0426304357101b6e34e5918d6098" args="(void *buffer, int nbytes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">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>
<p>References <a class="el" href="fusb_8h_source.html#l00072">fusb_ephandle::d_input_p</a>, and <a class="el" href="fusb_8h_source.html#l00075">fusb_ephandle::d_started</a>.</p>
</div>
</div>
<a class="anchor" id="a765993be306d930b5c0fda742d21e87e"></a><!-- doxytag: member="fusb_ephandle_linux::start" ref="a765993be306d930b5c0fda742d21e87e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool 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>
<p>References <a class="el" href="fusb_8h_source.html#l00072">fusb_ephandle::d_input_p</a>, <a class="el" href="fusb_8h_source.html#l00074">fusb_ephandle::d_nblocks</a>, <a class="el" href="fusb_8h_source.html#l00075">fusb_ephandle::d_started</a>, and <a class="el" href="fusb__linux_8cc_source.html#l00651">free_list_get()</a>.</p>
</div>
</div>
<a class="anchor" id="a0ab27c7fa6bacaa042a89de22cb36e91"></a><!-- doxytag: member="fusb_ephandle_linux::stop" ref="a0ab27c7fa6bacaa042a89de22cb36e91" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool 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>
<p>References <a class="el" href="fusb__linux_8cc_source.html#l00159">fusb_devhandle_linux::_cancel_pending_rqsts()</a>, <a class="el" href="fusb__linux_8cc_source.html#l00253">fusb_devhandle_linux::_reap()</a>, <a class="el" href="fusb__linux_8cc_source.html#l00669">completed_list_get()</a>, <a class="el" href="fusb_8h_source.html#l00074">fusb_ephandle::d_nblocks</a>, <a class="el" href="fusb_8h_source.html#l00075">fusb_ephandle::d_started</a>, and <a class="el" href="fusb__linux_8cc_source.html#l00643">free_list_add()</a>.</p>
<p>Referenced by <a class="el" href="fusb__linux_8cc_source.html#l00338">~fusb_ephandle_linux()</a>.</p>
</div>
</div>
<a class="anchor" id="ad84618ba52ecfe49c8848cba69b0a04c"></a><!-- doxytag: member="fusb_ephandle_linux::wait_for_completion" ref="ad84618ba52ecfe49c8848cba69b0a04c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">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>
<p>References <a class="el" href="fusb__linux_8cc_source.html#l00291">fusb_devhandle_linux::_wait_for_completion()</a>.</p>
</div>
</div>
<a class="anchor" id="adfe7bf7550c1a8f19308de1d889ecc37"></a><!-- doxytag: member="fusb_ephandle_linux::write" ref="adfe7bf7550c1a8f19308de1d889ecc37" args="(const void *buffer, int nbytes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">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>
<p>References <a class="el" href="fusb_8h_source.html#l00072">fusb_ephandle::d_input_p</a>, and <a class="el" href="fusb_8h_source.html#l00075">fusb_ephandle::d_started</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="fusb__linux_8h_source.html">fusb_linux.h</a></li>
<li><a class="el" href="fusb__linux_8cc.html">fusb_linux.cc</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Dec 29 19:44:43 2010 for Universal Software Radio Peripheral by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.2
>
i586
>
media
>
contrib-backports
>
by-pkgid
>
e1990170655e25252b23301d6cebc16d
>
files
>
606
