<!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>ost::MutexLock class Reference</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body bgcolor="#ffffff"> <!-- Generated by Doxygen 1.2.10 --> <center> <a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center> <hr><h1>ost::MutexLock Class Reference</h1>The <a class="el" href="classost_1_1_mutex_lock.html">MutexLock</a> class is used to protect a section of code so that at any given time only a single thread can perform the protected operation. <a class="el" href="classost_1_1_mutex.html">Mutex</a> automatic locker for protected access. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="thread_8h-source.html">thread.h</a>></code> <p> <a href="classost_1_1_mutex_lock-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> <tr><td colspan=2><br><h2>Public Methods</h2></td></tr> <tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classost_1_1_mutex_lock.html#a0">MutexLock</a> (<a class="el" href="classost_1_1_mutex.html">Mutex</a> &_mutex)</td></tr> <tr><td> </td><td><font size=-1><em>Acquire the mutex.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classost_1_1_mutex_lock.html#a1">~MutexLock</a> ()</td></tr> <tr><td> </td><td><font size=-1><em>Release the mutex automatically.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> The <a class="el" href="classost_1_1_mutex_lock.html">MutexLock</a> class is used to protect a section of code so that at any given time only a single thread can perform the protected operation. <a class="el" href="classost_1_1_mutex.html">Mutex</a> automatic locker for protected access. <p> It use <a class="el" href="classost_1_1_mutex.html">Mutex</a> to protect operation. Using this class is usefull and exception safe. <p> A common use is <p> void func_to_protect() { <a class="el" href="classost_1_1_mutex_lock.html">MutexLock</a> lock(mutex); ... operation ... } <p> NOTE: do not declare variable as "<a class="el" href="classost_1_1_mutex_lock.html">MutexLock</a> (mutex)", the mutex will be released at statement end. <p> <dl compact><dt><b> Author: </b><dd> Frediano Ziglio <<a href="mailto:freddy77@angelfire.com">freddy77@angelfire.com</a>> </dl> <p> <hr><h2>Constructor & Destructor Documentation</h2> <a name="a0" doxytag="ost::MutexLock::MutexLock"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> ost::MutexLock::MutexLock </td> <td class="md">( </td> <td class="md"><a class="el" href="classost_1_1_mutex.html">Mutex</a> &</td> <td class="mdname1"> <em>_mutex</em> </td> <td class="md">) </td> <td class="md"><code> [inline]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Acquire the mutex. <p> </td> </tr> </table> <a name="a1" doxytag="ost::MutexLock::~MutexLock"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> ost::MutexLock::~MutexLock </td> <td class="md">( </td> <td class="mdname1"> </td> <td class="md">) </td> <td class="md"><code> [inline]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Release the mutex automatically. <p> </td> </tr> </table> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="thread_8h-source.html">thread.h</a></ul> <hr><address><small>Generated at Fri Jan 4 18:51:49 2002 for CommonC++ by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.gif" alt="doxygen" align="middle" border=0 width=110 height=53></a>1.2.10 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, © 1997-2001</small></address> </body> </html>