<!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::CCriticalSection 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_c_critical_section.html">CCriticalSection</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="#pri-attribs">Private Attributes</a> </div>
<div class="headertitle">
<div class="title">mrpt::synch::CCriticalSection 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::CCriticalSection" --><hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>This class provides simple critical sections functionality. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classmrpt_1_1synch_1_1_c_critical_section_locker.html" title="A class acquiring a CCriticalSection at its constructor, and releasing it at destructor.">CCriticalSectionLocker</a> </dd></dl>
</div>
<p><code>#include <<a class="el" href="_c_critical_section_8h_source.html">mrpt/synch/CCriticalSection.h</a>></code></p>
<p><a href="classmrpt_1_1synch_1_1_c_critical_section-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_c_critical_section.html#a7707a085d099af8c744dbc199ad7a329">CCriticalSection</a> (const char *name=NULL)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a7707a085d099af8c744dbc199ad7a329"></a><br/></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_c_critical_section.html#a746eb59b31a2a00f04f66ee36d2207a5">~CCriticalSection</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a746eb59b31a2a00f04f66ee36d2207a5"></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_1synch_1_1_c_critical_section.html#a10c531e3bd482d9b54ddb83d8a95566c">enter</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enter. <a href="#a10c531e3bd482d9b54ddb83d8a95566c"></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_1synch_1_1_c_critical_section.html#a933e6e22808e8e311cd980837547ef68">leave</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Leave </p>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">If</td><td>the calling thread is not the current owener of the critical section. </td></tr>
</table>
</dd>
</dl>
<a href="#a933e6e22808e8e311cd980837547ef68"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1string.html">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1synch_1_1_c_critical_section.html#aa53d710a5437a061a64427a4bb8f54b9">getName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the name used in the constructor. <a href="#aa53d710a5437a061a64427a4bb8f54b9"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmrpt_1_1utils_1_1_c_stream.html">utils::CStream</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1synch_1_1_c_critical_section.html#ad9b7e77f9b0f54091956555da67d1e17">m_debugOut</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">If set to a non-NULL value, debug messages regarding the calling threads IDs will be output. <a href="#ad9b7e77f9b0f54091956555da67d1e17"></a><br/></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="classmrpt_1_1utils_1_1_c_referenced_mem_block.html">utils::CReferencedMemBlock</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1synch_1_1_c_critical_section.html#a8b446364cac14c330ba611d948f134e8">m_data</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The OS-dependent descriptors. <a href="#a8b446364cac14c330ba611d948f134e8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1string.html">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1synch_1_1_c_critical_section.html#a5d5ff1942bbc7a5218081dca3c96e7a6">m_name</a></td></tr>
</table>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a7707a085d099af8c744dbc199ad7a329"></a><!-- doxytag: member="mrpt::synch::CCriticalSection::CCriticalSection" ref="a7707a085d099af8c744dbc199ad7a329" args="(const char *name=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mrpt::synch::CCriticalSection::CCriticalSection </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em> = <code>NULL</code></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
</div>
</div>
<a class="anchor" id="a746eb59b31a2a00f04f66ee36d2207a5"></a><!-- doxytag: member="mrpt::synch::CCriticalSection::~CCriticalSection" ref="a746eb59b31a2a00f04f66ee36d2207a5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mrpt::synch::CCriticalSection::~CCriticalSection </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a10c531e3bd482d9b54ddb83d8a95566c"></a><!-- doxytag: member="mrpt::synch::CCriticalSection::enter" ref="a10c531e3bd482d9b54ddb83d8a95566c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::synch::CCriticalSection::enter </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Enter. </p>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">If</td><td>the calling thread already possesses this critical section (it would be a dead-lock). </td></tr>
</table>
</dd>
</dl>
<p>Referenced by <a class="el" href="_c_console_redirector_8h_source.html#l00114">mrpt::utils::CConsoleRedirector::overflow()</a>, <a class="el" href="_c_console_redirector_8h_source.html#l00135">mrpt::utils::CConsoleRedirector::sync()</a>, <a class="el" href="_m_t__buffer_8h_source.html#l00053">mrpt::synch::MT_buffer::clear()</a>, <a class="el" href="_m_t__buffer_8h_source.html#l00060">mrpt::synch::MT_buffer::size()</a>, <a class="el" href="_m_t__buffer_8h_source.html#l00069">mrpt::synch::MT_buffer::appendData()</a>, <a class="el" href="_m_t__buffer_8h_source.html#l00076">mrpt::synch::MT_buffer::readAndClear()</a>, and <a class="el" href="_m_t__buffer_8h_source.html#l00084">mrpt::synch::MT_buffer::read()</a>.</p>
</div>
</div>
<a class="anchor" id="aa53d710a5437a061a64427a4bb8f54b9"></a><!-- doxytag: member="mrpt::synch::CCriticalSection::getName" ref="aa53d710a5437a061a64427a4bb8f54b9" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstd_1_1string.html">std::string</a> mrpt::synch::CCriticalSection::getName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the name used in the constructor. </p>
<p>Definition at line <a class="el" href="_c_critical_section_8h_source.html#l00078">78</a> of file <a class="el" href="_c_critical_section_8h_source.html">CCriticalSection.h</a>.</p>
</div>
</div>
<a class="anchor" id="a933e6e22808e8e311cd980837547ef68"></a><!-- doxytag: member="mrpt::synch::CCriticalSection::leave" ref="a933e6e22808e8e311cd980837547ef68" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::synch::CCriticalSection::leave </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Leave </p>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">If</td><td>the calling thread is not the current owener of the critical section. </td></tr>
</table>
</dd>
</dl>
</p>
<p>Referenced by <a class="el" href="_c_console_redirector_8h_source.html#l00114">mrpt::utils::CConsoleRedirector::overflow()</a>, <a class="el" href="_c_console_redirector_8h_source.html#l00135">mrpt::utils::CConsoleRedirector::sync()</a>, <a class="el" href="_m_t__buffer_8h_source.html#l00053">mrpt::synch::MT_buffer::clear()</a>, <a class="el" href="_m_t__buffer_8h_source.html#l00060">mrpt::synch::MT_buffer::size()</a>, <a class="el" href="_m_t__buffer_8h_source.html#l00069">mrpt::synch::MT_buffer::appendData()</a>, <a class="el" href="_m_t__buffer_8h_source.html#l00076">mrpt::synch::MT_buffer::readAndClear()</a>, and <a class="el" href="_m_t__buffer_8h_source.html#l00084">mrpt::synch::MT_buffer::read()</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a8b446364cac14c330ba611d948f134e8"></a><!-- doxytag: member="mrpt::synch::CCriticalSection::m_data" ref="a8b446364cac14c330ba611d948f134e8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmrpt_1_1utils_1_1_c_referenced_mem_block.html">utils::CReferencedMemBlock</a> <a class="el" href="classmrpt_1_1synch_1_1_c_critical_section.html#a8b446364cac14c330ba611d948f134e8">mrpt::synch::CCriticalSection::m_data</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The OS-dependent descriptors. </p>
<p>Definition at line <a class="el" href="_c_critical_section_8h_source.html#l00055">55</a> of file <a class="el" href="_c_critical_section_8h_source.html">CCriticalSection.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad9b7e77f9b0f54091956555da67d1e17"></a><!-- doxytag: member="mrpt::synch::CCriticalSection::m_debugOut" ref="ad9b7e77f9b0f54091956555da67d1e17" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmrpt_1_1utils_1_1_c_stream.html">utils::CStream</a>* <a class="el" href="classmrpt_1_1synch_1_1_c_critical_section.html#ad9b7e77f9b0f54091956555da67d1e17">mrpt::synch::CCriticalSection::m_debugOut</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>If set to a non-NULL value, debug messages regarding the calling threads IDs will be output. </p>
<p>Definition at line <a class="el" href="_c_critical_section_8h_source.html#l00082">82</a> of file <a class="el" href="_c_critical_section_8h_source.html">CCriticalSection.h</a>.</p>
</div>
</div>
<a class="anchor" id="a5d5ff1942bbc7a5218081dca3c96e7a6"></a><!-- doxytag: member="mrpt::synch::CCriticalSection::m_name" ref="a5d5ff1942bbc7a5218081dca3c96e7a6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstd_1_1string.html">std::string</a> <a class="el" href="classmrpt_1_1synch_1_1_c_critical_section.html#a5d5ff1942bbc7a5218081dca3c96e7a6">mrpt::synch::CCriticalSection::m_name</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_c_critical_section_8h_source.html#l00057">57</a> of file <a class="el" href="_c_critical_section_8h_source.html">CCriticalSection.h</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>
