<!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: circular_buffer< T > Class Template 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="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>circular_buffer< T > Class Template Reference</h1><!-- doxytag: class="circular_buffer" --> <p><code>#include <<a class="el" href="circular__buffer_8h_source.html">circular_buffer.h</a>></code></p> <div class="dynheader"> Collaboration diagram for circular_buffer< T >:</div> <div class="dynsection"> <div class="center"><img src="classcircular__buffer__coll__graph.png" border="0" usemap="#circular__buffer_3_01T_01_4_coll__map" alt="Collaboration graph"/></div> <map name="circular__buffer_3_01T_01_4_coll__map" id="circular__buffer_3_01T_01_4_coll__map"> <area shape="rect" id="node2" href="classmld__condition__t.html" title="mld_condition_t" alt="" coords="109,101,221,131"/><area shape="rect" id="node4" href="classmld__mutex__t.html" title="mld_mutex_t" alt="" coords="25,5,121,35"/></map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classcircular__buffer-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="classcircular__buffer.html#af87896a1a606e366bcc0ee8f7f0cf36e">circular_buffer</a> (UInt32 bufLen_I, bool doWriteBlock=true, bool doFullRead=false)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcircular__buffer.html#a6fa47d36777b9522904c0b6165d3183f">~circular_buffer</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">UInt32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classcircular__buffer.html#a728e983738d3128fc328d7545d6505ec">n_avail_write_items</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">UInt32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classcircular__buffer.html#a3552cefda9ed6a92931d286188f5c1aa">n_avail_read_items</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">UInt32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classcircular__buffer.html#ab64fa2266a00d4da83bc471db7d9d676">buffer_length_items</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcircular__buffer.html#aadcd544c25a138781fa6e0e43b49665d">do_write_block</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcircular__buffer.html#aa1af3c61175877bd0fe3baf2130ce65c">do_full_read</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcircular__buffer.html#acc29c0f342fa153d64561b622e3cf3d4">reset</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcircular__buffer.html#a26fe1ca202c4aa2d324612b0b8beedd9">enqueue</a> (T *buf, UInt32 bufLen_I)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcircular__buffer.html#a4411197cc0fbf929538ba2ec2aeb3bab">dequeue</a> (T *buf, UInt32 *bufLen_I)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcircular__buffer.html#a1da17d5f94fe3ca1ffca42a5d307f4f5">abort</a> ()</td></tr> </table> <h3>template<class T><br/> class circular_buffer< T ></h3> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="af87896a1a606e366bcc0ee8f7f0cf36e"></a><!-- doxytag: member="circular_buffer::circular_buffer" ref="af87896a1a606e366bcc0ee8f7f0cf36e" args="(UInt32 bufLen_I, bool doWriteBlock=true, bool doFullRead=false)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class T> </div> <table class="memname"> <tr> <td class="memname"><a class="el" href="classcircular__buffer.html">circular_buffer</a>< T >::<a class="el" href="classcircular__buffer.html">circular_buffer</a> </td> <td>(</td> <td class="paramtype">UInt32 </td> <td class="paramname"> <em>bufLen_I</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>doWriteBlock</em> = <code>true</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>doFullRead</em> = <code>false</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a6fa47d36777b9522904c0b6165d3183f"></a><!-- doxytag: member="circular_buffer::~circular_buffer" ref="a6fa47d36777b9522904c0b6165d3183f" args="()" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class T> </div> <table class="memname"> <tr> <td class="memname"><a class="el" href="classcircular__buffer.html">circular_buffer</a>< T >::~<a class="el" href="classcircular__buffer.html">circular_buffer</a> </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a1da17d5f94fe3ca1ffca42a5d307f4f5"></a><!-- doxytag: member="circular_buffer::abort" ref="a1da17d5f94fe3ca1ffca42a5d307f4f5" args="()" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class T> </div> <table class="memname"> <tr> <td class="memname">void <a class="el" href="classcircular__buffer.html">circular_buffer</a>< T >::abort </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Referenced by <a class="el" href="fusb__darwin_8cc_source.html#l00532">fusb_ephandle_darwin::stop()</a>.</p> </div> </div> <a class="anchor" id="ab64fa2266a00d4da83bc471db7d9d676"></a><!-- doxytag: member="circular_buffer::buffer_length_items" ref="ab64fa2266a00d4da83bc471db7d9d676" args="()" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class T> </div> <table class="memname"> <tr> <td class="memname">UInt32 <a class="el" href="classcircular__buffer.html">circular_buffer</a>< T >::buffer_length_items </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a4411197cc0fbf929538ba2ec2aeb3bab"></a><!-- doxytag: member="circular_buffer::dequeue" ref="a4411197cc0fbf929538ba2ec2aeb3bab" args="(T *buf, UInt32 *bufLen_I)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class T> </div> <table class="memname"> <tr> <td class="memname">int <a class="el" href="classcircular__buffer.html">circular_buffer</a>< T >::dequeue </td> <td>(</td> <td class="paramtype">T * </td> <td class="paramname"> <em>buf</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">UInt32 * </td> <td class="paramname"> <em>bufLen_I</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Referenced by <a class="el" href="fusb__darwin_8cc_source.html#l00422">fusb_ephandle_darwin::read()</a>.</p> </div> </div> <a class="anchor" id="aa1af3c61175877bd0fe3baf2130ce65c"></a><!-- doxytag: member="circular_buffer::do_full_read" ref="aa1af3c61175877bd0fe3baf2130ce65c" args="()" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class T> </div> <table class="memname"> <tr> <td class="memname">bool <a class="el" href="classcircular__buffer.html">circular_buffer</a>< T >::do_full_read </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="aadcd544c25a138781fa6e0e43b49665d"></a><!-- doxytag: member="circular_buffer::do_write_block" ref="aadcd544c25a138781fa6e0e43b49665d" args="()" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class T> </div> <table class="memname"> <tr> <td class="memname">bool <a class="el" href="classcircular__buffer.html">circular_buffer</a>< T >::do_write_block </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a26fe1ca202c4aa2d324612b0b8beedd9"></a><!-- doxytag: member="circular_buffer::enqueue" ref="a26fe1ca202c4aa2d324612b0b8beedd9" args="(T *buf, UInt32 bufLen_I)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class T> </div> <table class="memname"> <tr> <td class="memname">int <a class="el" href="classcircular__buffer.html">circular_buffer</a>< T >::enqueue </td> <td>(</td> <td class="paramtype">T * </td> <td class="paramname"> <em>buf</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">UInt32 </td> <td class="paramname"> <em>bufLen_I</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a3552cefda9ed6a92931d286188f5c1aa"></a><!-- doxytag: member="circular_buffer::n_avail_read_items" ref="a3552cefda9ed6a92931d286188f5c1aa" args="()" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class T> </div> <table class="memname"> <tr> <td class="memname">UInt32 <a class="el" href="classcircular__buffer.html">circular_buffer</a>< T >::n_avail_read_items </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a728e983738d3128fc328d7545d6505ec"></a><!-- doxytag: member="circular_buffer::n_avail_write_items" ref="a728e983738d3128fc328d7545d6505ec" args="()" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class T> </div> <table class="memname"> <tr> <td class="memname">UInt32 <a class="el" href="classcircular__buffer.html">circular_buffer</a>< T >::n_avail_write_items </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="acc29c0f342fa153d64561b622e3cf3d4"></a><!-- doxytag: member="circular_buffer::reset" ref="acc29c0f342fa153d64561b622e3cf3d4" args="()" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class T> </div> <table class="memname"> <tr> <td class="memname">void <a class="el" href="classcircular__buffer.html">circular_buffer</a>< T >::reset </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Referenced by <a class="el" href="circular__buffer_8h_source.html#l00072">circular_buffer< char >::circular_buffer()</a>, and <a class="el" href="fusb__darwin_8cc_source.html#l00125">fusb_ephandle_darwin::start()</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="circular__buffer_8h_source.html">circular_buffer.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>