<!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>RAUL: Raul::EventRingBuffer 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.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</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="tabs2">
<ul class="tablist">
<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 class="navpath">
<ul>
<li><b>Raul</b> </li>
<li><a class="el" href="classRaul_1_1EventRingBuffer.html">Raul::EventRingBuffer</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>Raul::EventRingBuffer Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Raul::EventRingBuffer" --><!-- doxytag: inherits="RingBuffer< uint8_t >" -->
<p>A <a class="el" href="classRaul_1_1RingBuffer.html" title="A lock-free RingBuffer.">RingBuffer</a> of events (generic time-stamped binary "blobs").
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="EventRingBuffer_8hpp_source.html">EventRingBuffer.hpp</a>></code></p>
<p>Inherits <a class="el" href="classRaul_1_1RingBuffer.html">RingBuffer< uint8_t ></a>.</p>
<div class="dynheader">
Collaboration diagram for Raul::EventRingBuffer:</div>
<div class="dyncontent">
<div class="center"><img src="classRaul_1_1EventRingBuffer__coll__graph.png" border="0" usemap="#Raul_1_1EventRingBuffer_coll__map" alt="Collaboration graph"/></div>
<map name="Raul_1_1EventRingBuffer_coll__map" id="Raul_1_1EventRingBuffer_coll__map">
<area shape="rect" id="node2" href="classRaul_1_1RingBuffer.html" title="Raul::RingBuffer\< uint8_t \>" alt="" coords="5,5,187,35"/></map>
</div>
<p><a href="classRaul_1_1EventRingBuffer-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="classRaul_1_1EventRingBuffer.html#a54c9b86974752f7e288005fe7bd26cc2">EventRingBuffer</a> (size_t capacity)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a676f40ecc4bcd29fcdbdf2aa9a897990"></a><!-- doxytag: member="Raul::EventRingBuffer::capacity" ref="a676f40ecc4bcd29fcdbdf2aa9a897990" args="() const " -->
size_t </td><td class="memItemRight" valign="bottom"><b>capacity</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a026abcfcd9f3bbb6dab641ceb7727ec1"></a><!-- doxytag: member="Raul::EventRingBuffer::write" ref="a026abcfcd9f3bbb6dab641ceb7727ec1" args="(TimeStamp time, size_t size, const uint8_t *buf)" -->
size_t </td><td class="memItemRight" valign="bottom"><b>write</b> (<a class="el" href="classRaul_1_1TimeStamp.html">TimeStamp</a> time, size_t size, const uint8_t *buf)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adba8a4577460fb7672e5ff775bdf6b3b"></a><!-- doxytag: member="Raul::EventRingBuffer::read" ref="adba8a4577460fb7672e5ff775bdf6b3b" args="(TimeStamp *time, size_t *size, uint8_t *buf)" -->
bool </td><td class="memItemRight" valign="bottom"><b>read</b> (<a class="el" href="classRaul_1_1TimeStamp.html">TimeStamp</a> *time, size_t *size, uint8_t *buf)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A <a class="el" href="classRaul_1_1RingBuffer.html" title="A lock-free RingBuffer.">RingBuffer</a> of events (generic time-stamped binary "blobs"). </p>
<p>This packs a timestamp, size, and size bytes of data flat into the buffer. Useful for MIDI events, OSC messages, etc. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a54c9b86974752f7e288005fe7bd26cc2"></a><!-- doxytag: member="Raul::EventRingBuffer::EventRingBuffer" ref="a54c9b86974752f7e288005fe7bd26cc2" args="(size_t capacity)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Raul::EventRingBuffer::EventRingBuffer </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>capacity</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>capacity</em> </td><td>Ringbuffer capacity in bytes. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="EventRingBuffer_8hpp_source.html">EventRingBuffer.hpp</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Oct 6 2010 for RAUL by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
88959ca903fe50462ea99715ead18944
>
files
>
108
