<!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_darwin 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__darwin.html',''); </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-attribs">Public Attributes</a> </div> <div class="headertitle"> <h1>fusb_ephandle_darwin Class Reference</h1> </div> </div> <div class="contents"> <!-- doxytag: class="fusb_ephandle_darwin" --><!-- doxytag: inherits="fusb_ephandle" --> <p>darwin implementation of <a class="el" href="classfusb__ephandle.html" title="abstract usb end point handle">fusb_ephandle</a> <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="fusb__darwin_8h_source.html">fusb_darwin.h</a>></code></p> <div class="dynheader"> Inheritance diagram for fusb_ephandle_darwin:</div> <div class="dyncontent"> <div class="center"><img src="classfusb__ephandle__darwin__inherit__graph.png" border="0" usemap="#fusb__ephandle__darwin_inherit__map" alt="Inheritance graph"/></div> <map name="fusb__ephandle__darwin_inherit__map" id="fusb__ephandle__darwin_inherit__map"> <area shape="rect" id="node2" href="classfusb__ephandle.html" title="abstract usb end point handle" alt="" coords="27,5,133,35"/></map> <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classfusb__ephandle__darwin-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__darwin.html#a75115bc11f04aa7b71f5c834817dc667">fusb_ephandle_darwin</a> (<a class="el" href="classfusb__devhandle__darwin.html">fusb_devhandle_darwin</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__darwin.html#a534f904dd924389f1fe9f2f95f1f4720">~fusb_ephandle_darwin</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__darwin.html#a40eaefdc5e87eb13a41397c59c0e9739">start</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">begin streaming i/o <a href="#a40eaefdc5e87eb13a41397c59c0e9739"></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__darwin.html#a432201be192a5f5569137ed03a17e417">stop</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">stop streaming i/o <a href="#a432201be192a5f5569137ed03a17e417"></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__darwin.html#aa5309b810e28ef13367f18ce75621ff4">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__darwin.html#a3084456988799e1875c26f47f453e99a">read</a> (void *buffer, int nbytes)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle__darwin.html#aa5067d1f65048940bffdfdb7996ea8d3">abort</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle__darwin.html#a57b384a96ddc156c69b69eaef0a52b95">wait_for_completion</a> ()</td></tr> <tr><td colspan="2"><h2><a name="pub-attribs"></a> Public Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">UInt8 </td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle__darwin.html#a0fe61b67ad1e4cf8e1f867b5d7428a90">d_pipeRef</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">UInt8 </td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle__darwin.html#a6335642bc300216ff8e43a28453c9b6d">d_transferType</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">usb_interface_t ** </td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle__darwin.html#a833a58e14de40f53f45df6ba213d2058">d_interfaceRef</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">usb_interface_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle__darwin.html#a4c946cfbb61ca98f1c3afc5f14e693ec">d_interface</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="fusb__darwin_8h.html#a0ad379ec681818f6ee2e5a507d129f8e">s_queue_ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle__darwin.html#a547ad950d744a4af1fcd1908bfc43135">d_queue</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classcircular__buffer.html">circular_buffer</a>< char > * </td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle__darwin.html#a86826bf2951e9be5f28d38f0bc38ec7b">d_buffer</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">UInt32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle__darwin.html#a49dd78e1e25808c08e9e47dbca1be46e">d_bufLenBytes</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmld__mutex__t.html">mld_mutex_ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle__darwin.html#a0664ab88582650417b2cba3056a86cf0">d_readRunning</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmld__condition__t.html">mld_condition_ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle__darwin.html#a6ccb2292bc75e3126891eb3dd2655af8">d_runBlock</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmld__condition__t.html">mld_condition_ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classfusb__ephandle__darwin.html#a0d8fda21374b8e9a8f4db0f62b6b5859">d_readBlock</a></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <div class="textblock"><p>darwin implementation of <a class="el" href="classfusb__ephandle.html" title="abstract usb end point handle">fusb_ephandle</a> </p> <p>This is currently identical to the generic implementation and is intended as a starting point for whatever magic is required to make usb fly. </p> </div><hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a75115bc11f04aa7b71f5c834817dc667"></a><!-- doxytag: member="fusb_ephandle_darwin::fusb_ephandle_darwin" ref="a75115bc11f04aa7b71f5c834817dc667" args="(fusb_devhandle_darwin *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_darwin::fusb_ephandle_darwin </td> <td>(</td> <td class="paramtype"><a class="el" href="classfusb__devhandle__darwin.html">fusb_devhandle_darwin</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> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a534f904dd924389f1fe9f2f95f1f4720"></a><!-- doxytag: member="fusb_ephandle_darwin::~fusb_ephandle_darwin" ref="a534f904dd924389f1fe9f2f95f1f4720" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual fusb_ephandle_darwin::~fusb_ephandle_darwin </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="aa5067d1f65048940bffdfdb7996ea8d3"></a><!-- doxytag: member="fusb_ephandle_darwin::abort" ref="aa5067d1f65048940bffdfdb7996ea8d3" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void fusb_ephandle_darwin::abort </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a3084456988799e1875c26f47f453e99a"></a><!-- doxytag: member="fusb_ephandle_darwin::read" ref="a3084456988799e1875c26f47f453e99a" args="(void *buffer, int nbytes)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int fusb_ephandle_darwin::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> </div> </div> <a class="anchor" id="a40eaefdc5e87eb13a41397c59c0e9739"></a><!-- doxytag: member="fusb_ephandle_darwin::start" ref="a40eaefdc5e87eb13a41397c59c0e9739" 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_darwin::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="a432201be192a5f5569137ed03a17e417"></a><!-- doxytag: member="fusb_ephandle_darwin::stop" ref="a432201be192a5f5569137ed03a17e417" 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_darwin::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="a57b384a96ddc156c69b69eaef0a52b95"></a><!-- doxytag: member="fusb_ephandle_darwin::wait_for_completion" ref="a57b384a96ddc156c69b69eaef0a52b95" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void fusb_ephandle_darwin::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="aa5309b810e28ef13367f18ce75621ff4"></a><!-- doxytag: member="fusb_ephandle_darwin::write" ref="aa5309b810e28ef13367f18ce75621ff4" args="(const void *buffer, int nbytes)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int fusb_ephandle_darwin::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> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="a86826bf2951e9be5f28d38f0bc38ec7b"></a><!-- doxytag: member="fusb_ephandle_darwin::d_buffer" ref="a86826bf2951e9be5f28d38f0bc38ec7b" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classcircular__buffer.html">circular_buffer</a><char>* <a class="el" href="classfusb__ephandle__darwin.html#a86826bf2951e9be5f28d38f0bc38ec7b">fusb_ephandle_darwin::d_buffer</a></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a49dd78e1e25808c08e9e47dbca1be46e"></a><!-- doxytag: member="fusb_ephandle_darwin::d_bufLenBytes" ref="a49dd78e1e25808c08e9e47dbca1be46e" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">UInt32 <a class="el" href="classfusb__ephandle__darwin.html#a49dd78e1e25808c08e9e47dbca1be46e">fusb_ephandle_darwin::d_bufLenBytes</a></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a4c946cfbb61ca98f1c3afc5f14e693ec"></a><!-- doxytag: member="fusb_ephandle_darwin::d_interface" ref="a4c946cfbb61ca98f1c3afc5f14e693ec" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">usb_interface_t* <a class="el" href="classfusb__ephandle__darwin.html#a4c946cfbb61ca98f1c3afc5f14e693ec">fusb_ephandle_darwin::d_interface</a></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a833a58e14de40f53f45df6ba213d2058"></a><!-- doxytag: member="fusb_ephandle_darwin::d_interfaceRef" ref="a833a58e14de40f53f45df6ba213d2058" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">usb_interface_t** <a class="el" href="classfusb__ephandle__darwin.html#a833a58e14de40f53f45df6ba213d2058">fusb_ephandle_darwin::d_interfaceRef</a></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a0fe61b67ad1e4cf8e1f867b5d7428a90"></a><!-- doxytag: member="fusb_ephandle_darwin::d_pipeRef" ref="a0fe61b67ad1e4cf8e1f867b5d7428a90" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">UInt8 <a class="el" href="classfusb__ephandle__darwin.html#a0fe61b67ad1e4cf8e1f867b5d7428a90">fusb_ephandle_darwin::d_pipeRef</a></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a547ad950d744a4af1fcd1908bfc43135"></a><!-- doxytag: member="fusb_ephandle_darwin::d_queue" ref="a547ad950d744a4af1fcd1908bfc43135" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="fusb__darwin_8h.html#a0ad379ec681818f6ee2e5a507d129f8e">s_queue_ptr</a> <a class="el" href="classfusb__ephandle__darwin.html#a547ad950d744a4af1fcd1908bfc43135">fusb_ephandle_darwin::d_queue</a></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a0d8fda21374b8e9a8f4db0f62b6b5859"></a><!-- doxytag: member="fusb_ephandle_darwin::d_readBlock" ref="a0d8fda21374b8e9a8f4db0f62b6b5859" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classmld__condition__t.html">mld_condition_ptr</a> <a class="el" href="classfusb__ephandle__darwin.html#a0d8fda21374b8e9a8f4db0f62b6b5859">fusb_ephandle_darwin::d_readBlock</a></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a0664ab88582650417b2cba3056a86cf0"></a><!-- doxytag: member="fusb_ephandle_darwin::d_readRunning" ref="a0664ab88582650417b2cba3056a86cf0" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classmld__mutex__t.html">mld_mutex_ptr</a> <a class="el" href="classfusb__ephandle__darwin.html#a0664ab88582650417b2cba3056a86cf0">fusb_ephandle_darwin::d_readRunning</a></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a6ccb2292bc75e3126891eb3dd2655af8"></a><!-- doxytag: member="fusb_ephandle_darwin::d_runBlock" ref="a6ccb2292bc75e3126891eb3dd2655af8" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classmld__condition__t.html">mld_condition_ptr</a> <a class="el" href="classfusb__ephandle__darwin.html#a6ccb2292bc75e3126891eb3dd2655af8">fusb_ephandle_darwin::d_runBlock</a></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a6335642bc300216ff8e43a28453c9b6d"></a><!-- doxytag: member="fusb_ephandle_darwin::d_transferType" ref="a6335642bc300216ff8e43a28453c9b6d" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">UInt8 <a class="el" href="classfusb__ephandle__darwin.html#a6335642bc300216ff8e43a28453c9b6d">fusb_ephandle_darwin::d_transferType</a></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__darwin_8h_source.html">fusb_darwin.h</a></li> </ul> </div> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="classfusb__ephandle__darwin.html">fusb_ephandle_darwin</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>