<!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>The MRPT project: mrpt::utils::CThreadSafeQueue< T > Class Template 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.6.2-20100208 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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="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">
<img id="MSearchSelect" src="search/search.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</div>
</li>
</ul>
</div>
<div class="tabs">
<ul>
<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="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespacemrpt.html">mrpt</a>::<a class="el" href="namespacemrpt_1_1utils.html">utils</a>::<a class="el" href="classmrpt_1_1utils_1_1_c_thread_safe_queue.html">CThreadSafeQueue</a>
</div>
</div>
<div class="contents">
<h1>mrpt::utils::CThreadSafeQueue< T > Class Template Reference</h1><!-- doxytag: class="mrpt::utils::CThreadSafeQueue" -->
<p>A thread-safe template queue for object passing between threads, with objects being passed being "T*".
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="_c_thread_safe_queue_8h_source.html">mrpt/utils/CThreadSafeQueue.h</a>></code></p>
<div class="dynheader">
Collaboration diagram for mrpt::utils::CThreadSafeQueue< T >:</div>
<div class="dynsection">
<div class="center"><img src="classmrpt_1_1utils_1_1_c_thread_safe_queue__coll__graph.png" border="0" usemap="#mrpt_1_1utils_1_1_c_thread_safe_queue_3_01_t_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="mrpt_1_1utils_1_1_c_thread_safe_queue_3_01_t_01_4_coll__map" id="mrpt_1_1utils_1_1_c_thread_safe_queue_3_01_t_01_4_coll__map">
<area shape="rect" id="node24" title="STL class." alt="" coords="112,101,261,131"/><area shape="rect" id="node6" href="classmrpt_1_1synch_1_1_c_critical_section.html" title="This class provides simple critical sections functionality." alt="" coords="263,672,457,701"/><area shape="rect" id="node8" href="classmrpt_1_1utils_1_1_c_stream.html" title="This base class is used to provide a unified interface to files,memory buffers,...." alt="" coords="343,576,481,605"/><area shape="rect" id="node10" title="STL class." alt="" coords="505,576,585,605"/><area shape="rect" id="node12" title="STL class." alt="" coords="463,496,628,525"/><area shape="rect" id="node14" href="classmrpt_1_1utils_1_1_c_referenced_mem_block.html" title="Represents a memory block (via "void*") that can be shared between several..." alt="" coords="92,576,319,605"/><area shape="rect" id="node16" href="classstlplus_1_1smart__ptr.html" title="stlplus::smart_ptr\< vector_byte \>" alt="" coords="140,496,353,525"/><area shape="rect" id="node18" href="classstlplus_1_1smart__ptr__base.html" title="stlplus::smart_ptr_base\< vector_byte, constructor_copy\< vector_byte \> \>" alt="" coords="85,400,536,429"/><area shape="rect" id="node20" href="classstlplus_1_1smart__ptr__holder.html" title="stlplus::smart_ptr_holder\< vector_byte \>" alt="" coords="183,304,439,333"/><area shape="rect" id="node22" href="structmrpt_1_1mrpt__base__vector.html" title="Numeric vectors compatible with mrpt/math/ops_containers.h:." alt="" coords="85,208,312,237"/><area shape="rect" id="node27" href="classmrpt_1_1synch_1_1_c_atomic_counter.html" title="This class acts exactly as an int (or long) variable, but with atomic increment and..." alt="" coords="336,208,531,237"/></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 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="classmrpt_1_1utils_1_1_c_thread_safe_queue.html#a35a01b900e4cdce5b1c955e657895057">CThreadSafeQueue</a> ()</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#ac7dad3f01de17692bdcd9b3e0bba5f7d">~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#a3c9d058a1104ccd5bc13ee8656712021">clear</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#a49bc2c3632569b3f92d603cecf25d79a">push</a> (T *msg)</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#aab39ca1635bd934753c394d53f835ce3">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="#aab39ca1635bd934753c394d53f835ce3"></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#adaea826d026e3a9a857a8dc2f2abc9ce">empty</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">< Return true if there are no messages. <a href="#adaea826d026e3a9a857a8dc2f2abc9ce"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::queue< T * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_thread_safe_queue.html#aa4eb9124b7cc70e54ff4289c59e92c6a">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="#aa4eb9124b7cc70e54ff4289c59e92c6a"></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#ac847fab967bbe4681ebab13c5b1fe0c1">m_csQueue</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The critical section. <a href="#ac847fab967bbe4681ebab13c5b1fe0c1"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<class T><br/>
class mrpt::utils::CThreadSafeQueue< T ></h3>
<p>A thread-safe template queue for object passing between threads, with objects being passed being "T*". </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="namespacemrpt_1_1utils.html#ac9ce1b1023816c8f0cdba36331748601" title="A thread-safe class for message passing between threads.">mrpt::utils::CMessageQueue</a> </dd></dl>
<p>Definition at line <a class="el" href="_c_thread_safe_queue_8h_source.html#l00043">43</a> of file <a class="el" href="_c_thread_safe_queue_8h_source.html">CThreadSafeQueue.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a35a01b900e4cdce5b1c955e657895057"></a><!-- doxytag: member="mrpt::utils::CThreadSafeQueue::CThreadSafeQueue" ref="a35a01b900e4cdce5b1c955e657895057" 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="classmrpt_1_1utils_1_1_c_thread_safe_queue.html">mrpt::utils::CThreadSafeQueue</a>< T >::<a class="el" href="classmrpt_1_1utils_1_1_c_thread_safe_queue.html">CThreadSafeQueue</a> </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="_c_thread_safe_queue_8h_source.html#l00049">49</a> of file <a class="el" href="_c_thread_safe_queue_8h_source.html">CThreadSafeQueue.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac7dad3f01de17692bdcd9b3e0bba5f7d"></a><!-- doxytag: member="mrpt::utils::CThreadSafeQueue::~CThreadSafeQueue" ref="ac7dad3f01de17692bdcd9b3e0bba5f7d" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classmrpt_1_1utils_1_1_c_thread_safe_queue.html">mrpt::utils::CThreadSafeQueue</a>< T >::~<a class="el" href="classmrpt_1_1utils_1_1_c_thread_safe_queue.html">CThreadSafeQueue</a> </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#l00053">53</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="a3c9d058a1104ccd5bc13ee8656712021"></a><!-- doxytag: member="mrpt::utils::CThreadSafeQueue::clear" ref="a3c9d058a1104ccd5bc13ee8656712021" 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="classmrpt_1_1utils_1_1_c_thread_safe_queue.html">mrpt::utils::CThreadSafeQueue</a>< T >::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="_c_thread_safe_queue_8h_source.html#l00058">58</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#l00053">mrpt::utils::CThreadSafeQueue< CMessage >::~CThreadSafeQueue()</a>.</p>
</div>
</div>
<a class="anchor" id="adaea826d026e3a9a857a8dc2f2abc9ce"></a><!-- doxytag: member="mrpt::utils::CThreadSafeQueue::empty" ref="adaea826d026e3a9a857a8dc2f2abc9ce" args="() const " -->
<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="classmrpt_1_1utils_1_1_c_thread_safe_queue.html">mrpt::utils::CThreadSafeQueue</a>< T >::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#l00090">90</a> of file <a class="el" href="_c_thread_safe_queue_8h_source.html">CThreadSafeQueue.h</a>.</p>
</div>
</div>
<a class="anchor" id="aab39ca1635bd934753c394d53f835ce3"></a><!-- doxytag: member="mrpt::utils::CThreadSafeQueue::get" ref="aab39ca1635bd934753c394d53f835ce3" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="memname">
<tr>
<td class="memname">T* <a class="el" href="classmrpt_1_1utils_1_1_c_thread_safe_queue.html">mrpt::utils::CThreadSafeQueue</a>< T >::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#l00077">77</a> of file <a class="el" href="_c_thread_safe_queue_8h_source.html">CThreadSafeQueue.h</a>.</p>
</div>
</div>
<a class="anchor" id="a49bc2c3632569b3f92d603cecf25d79a"></a><!-- doxytag: member="mrpt::utils::CThreadSafeQueue::push" ref="a49bc2c3632569b3f92d603cecf25d79a" args="(T *msg)" -->
<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="classmrpt_1_1utils_1_1_c_thread_safe_queue.html">mrpt::utils::CThreadSafeQueue</a>< T >::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">
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>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. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_c_thread_safe_queue_8h_source.html#l00068">68</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="ac847fab967bbe4681ebab13c5b1fe0c1"></a><!-- doxytag: member="mrpt::utils::CThreadSafeQueue::m_csQueue" ref="ac847fab967bbe4681ebab13c5b1fe0c1" 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="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">mrpt::utils::CThreadSafeQueue</a>< T >::<a class="el" href="classmrpt_1_1utils_1_1_c_thread_safe_queue.html#ac847fab967bbe4681ebab13c5b1fe0c1">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#l00047">47</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#l00058">mrpt::utils::CThreadSafeQueue< CMessage >::clear()</a>, <a class="el" href="_c_thread_safe_queue_8h_source.html#l00090">mrpt::utils::CThreadSafeQueue< CMessage >::empty()</a>, <a class="el" href="_c_thread_safe_queue_8h_source.html#l00077">mrpt::utils::CThreadSafeQueue< CMessage >::get()</a>, and <a class="el" href="_c_thread_safe_queue_8h_source.html#l00068">mrpt::utils::CThreadSafeQueue< CMessage >::push()</a>.</p>
</div>
</div>
<a class="anchor" id="aa4eb9124b7cc70e54ff4289c59e92c6a"></a><!-- doxytag: member="mrpt::utils::CThreadSafeQueue::m_msgs" ref="aa4eb9124b7cc70e54ff4289c59e92c6a" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="memname">
<tr>
<td class="memname">std::queue<T*> <a class="el" href="classmrpt_1_1utils_1_1_c_thread_safe_queue.html">mrpt::utils::CThreadSafeQueue</a>< T >::<a class="el" href="classmrpt_1_1utils_1_1_c_thread_safe_queue.html#aa4eb9124b7cc70e54ff4289c59e92c6a">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#l00046">46</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#l00058">mrpt::utils::CThreadSafeQueue< CMessage >::clear()</a>, <a class="el" href="_c_thread_safe_queue_8h_source.html#l00090">mrpt::utils::CThreadSafeQueue< CMessage >::empty()</a>, <a class="el" href="_c_thread_safe_queue_8h_source.html#l00077">mrpt::utils::CThreadSafeQueue< CMessage >::get()</a>, and <a class="el" href="_c_thread_safe_queue_8h_source.html#l00068">mrpt::utils::CThreadSafeQueue< CMessage >::push()</a>.</p>
</div>
</div>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<br><hr><br> <table border="0" width="100%"> <tr> <td> Page generated by <a href="http://www.doxygen.org" target="_blank">Doxygen 1.6.2-20100208</a> for MRPT 0.9.0 SVN: at Wed Jul 14 12:48:09 UTC 2010</td><td></td> <td width="100"> </td> <td width="150"> </td></tr> </table> </body></html>
