<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>mrpt::synch::MT_buffer Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<div align="left"><a href="http://www.mrpt.org/">Main MRPT website</a> > <b>C++ reference</b> </div>
<div align="right">
<a href="index.html"><img border="0" src="mrpt_logo.png" alt="MRPT logo"></a>
</div>
<!-- Generated by Doxygen 1.7.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</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>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<div class="left">
<form id="FSearchBox" action="search.php" method="get">
<img id="MSearchSelect" src="search/mag.png" alt=""/>
<input type="text" id="MSearchField" name="query" value="Search" size="20" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"/>
</form>
</div><div class="right"></div>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacemrpt.html">mrpt</a> </li>
<li class="navelem"><a class="el" href="namespacemrpt_1_1synch.html">synch</a> </li>
<li class="navelem"><a class="el" href="classmrpt_1_1synch_1_1_m_t__buffer.html">MT_buffer</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pri-attribs">Private Attributes</a> </div>
<div class="headertitle">
<div class="title">mrpt::synch::MT_buffer Class Reference<div class="ingroups"><a class="el" href="group__synch__grp.html">Synchronization, multi-threading synch tools</a></div></div> </div>
</div>
<div class="contents">
<!-- doxytag: class="mrpt::synch::MT_buffer" --><hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>This class is a bulk sequence of bytes with MultiThread (MT)-safe read and write operations. </p>
</div>
<p><code>#include <<a class="el" href="_m_t__buffer_8h_source.html">mrpt/synch/MT_buffer.h</a>></code></p>
<p><a href="classmrpt_1_1synch_1_1_m_t__buffer-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="classmrpt_1_1synch_1_1_m_t__buffer.html#a225efa3392c1730a50eeded292bf527e">MT_buffer</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1synch_1_1_m_t__buffer.html#af957b118990b5b10da953e6f3d8aee19">~MT_buffer</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1synch_1_1_m_t__buffer.html#a5a4274ed01c6ec241a0d641272e280b0">clear</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1synch_1_1_m_t__buffer.html#a85f9c57e9320ae2870687a6adc39711f">size</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1synch_1_1_m_t__buffer.html#a9f2771932d87f564e23ff76a6a57da01">appendData</a> (const <a class="el" href="namespacemrpt.html#a3250fe562baad62b3da2e166eb8867df">vector_byte</a> &d)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1synch_1_1_m_t__buffer.html#abdc888b7a87ece63da9613ca06b10bff">readAndClear</a> (<a class="el" href="namespacemrpt.html#a3250fe562baad62b3da2e166eb8867df">vector_byte</a> &d)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1synch_1_1_m_t__buffer.html#aafbdc57caf851dc000a5718c21c4bfdd">read</a> (<a class="el" href="namespacemrpt.html#a3250fe562baad62b3da2e166eb8867df">vector_byte</a> &d)</td></tr>
<tr><td colspan="2"><h2><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacemrpt.html#a3250fe562baad62b3da2e166eb8867df">vector_byte</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1synch_1_1_m_t__buffer.html#aff7ffaf8223bb8d3e8083deaefc75d50">m_data</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmrpt_1_1synch_1_1_c_critical_section.html">CCriticalSection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1synch_1_1_m_t__buffer.html#a55b74e871b51608673ef1f0739e48b0a">m_cs</a></td></tr>
</table>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a225efa3392c1730a50eeded292bf527e"></a><!-- doxytag: member="mrpt::synch::MT_buffer::MT_buffer" ref="a225efa3392c1730a50eeded292bf527e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mrpt::synch::MT_buffer::MT_buffer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_m_t__buffer_8h_source.html#l00048">48</a> of file <a class="el" href="_m_t__buffer_8h_source.html">MT_buffer.h</a>.</p>
</div>
</div>
<a class="anchor" id="af957b118990b5b10da953e6f3d8aee19"></a><!-- doxytag: member="mrpt::synch::MT_buffer::~MT_buffer" ref="af957b118990b5b10da953e6f3d8aee19" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual mrpt::synch::MT_buffer::~MT_buffer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_m_t__buffer_8h_source.html#l00050">50</a> of file <a class="el" href="_m_t__buffer_8h_source.html">MT_buffer.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a9f2771932d87f564e23ff76a6a57da01"></a><!-- doxytag: member="mrpt::synch::MT_buffer::appendData" ref="a9f2771932d87f564e23ff76a6a57da01" args="(const vector_byte &d)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::synch::MT_buffer::appendData </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacemrpt.html#a3250fe562baad62b3da2e166eb8867df">vector_byte</a> & </td>
<td class="paramname"><em>d</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">d</td><td>Append new data to the stream </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_m_t__buffer_8h_source.html#l00069">69</a> of file <a class="el" href="_m_t__buffer_8h_source.html">MT_buffer.h</a>.</p>
<p>References <a class="el" href="_m_t__buffer_8h_source.html#l00045">m_cs</a>, <a class="el" href="classmrpt_1_1synch_1_1_c_critical_section.html#a10c531e3bd482d9b54ddb83d8a95566c">mrpt::synch::CCriticalSection::enter()</a>, <a class="el" href="_m_t__buffer_8h_source.html#l00044">m_data</a>, and <a class="el" href="classmrpt_1_1synch_1_1_c_critical_section.html#a933e6e22808e8e311cd980837547ef68">mrpt::synch::CCriticalSection::leave()</a>.</p>
</div>
</div>
<a class="anchor" id="a5a4274ed01c6ec241a0d641272e280b0"></a><!-- doxytag: member="mrpt::synch::MT_buffer::clear" ref="a5a4274ed01c6ec241a0d641272e280b0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::synch::MT_buffer::clear </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_m_t__buffer_8h_source.html#l00053">53</a> of file <a class="el" href="_m_t__buffer_8h_source.html">MT_buffer.h</a>.</p>
<p>References <a class="el" href="_m_t__buffer_8h_source.html#l00045">m_cs</a>, <a class="el" href="classmrpt_1_1synch_1_1_c_critical_section.html#a10c531e3bd482d9b54ddb83d8a95566c">mrpt::synch::CCriticalSection::enter()</a>, <a class="el" href="_m_t__buffer_8h_source.html#l00044">m_data</a>, and <a class="el" href="classmrpt_1_1synch_1_1_c_critical_section.html#a933e6e22808e8e311cd980837547ef68">mrpt::synch::CCriticalSection::leave()</a>.</p>
</div>
</div>
<a class="anchor" id="aafbdc57caf851dc000a5718c21c4bfdd"></a><!-- doxytag: member="mrpt::synch::MT_buffer::read" ref="aafbdc57caf851dc000a5718c21c4bfdd" args="(vector_byte &d)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::synch::MT_buffer::read </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacemrpt.html#a3250fe562baad62b3da2e166eb8867df">vector_byte</a> & </td>
<td class="paramname"><em>d</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">d</td><td>Read the whole buffer. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_m_t__buffer_8h_source.html#l00084">84</a> of file <a class="el" href="_m_t__buffer_8h_source.html">MT_buffer.h</a>.</p>
<p>References <a class="el" href="_m_t__buffer_8h_source.html#l00045">m_cs</a>, <a class="el" href="classmrpt_1_1synch_1_1_c_critical_section.html#a10c531e3bd482d9b54ddb83d8a95566c">mrpt::synch::CCriticalSection::enter()</a>, <a class="el" href="_m_t__buffer_8h_source.html#l00044">m_data</a>, and <a class="el" href="classmrpt_1_1synch_1_1_c_critical_section.html#a933e6e22808e8e311cd980837547ef68">mrpt::synch::CCriticalSection::leave()</a>.</p>
</div>
</div>
<a class="anchor" id="abdc888b7a87ece63da9613ca06b10bff"></a><!-- doxytag: member="mrpt::synch::MT_buffer::readAndClear" ref="abdc888b7a87ece63da9613ca06b10bff" args="(vector_byte &d)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::synch::MT_buffer::readAndClear </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacemrpt.html#a3250fe562baad62b3da2e166eb8867df">vector_byte</a> & </td>
<td class="paramname"><em>d</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">d</td><td>Read the whole buffer and empty it. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_m_t__buffer_8h_source.html#l00076">76</a> of file <a class="el" href="_m_t__buffer_8h_source.html">MT_buffer.h</a>.</p>
<p>References <a class="el" href="_m_t__buffer_8h_source.html#l00045">m_cs</a>, <a class="el" href="classmrpt_1_1synch_1_1_c_critical_section.html#a10c531e3bd482d9b54ddb83d8a95566c">mrpt::synch::CCriticalSection::enter()</a>, <a class="el" href="_m_t__buffer_8h_source.html#l00044">m_data</a>, and <a class="el" href="classmrpt_1_1synch_1_1_c_critical_section.html#a933e6e22808e8e311cd980837547ef68">mrpt::synch::CCriticalSection::leave()</a>.</p>
</div>
</div>
<a class="anchor" id="a85f9c57e9320ae2870687a6adc39711f"></a><!-- doxytag: member="mrpt::synch::MT_buffer::size" ref="a85f9c57e9320ae2870687a6adc39711f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t mrpt::synch::MT_buffer::size </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_m_t__buffer_8h_source.html#l00060">60</a> of file <a class="el" href="_m_t__buffer_8h_source.html">MT_buffer.h</a>.</p>
<p>References <a class="el" href="_m_t__buffer_8h_source.html#l00045">m_cs</a>, <a class="el" href="classmrpt_1_1synch_1_1_c_critical_section.html#a10c531e3bd482d9b54ddb83d8a95566c">mrpt::synch::CCriticalSection::enter()</a>, <a class="el" href="_m_t__buffer_8h_source.html#l00044">m_data</a>, and <a class="el" href="classmrpt_1_1synch_1_1_c_critical_section.html#a933e6e22808e8e311cd980837547ef68">mrpt::synch::CCriticalSection::leave()</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a55b74e871b51608673ef1f0739e48b0a"></a><!-- doxytag: member="mrpt::synch::MT_buffer::m_cs" ref="a55b74e871b51608673ef1f0739e48b0a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmrpt_1_1synch_1_1_c_critical_section.html">CCriticalSection</a> <a class="el" href="classmrpt_1_1synch_1_1_m_t__buffer.html#a55b74e871b51608673ef1f0739e48b0a">mrpt::synch::MT_buffer::m_cs</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_m_t__buffer_8h_source.html#l00045">45</a> of file <a class="el" href="_m_t__buffer_8h_source.html">MT_buffer.h</a>.</p>
<p>Referenced by <a class="el" href="_m_t__buffer_8h_source.html#l00053">clear()</a>, <a class="el" href="_m_t__buffer_8h_source.html#l00060">size()</a>, <a class="el" href="_m_t__buffer_8h_source.html#l00069">appendData()</a>, <a class="el" href="_m_t__buffer_8h_source.html#l00076">readAndClear()</a>, and <a class="el" href="_m_t__buffer_8h_source.html#l00084">read()</a>.</p>
</div>
</div>
<a class="anchor" id="aff7ffaf8223bb8d3e8083deaefc75d50"></a><!-- doxytag: member="mrpt::synch::MT_buffer::m_data" ref="aff7ffaf8223bb8d3e8083deaefc75d50" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacemrpt.html#a3250fe562baad62b3da2e166eb8867df">vector_byte</a> <a class="el" href="classmrpt_1_1synch_1_1_m_t__buffer.html#aff7ffaf8223bb8d3e8083deaefc75d50">mrpt::synch::MT_buffer::m_data</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_m_t__buffer_8h_source.html#l00044">44</a> of file <a class="el" href="_m_t__buffer_8h_source.html">MT_buffer.h</a>.</p>
<p>Referenced by <a class="el" href="_m_t__buffer_8h_source.html#l00053">clear()</a>, <a class="el" href="_m_t__buffer_8h_source.html#l00060">size()</a>, <a class="el" href="_m_t__buffer_8h_source.html#l00069">appendData()</a>, <a class="el" href="_m_t__buffer_8h_source.html#l00076">readAndClear()</a>, and <a class="el" href="_m_t__buffer_8h_source.html#l00084">read()</a>.</p>
</div>
</div>
</div>
<br><hr><br> <table border="0" width="100%"> <tr> <td> Page generated by <a href="http://www.doxygen.org" target="_blank">Doxygen 1.7.5</a> for MRPT 0.9.5 SVN: at Sun Sep 25 17:20:18 UTC 2011</td><td></td> <td width="100"> </td> <td width="150"> </td></tr> </table> </body></html>
