<!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::utils::CThreadSafeQueue 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_1utils.html">utils</a> </li>
<li class="navelem"><a class="el" href="classmrpt_1_1utils_1_1_c_thread_safe_queue.html">CThreadSafeQueue</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">mrpt::utils::CThreadSafeQueue Class Reference<div class="ingroups"><a class="el" href="group__mrpt__base__grp.html">[mrpt-base]</a></div></div> </div>
</div>
<div class="contents">
<!-- doxytag: class="mrpt::utils::CThreadSafeQueue" --><hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A thread-safe template queue for object passing between threads; for a template argument of T, the objects being passed in the queue are "T*". </p>
<p>Usage example:</p>
<div class="fragment"><pre class="fragment"> <span class="comment">// Declaration:</span>
CThreadSafeQueue<MyMsgType> tsq;
...
<span class="comment">// Thread 1: Write</span>
{
MyMsgType *msg = <span class="keyword">new</span> MyMsgType;
msg->...
tsq.push(msg); <span class="comment">// Insert in the queue</span>
}
<span class="comment">// Thread 2: Read</span>
{
MyMsgType *msg = tsq.get();
<span class="keywordflow">if</span> (msg)
{
<span class="comment">// Process "msg"...</span>
<span class="keyword">delete</span> msg;
}
}
</pre></div><p>Note that only dynamically allocated objects can be inserted with <em><a class="el" href="classmrpt_1_1utils_1_1_c_thread_safe_queue.html#a3cba7cc96b89b8539f69c6bba9e3940f" title="Insert a new message in the queue - The object must be created with "new", and do not delete is after...">push()</a></em> and that freeing that memory if responsibility of the receiver of this queue as it receives objects with <em><a class="el" href="classmrpt_1_1utils_1_1_c_thread_safe_queue.html#ac41b3e4ee6ac2f9feba0a92f00a6921d" title="Retrieve the next message in the queue, or NULL if there is no message.">get()</a></em>. However, elements still in the queue upon destruction will be deleted automatically.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__mrpt__base__grp.html#gac9ce1b1023816c8f0cdba36331748601" title="A thread-safe class for message passing between threads.">mrpt::utils::CMessageQueue</a> </dd></dl>
</div>
<p><code>#include <<a class="el" href="_c_thread_safe_queue_8h_source.html">mrpt/utils/CThreadSafeQueue.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for mrpt::utils::CThreadSafeQueue:</div>
<div class="dyncontent">
<div class="center"><img src="classmrpt_1_1utils_1_1_c_thread_safe_queue__inherit__graph.png" border="0" usemap="#mrpt_1_1utils_1_1_c_thread_safe_queue_inherit__map" alt="Inheritance graph"/></div>
<map name="mrpt_1_1utils_1_1_c_thread_safe_queue_inherit__map" id="mrpt_1_1utils_1_1_c_thread_safe_queue_inherit__map">
<area shape="rect" id="node3" href="classmrpt_1_1utils_1_1_c_thread_safe_queue.html" title="mrpt::utils::CThreadSafeQueue\< CMessage \>" alt="" coords="5,96,296,123"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classmrpt_1_1utils_1_1_c_thread_safe_queue-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_1utils_1_1_c_thread_safe_queue.html#ac19afc344f5d65b583761365eea991c0">CThreadSafeQueue</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default ctor. <a href="#ac19afc344f5d65b583761365eea991c0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_thread_safe_queue.html#afdf23fcf3d171a0d75ba005224313823">~CThreadSafeQueue</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_thread_safe_queue.html#ae3060579243c2bf32df1722b3c2411bc">clear</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear the queue of messages, freeing memory as required. <a href="#ae3060579243c2bf32df1722b3c2411bc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_thread_safe_queue.html#a3cba7cc96b89b8539f69c6bba9e3940f">push</a> (T *msg)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Insert a new message in the queue - The object must be created with "new", and do not delete is after calling this, it must be deleted later. <a href="#a3cba7cc96b89b8539f69c6bba9e3940f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_thread_safe_queue.html#ac41b3e4ee6ac2f9feba0a92f00a6921d">get</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the next message in the queue, or NULL if there is no message. <a href="#ac41b3e4ee6ac2f9feba0a92f00a6921d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_thread_safe_queue.html#adb12ba857223a06ad976663b37aa6b98">get_lastest_purge_old</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Skip all old messages in the queue and directly return the last one (the most recent, at the bottom of the queue), or NULL if there is no message. <a href="#adb12ba857223a06ad976663b37aa6b98"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_thread_safe_queue.html#a2ec09a8de0a97b2d4964b4cc206e502a">empty</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return true if there are no messages. <a href="#a2ec09a8de0a97b2d4964b4cc206e502a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_thread_safe_queue.html#a96c606465f2ff1a0ab87bedfafd66d41">size</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of queued messages. <a href="#a96c606465f2ff1a0ab87bedfafd66d41"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1queue.html">std::queue</a>< T * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_thread_safe_queue.html#a5caf669f62ffa838a0f403e3886f4ab7">m_msgs</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The queue of messages. Memory is freed at destructor or by clients gathering messages. <a href="#a5caf669f62ffa838a0f403e3886f4ab7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmrpt_1_1synch_1_1_c_critical_section.html">mrpt::synch::CCriticalSection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_thread_safe_queue.html#a9c52731adae51563bfe297ff84f85ccf">m_csQueue</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The critical section. <a href="#a9c52731adae51563bfe297ff84f85ccf"></a><br/></td></tr>
</table>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ac19afc344f5d65b583761365eea991c0"></a><!-- doxytag: member="mrpt::utils::CThreadSafeQueue::CThreadSafeQueue" ref="ac19afc344f5d65b583761365eea991c0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mrpt::utils::CThreadSafeQueue::CThreadSafeQueue </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default ctor. </p>
<p>Definition at line <a class="el" href="_c_thread_safe_queue_8h_source.html#l00081">81</a> of file <a class="el" href="_c_thread_safe_queue_8h_source.html">CThreadSafeQueue.h</a>.</p>
</div>
</div>
<a class="anchor" id="afdf23fcf3d171a0d75ba005224313823"></a><!-- doxytag: member="mrpt::utils::CThreadSafeQueue::~CThreadSafeQueue" ref="afdf23fcf3d171a0d75ba005224313823" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual mrpt::utils::CThreadSafeQueue::~CThreadSafeQueue </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="_c_thread_safe_queue_8h_source.html#l00083">83</a> of file <a class="el" href="_c_thread_safe_queue_8h_source.html">CThreadSafeQueue.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae3060579243c2bf32df1722b3c2411bc"></a><!-- doxytag: member="mrpt::utils::CThreadSafeQueue::clear" ref="ae3060579243c2bf32df1722b3c2411bc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::utils::CThreadSafeQueue::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>Clear the queue of messages, freeing memory as required. </p>
<p>Definition at line <a class="el" href="_c_thread_safe_queue_8h_source.html#l00089">89</a> of file <a class="el" href="_c_thread_safe_queue_8h_source.html">CThreadSafeQueue.h</a>.</p>
<p>Referenced by <a class="el" href="_c_thread_safe_queue_8h_source.html#l00083">mrpt::utils::CThreadSafeQueue< CMessage >::~CThreadSafeQueue()</a>.</p>
</div>
</div>
<a class="anchor" id="a2ec09a8de0a97b2d4964b4cc206e502a"></a><!-- doxytag: member="mrpt::utils::CThreadSafeQueue::empty" ref="a2ec09a8de0a97b2d4964b4cc206e502a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mrpt::utils::CThreadSafeQueue::empty </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return true if there are no messages. </p>
<p>Definition at line <a class="el" href="_c_thread_safe_queue_8h_source.html#l00145">145</a> of file <a class="el" href="_c_thread_safe_queue_8h_source.html">CThreadSafeQueue.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac41b3e4ee6ac2f9feba0a92f00a6921d"></a><!-- doxytag: member="mrpt::utils::CThreadSafeQueue::get" ref="ac41b3e4ee6ac2f9feba0a92f00a6921d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T* mrpt::utils::CThreadSafeQueue::get </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve the next message in the queue, or NULL if there is no message. </p>
<p>The user MUST call "delete" with the returned object after use. </p>
<p>Definition at line <a class="el" href="_c_thread_safe_queue_8h_source.html#l00110">110</a> of file <a class="el" href="_c_thread_safe_queue_8h_source.html">CThreadSafeQueue.h</a>.</p>
</div>
</div>
<a class="anchor" id="adb12ba857223a06ad976663b37aa6b98"></a><!-- doxytag: member="mrpt::utils::CThreadSafeQueue::get_lastest_purge_old" ref="adb12ba857223a06ad976663b37aa6b98" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T* mrpt::utils::CThreadSafeQueue::get_lastest_purge_old </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Skip all old messages in the queue and directly return the last one (the most recent, at the bottom of the queue), or NULL if there is no message. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>The memory of all skipped messages is freed with "delete". </dd>
<dd>
The user MUST call "delete" with the returned object after use. </dd></dl>
<p>Definition at line <a class="el" href="_c_thread_safe_queue_8h_source.html#l00127">127</a> of file <a class="el" href="_c_thread_safe_queue_8h_source.html">CThreadSafeQueue.h</a>.</p>
</div>
</div>
<a class="anchor" id="a3cba7cc96b89b8539f69c6bba9e3940f"></a><!-- doxytag: member="mrpt::utils::CThreadSafeQueue::push" ref="a3cba7cc96b89b8539f69c6bba9e3940f" args="(T *msg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::utils::CThreadSafeQueue::push </td>
<td>(</td>
<td class="paramtype">T * </td>
<td class="paramname"><em>msg</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Insert a new message in the queue - The object must be created with "new", and do not delete is after calling this, it must be deleted later. </p>
<p>Definition at line <a class="el" href="_c_thread_safe_queue_8h_source.html#l00101">101</a> of file <a class="el" href="_c_thread_safe_queue_8h_source.html">CThreadSafeQueue.h</a>.</p>
</div>
</div>
<a class="anchor" id="a96c606465f2ff1a0ab87bedfafd66d41"></a><!-- doxytag: member="mrpt::utils::CThreadSafeQueue::size" ref="a96c606465f2ff1a0ab87bedfafd66d41" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t mrpt::utils::CThreadSafeQueue::size </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the number of queued messages. </p>
<p>Definition at line <a class="el" href="_c_thread_safe_queue_8h_source.html#l00152">152</a> of file <a class="el" href="_c_thread_safe_queue_8h_source.html">CThreadSafeQueue.h</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a9c52731adae51563bfe297ff84f85ccf"></a><!-- doxytag: member="mrpt::utils::CThreadSafeQueue::m_csQueue" ref="a9c52731adae51563bfe297ff84f85ccf" 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">mrpt::synch::CCriticalSection</a> <a class="el" href="classmrpt_1_1utils_1_1_c_thread_safe_queue.html#a9c52731adae51563bfe297ff84f85ccf">mrpt::utils::CThreadSafeQueue::m_csQueue</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The critical section. </p>
<p>Definition at line <a class="el" href="_c_thread_safe_queue_8h_source.html#l00078">78</a> of file <a class="el" href="_c_thread_safe_queue_8h_source.html">CThreadSafeQueue.h</a>.</p>
<p>Referenced by <a class="el" href="_c_thread_safe_queue_8h_source.html#l00089">mrpt::utils::CThreadSafeQueue< CMessage >::clear()</a>, <a class="el" href="_c_thread_safe_queue_8h_source.html#l00101">mrpt::utils::CThreadSafeQueue< CMessage >::push()</a>, <a class="el" href="_c_thread_safe_queue_8h_source.html#l00110">mrpt::utils::CThreadSafeQueue< CMessage >::get()</a>, <a class="el" href="_c_thread_safe_queue_8h_source.html#l00127">mrpt::utils::CThreadSafeQueue< CMessage >::get_lastest_purge_old()</a>, <a class="el" href="_c_thread_safe_queue_8h_source.html#l00145">mrpt::utils::CThreadSafeQueue< CMessage >::empty()</a>, and <a class="el" href="_c_thread_safe_queue_8h_source.html#l00152">mrpt::utils::CThreadSafeQueue< CMessage >::size()</a>.</p>
</div>
</div>
<a class="anchor" id="a5caf669f62ffa838a0f403e3886f4ab7"></a><!-- doxytag: member="mrpt::utils::CThreadSafeQueue::m_msgs" ref="a5caf669f62ffa838a0f403e3886f4ab7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstd_1_1queue.html">std::queue</a><T*> <a class="el" href="classmrpt_1_1utils_1_1_c_thread_safe_queue.html#a5caf669f62ffa838a0f403e3886f4ab7">mrpt::utils::CThreadSafeQueue::m_msgs</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The queue of messages. Memory is freed at destructor or by clients gathering messages. </p>
<p>Definition at line <a class="el" href="_c_thread_safe_queue_8h_source.html#l00077">77</a> of file <a class="el" href="_c_thread_safe_queue_8h_source.html">CThreadSafeQueue.h</a>.</p>
<p>Referenced by <a class="el" href="_c_thread_safe_queue_8h_source.html#l00089">mrpt::utils::CThreadSafeQueue< CMessage >::clear()</a>, <a class="el" href="_c_thread_safe_queue_8h_source.html#l00101">mrpt::utils::CThreadSafeQueue< CMessage >::push()</a>, <a class="el" href="_c_thread_safe_queue_8h_source.html#l00110">mrpt::utils::CThreadSafeQueue< CMessage >::get()</a>, <a class="el" href="_c_thread_safe_queue_8h_source.html#l00127">mrpt::utils::CThreadSafeQueue< CMessage >::get_lastest_purge_old()</a>, <a class="el" href="_c_thread_safe_queue_8h_source.html#l00145">mrpt::utils::CThreadSafeQueue< CMessage >::empty()</a>, and <a class="el" href="_c_thread_safe_queue_8h_source.html#l00152">mrpt::utils::CThreadSafeQueue< CMessage >::size()</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>
