Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 88959ca903fe50462ea99715ead18944 > files > 55

raul-devel-0.7.0-1.fc14.1.x86_64.rpm

<!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: EventRingBuffer.hpp Source File</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&nbsp;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><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
    </ul>
  </div>
<div class="header">
  <div class="headertitle">
<h1>EventRingBuffer.hpp</h1>  </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* This file is part of Raul.</span>
<a name="l00002"></a>00002 <span class="comment"> * Copyright (C) 2007-2009 David Robillard &lt;http://drobilla.net&gt;</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * Raul is free software; you can redistribute it and/or modify it under the</span>
<a name="l00005"></a>00005 <span class="comment"> * terms of the GNU General Public License as published by the Free Software</span>
<a name="l00006"></a>00006 <span class="comment"> * Foundation; either version 2 of the License, or (at your option) any later</span>
<a name="l00007"></a>00007 <span class="comment"> * version.</span>
<a name="l00008"></a>00008 <span class="comment"> *</span>
<a name="l00009"></a>00009 <span class="comment"> * Raul is distributed in the hope that it will be useful, but WITHOUT ANY</span>
<a name="l00010"></a>00010 <span class="comment"> * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS</span>
<a name="l00011"></a>00011 <span class="comment"> * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for details.</span>
<a name="l00012"></a>00012 <span class="comment"> *</span>
<a name="l00013"></a>00013 <span class="comment"> * You should have received a copy of the GNU General Public License along</span>
<a name="l00014"></a>00014 <span class="comment"> * with this program; if not, write to the Free Software Foundation, Inc.,</span>
<a name="l00015"></a>00015 <span class="comment"> * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA</span>
<a name="l00016"></a>00016 <span class="comment"> */</span>
<a name="l00017"></a>00017 
<a name="l00018"></a>00018 <span class="preprocessor">#ifndef RAUL_EVENT_RING_BUFFER_HPP</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span><span class="preprocessor">#define RAUL_EVENT_RING_BUFFER_HPP</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span>
<a name="l00021"></a>00021 <span class="preprocessor">#include &lt;cassert&gt;</span>
<a name="l00022"></a>00022 <span class="preprocessor">#include &lt;algorithm&gt;</span>
<a name="l00023"></a>00023 <span class="preprocessor">#include &quot;raul/RingBuffer.hpp&quot;</span>
<a name="l00024"></a>00024 <span class="preprocessor">#include &quot;raul/TimeStamp.hpp&quot;</span>
<a name="l00025"></a>00025 
<a name="l00026"></a>00026 <span class="keyword">namespace </span>Raul {
<a name="l00027"></a>00027 
<a name="l00028"></a>00028 
<a name="l00034"></a><a class="code" href="classRaul_1_1EventRingBuffer.html">00034</a> <span class="keyword">class </span><a class="code" href="classRaul_1_1EventRingBuffer.html" title="A RingBuffer of events (generic time-stamped binary &amp;quot;blobs&amp;quot;).">EventRingBuffer</a> : <span class="keyword">private</span> Raul::<a class="code" href="classRaul_1_1RingBuffer.html" title="A lock-free RingBuffer.">RingBuffer</a>&lt;uint8_t&gt; {
<a name="l00035"></a>00035 <span class="keyword">public</span>:
<a name="l00036"></a>00036 
<a name="l00039"></a><a class="code" href="classRaul_1_1EventRingBuffer.html#a54c9b86974752f7e288005fe7bd26cc2">00039</a>     <a class="code" href="classRaul_1_1EventRingBuffer.html#a54c9b86974752f7e288005fe7bd26cc2">EventRingBuffer</a>(<span class="keywordtype">size_t</span> capacity)
<a name="l00040"></a>00040         : <a class="code" href="classRaul_1_1RingBuffer.html" title="A lock-free RingBuffer.">RingBuffer</a>&lt;uint8_t&gt;(capacity)
<a name="l00041"></a>00041     {}
<a name="l00042"></a>00042 
<a name="l00043"></a>00043     <span class="keywordtype">size_t</span> capacity()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classRaul_1_1RingBuffer.html#af982500577bb0d4273f71aa960f73581" title="Size (capacity) in bytes.">_size</a>; }
<a name="l00044"></a>00044 
<a name="l00045"></a>00045     <span class="keywordtype">size_t</span> write(TimeStamp time, <span class="keywordtype">size_t</span> size, <span class="keyword">const</span> uint8_t* buf);
<a name="l00046"></a>00046     <span class="keywordtype">bool</span>   read(TimeStamp* time, <span class="keywordtype">size_t</span>* size, uint8_t* buf);
<a name="l00047"></a>00047 };
<a name="l00048"></a>00048 
<a name="l00049"></a>00049 
<a name="l00050"></a>00050 <span class="keyword">inline</span> <span class="keywordtype">bool</span>
<a name="l00051"></a>00051 EventRingBuffer::read(TimeStamp* time, <span class="keywordtype">size_t</span>* size, uint8_t* buf)
<a name="l00052"></a>00052 {
<a name="l00053"></a>00053     <span class="keywordtype">bool</span> success = RingBuffer&lt;uint8_t&gt;::full_read(<span class="keyword">sizeof</span>(TimeStamp), (uint8_t*)time);
<a name="l00054"></a>00054     <span class="keywordflow">if</span> (success)
<a name="l00055"></a>00055         success = RingBuffer&lt;uint8_t&gt;::full_read(<span class="keyword">sizeof</span>(<span class="keywordtype">size_t</span>), (uint8_t*)size);
<a name="l00056"></a>00056     <span class="keywordflow">if</span> (success)
<a name="l00057"></a>00057         success = RingBuffer&lt;uint8_t&gt;::full_read(*size, buf);
<a name="l00058"></a>00058 
<a name="l00059"></a>00059     <span class="keywordflow">return</span> success;
<a name="l00060"></a>00060 }
<a name="l00061"></a>00061 
<a name="l00062"></a>00062 
<a name="l00063"></a>00063 <span class="keyword">inline</span> <span class="keywordtype">size_t</span>
<a name="l00064"></a>00064 EventRingBuffer::write(TimeStamp time, <span class="keywordtype">size_t</span> size, <span class="keyword">const</span> uint8_t* buf)
<a name="l00065"></a>00065 {
<a name="l00066"></a>00066     assert(size &gt; 0);
<a name="l00067"></a>00067 
<a name="l00068"></a>00068     <span class="keywordflow">if</span> (write_space() &lt; (<span class="keyword">sizeof</span>(TimeStamp) + <span class="keyword">sizeof</span>(<span class="keywordtype">size_t</span>) + size)) {
<a name="l00069"></a>00069         <span class="keywordflow">return</span> 0;
<a name="l00070"></a>00070     } <span class="keywordflow">else</span> {
<a name="l00071"></a>00071         RingBuffer&lt;uint8_t&gt;::write(<span class="keyword">sizeof</span>(TimeStamp), (uint8_t*)&amp;time);
<a name="l00072"></a>00072         RingBuffer&lt;uint8_t&gt;::write(<span class="keyword">sizeof</span>(<span class="keywordtype">size_t</span>), (uint8_t*)&amp;size);
<a name="l00073"></a>00073         RingBuffer&lt;uint8_t&gt;::write(size, buf);
<a name="l00074"></a>00074         <span class="keywordflow">return</span> size;
<a name="l00075"></a>00075     }
<a name="l00076"></a>00076 }
<a name="l00077"></a>00077 
<a name="l00078"></a>00078 
<a name="l00079"></a>00079 } <span class="comment">// namespace Raul</span>
<a name="l00080"></a>00080 
<a name="l00081"></a>00081 <span class="preprocessor">#endif // RAUL_EVENT_RING_BUFFER_HPP</span>
<a name="l00082"></a>00082 <span class="preprocessor"></span>
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Oct 6 2010 for RAUL by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>