<!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 Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<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">GNU Radio 3.2.2 C++ API</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('classfusb__ephandle.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<h1>fusb_ephandle Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="fusb_ephandle" -->
<p>abstract usb end point handle
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="fusb_8h_source.html">fusb.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for fusb_ephandle:</div>
<div class="dyncontent">
<div class="center"><img src="classfusb__ephandle__inherit__graph.png" border="0" usemap="#fusb__ephandle_inherit__map" alt="Inheritance graph"/></div>
<map name="fusb__ephandle_inherit__map" id="fusb__ephandle_inherit__map">
<area shape="rect" id="node3" href="classfusb__ephandle__darwin.html" title="darwin implementation of fusb_ephandle" alt="" coords="163,5,312,35"/><area shape="rect" id="node5" href="classfusb__ephandle__generic.html" title="generic implementation of fusb_ephandle using only libusb" alt="" coords="160,59,315,88"/><area shape="rect" id="node7" href="classfusb__ephandle__linux.html" title="linux specific implementation of fusb_ephandle using usbdevice_fs" alt="" coords="168,112,307,141"/><area shape="rect" id="node9" href="classfusb__ephandle__ra__wb.html" title="generic implementation of fusb_ephandle using only libusb" alt="" coords="164,165,311,195"/><area shape="rect" id="node11" href="classfusb__ephandle__win32.html" title="win32 implementation of fusb_ephandle using libusb-win32" alt="" coords="164,219,311,248"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classfusb__ephandle-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.html#a5ad892734f7649f8444ce6c5fe33382e">fusb_ephandle</a> (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.html#abda7e264c5e0bef062d3d356fb91e371">~fusb_ephandle</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.html#aac0498804e009ab78c47f2265f34a054">start</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">begin streaming i/o <a href="#aac0498804e009ab78c47f2265f34a054"></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.html#a3cfe2cbb78870a6ce0ec8f696ebe45ab">stop</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">stop streaming i/o <a href="#a3cfe2cbb78870a6ce0ec8f696ebe45ab"></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.html#ab2a965c0f5fea6632bc08ea59c8c8fe1">write</a> (const void *buffer, int nbytes)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle.html#a835533e974fb159174c44f2ec0d5668d">read</a> (void *buffer, int nbytes)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle.html#a1e1a2c7173a14aea99686fad7c0e061c">wait_for_completion</a> ()=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle.html#a969c00b4d8ef3c8ad6444eb92da7a61c">block_size</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns current block size. <a href="#a969c00b4d8ef3c8ad6444eb92da7a61c"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle.html#a136e1ab7ba9e180a78ea5085739dd018">d_endpoint</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle.html#a123fcada49a57077500fab084e537643">d_input_p</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle.html#aa8b4afe1f6aaa45491d9ae0dfdad3c0b">d_block_size</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle.html#a3d38bb3ad76925c044fe8e14ecb408e7">d_nblocks</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle.html#ad6506c0efdf8eea1dcd8df8d65ecc609">d_started</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>abstract usb end point handle </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a5ad892734f7649f8444ce6c5fe33382e"></a><!-- doxytag: member="fusb_ephandle::fusb_ephandle" ref="a5ad892734f7649f8444ce6c5fe33382e" args="(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::fusb_ephandle </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>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="abda7e264c5e0bef062d3d356fb91e371"></a><!-- doxytag: member="fusb_ephandle::~fusb_ephandle" ref="abda7e264c5e0bef062d3d356fb91e371" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual fusb_ephandle::~fusb_ephandle </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="a969c00b4d8ef3c8ad6444eb92da7a61c"></a><!-- doxytag: member="fusb_ephandle::block_size" ref="a969c00b4d8ef3c8ad6444eb92da7a61c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fusb_ephandle::block_size </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>returns current block size. </p>
<p>References <a class="el" href="classfusb__ephandle.html#aa8b4afe1f6aaa45491d9ae0dfdad3c0b">d_block_size</a>.</p>
</div>
</div>
<a class="anchor" id="a835533e974fb159174c44f2ec0d5668d"></a><!-- doxytag: member="fusb_ephandle::read" ref="a835533e974fb159174c44f2ec0d5668d" args="(void *buffer, int nbytes)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int fusb_ephandle::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> [pure 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>Implemented in <a class="el" href="classfusb__ephandle__darwin.html#a3084456988799e1875c26f47f453e99a">fusb_ephandle_darwin</a>, <a class="el" href="classfusb__ephandle__generic.html#a893ea1a1d60ba9f0a41b6a1bba31edaf">fusb_ephandle_generic</a>, <a class="el" href="classfusb__ephandle__linux.html#af6f9efb9b0e5a84d90127752c5ffbdf4">fusb_ephandle_linux</a>, <a class="el" href="classfusb__ephandle__ra__wb.html#a11d626f39f48c4ae3308c90d8f65f469">fusb_ephandle_ra_wb</a>, and <a class="el" href="classfusb__ephandle__win32.html#a2189b5c79aab4f36c779242f22589368">fusb_ephandle_win32</a>.</p>
</div>
</div>
<a class="anchor" id="aac0498804e009ab78c47f2265f34a054"></a><!-- doxytag: member="fusb_ephandle::start" ref="aac0498804e009ab78c47f2265f34a054" args="()=0" -->
<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::start </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>begin streaming i/o </p>
<p>Implemented in <a class="el" href="classfusb__ephandle__darwin.html#a40eaefdc5e87eb13a41397c59c0e9739">fusb_ephandle_darwin</a>, <a class="el" href="classfusb__ephandle__generic.html#a9fc2262b4072a85a835942723b8f39c6">fusb_ephandle_generic</a>, <a class="el" href="classfusb__ephandle__linux.html#ad3b4fd0fe703bfc41b9450109270c3a8">fusb_ephandle_linux</a>, <a class="el" href="classfusb__ephandle__ra__wb.html#af2ec65d180691b02fa516e8c5e7000ef">fusb_ephandle_ra_wb</a>, and <a class="el" href="classfusb__ephandle__win32.html#a6528a238f3f19d84d4dd2e7d0a9a8de3">fusb_ephandle_win32</a>.</p>
</div>
</div>
<a class="anchor" id="a3cfe2cbb78870a6ce0ec8f696ebe45ab"></a><!-- doxytag: member="fusb_ephandle::stop" ref="a3cfe2cbb78870a6ce0ec8f696ebe45ab" args="()=0" -->
<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::stop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>stop streaming i/o </p>
<p>Implemented in <a class="el" href="classfusb__ephandle__darwin.html#a432201be192a5f5569137ed03a17e417">fusb_ephandle_darwin</a>, <a class="el" href="classfusb__ephandle__generic.html#aa563a49a03165b2b23a1b9f8529db942">fusb_ephandle_generic</a>, <a class="el" href="classfusb__ephandle__linux.html#affb663e8d315ac1cec6ed3a2b899117d">fusb_ephandle_linux</a>, <a class="el" href="classfusb__ephandle__ra__wb.html#af3db5ab8da0dd49e1d92d64e208ebd1a">fusb_ephandle_ra_wb</a>, and <a class="el" href="classfusb__ephandle__win32.html#a1a26fbc871834e3730789b8575d3714b">fusb_ephandle_win32</a>.</p>
</div>
</div>
<a class="anchor" id="a1e1a2c7173a14aea99686fad7c0e061c"></a><!-- doxytag: member="fusb_ephandle::wait_for_completion" ref="a1e1a2c7173a14aea99686fad7c0e061c" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void fusb_ephandle::wait_for_completion </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Implemented in <a class="el" href="classfusb__ephandle__darwin.html#a57b384a96ddc156c69b69eaef0a52b95">fusb_ephandle_darwin</a>, <a class="el" href="classfusb__ephandle__generic.html#a7a7ef010b4fb8307ba4c6c29c88a020a">fusb_ephandle_generic</a>, <a class="el" href="classfusb__ephandle__linux.html#afb983ac99b988c8da1fb1beffcafe2f4">fusb_ephandle_linux</a>, <a class="el" href="classfusb__ephandle__ra__wb.html#a63eec088aca166d257b187cbe13b5b5b">fusb_ephandle_ra_wb</a>, and <a class="el" href="classfusb__ephandle__win32.html#a385c96d5f778ac688af634ca999b1fa3">fusb_ephandle_win32</a>.</p>
</div>
</div>
<a class="anchor" id="ab2a965c0f5fea6632bc08ea59c8c8fe1"></a><!-- doxytag: member="fusb_ephandle::write" ref="ab2a965c0f5fea6632bc08ea59c8c8fe1" args="(const void *buffer, int nbytes)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int fusb_ephandle::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> [pure 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>Implemented in <a class="el" href="classfusb__ephandle__darwin.html#aa5309b810e28ef13367f18ce75621ff4">fusb_ephandle_darwin</a>, <a class="el" href="classfusb__ephandle__generic.html#a2af659b1b0c8a74a59e9059878a1e496">fusb_ephandle_generic</a>, <a class="el" href="classfusb__ephandle__linux.html#ab4965dbc78419694a0e944b2c13025a9">fusb_ephandle_linux</a>, <a class="el" href="classfusb__ephandle__ra__wb.html#aae056e1b0bc907b2591b6c9876ed9cc3">fusb_ephandle_ra_wb</a>, and <a class="el" href="classfusb__ephandle__win32.html#a2b4d0892ae085ae52a005ccec3efaab6">fusb_ephandle_win32</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="aa8b4afe1f6aaa45491d9ae0dfdad3c0b"></a><!-- doxytag: member="fusb_ephandle::d_block_size" ref="aa8b4afe1f6aaa45491d9ae0dfdad3c0b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classfusb__ephandle.html#aa8b4afe1f6aaa45491d9ae0dfdad3c0b">fusb_ephandle::d_block_size</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Referenced by <a class="el" href="classfusb__ephandle.html#a969c00b4d8ef3c8ad6444eb92da7a61c">block_size()</a>.</p>
</div>
</div>
<a class="anchor" id="a136e1ab7ba9e180a78ea5085739dd018"></a><!-- doxytag: member="fusb_ephandle::d_endpoint" ref="a136e1ab7ba9e180a78ea5085739dd018" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classfusb__ephandle.html#a136e1ab7ba9e180a78ea5085739dd018">fusb_ephandle::d_endpoint</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a123fcada49a57077500fab084e537643"></a><!-- doxytag: member="fusb_ephandle::d_input_p" ref="a123fcada49a57077500fab084e537643" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> <a class="el" href="classfusb__ephandle.html#a123fcada49a57077500fab084e537643">fusb_ephandle::d_input_p</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a3d38bb3ad76925c044fe8e14ecb408e7"></a><!-- doxytag: member="fusb_ephandle::d_nblocks" ref="a3d38bb3ad76925c044fe8e14ecb408e7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classfusb__ephandle.html#a3d38bb3ad76925c044fe8e14ecb408e7">fusb_ephandle::d_nblocks</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ad6506c0efdf8eea1dcd8df8d65ecc609"></a><!-- doxytag: member="fusb_ephandle::d_started" ref="ad6506c0efdf8eea1dcd8df8d65ecc609" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> <a class="el" href="classfusb__ephandle.html#ad6506c0efdf8eea1dcd8df8d65ecc609">fusb_ephandle::d_started</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="fusb_8h_source.html">fusb.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="classfusb__ephandle.html">fusb_ephandle</a> </li>
<li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
6e7a2755bd78c9deedab199b86e675f3
>
files
>
468
