<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>Crystal Space 1.2.1: CS::Threading::ScopedLock< T > Class Template Reference (Crystal Space 1.2.1 Public API Reference)</title> <link href="tabs.css" rel="stylesheet" type="text/css"> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <table border="0" cellpadding="0" cellspacing="0" width="100%" class="head"> <tr height="59"> <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td> <td class="head"><h2>Public API Reference</h2></td> </tr> <tr height="11"> <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td> </tr> </table> <div class="content"> <!-- Generated by Doxygen 1.5.3 --> <div class="tabs"> <ul> <li><a href="index.html"><span>Main 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 class="current"><a href="classes.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="classes.html"><span>Alphabetical List</span></a></li> <li><a href="annotated.html"><span>Class List</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="nav"> <a class="el" href="namespaceCS.html">CS</a>::<a class="el" href="namespaceCS_1_1Threading.html">Threading</a>::<a class="el" href="classCS_1_1Threading_1_1ScopedLock.html">ScopedLock</a></div> <h1>CS::Threading::ScopedLock< T > Class Template Reference</h1><!-- doxytag: class="CS::Threading::ScopedLock" -->This is a utility class for locking a Mutex. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="mutex_8h-source.html">csutil/threading/mutex.h</a>></code> <p> <p> <a href="classCS_1_1Threading_1_1ScopedLock-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="79e6c5ff51f56878ba40bb543a2db1b0"></a><!-- doxytag: member="CS::Threading::ScopedLock::ScopedLock" ref="79e6c5ff51f56878ba40bb543a2db1b0" args="(T &lockObj)" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Threading_1_1ScopedLock.html#79e6c5ff51f56878ba40bb543a2db1b0">ScopedLock</a> (T &lockObj)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2bdefaa142d8ef263299ddcd339fa0e2"></a><!-- doxytag: member="CS::Threading::ScopedLock::~ScopedLock" ref="2bdefaa142d8ef263299ddcd339fa0e2" args="()" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Threading_1_1ScopedLock.html#2bdefaa142d8ef263299ddcd339fa0e2">~ScopedLock</a> ()</td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> <h3>template<typename T><br> class CS::Threading::ScopedLock< T ></h3> This is a utility class for locking a Mutex. <p> If a <a class="el" href="classCS_1_1Threading_1_1ScopedLock.html" title="This is a utility class for locking a Mutex.">ScopedLock</a> class is created it locks the mutex, when it is destroyed it unlocks the Mutex again. So locking a mutex can happen by creating a <a class="el" href="classCS_1_1Threading_1_1ScopedLock.html" title="This is a utility class for locking a Mutex.">ScopedLock</a> object on the stack. The compiler will then take care that the Unlock calls will be done in each case. <div class="fragment"><pre class="fragment"> <span class="keywordtype">void</span> Myfunc() { <a class="code" href="classCS_1_1Threading_1_1ScopedLock.html#79e6c5ff51f56878ba40bb543a2db1b0">ScopedLock</a> lock(mymutex); <span class="keywordflow">do</span> something special <span class="keywordflow">return</span>; } </pre></div> <p>Definition at line <a class="el" href="mutex_8h-source.html#l00143">143</a> of file <a class="el" href="mutex_8h-source.html">mutex.h</a>.</p> <hr>The documentation for this class was generated from the following file:<ul> <li>csutil/threading/<a class="el" href="mutex_8h-source.html">mutex.h</a></ul> <hr size="1"><address><small>Generated for Crystal Space 1.2.1 by <a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 </small></address> </div></body> </html>