Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 2269

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!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: csutil/scopedmutexlock.h Source File (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&nbsp;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><a href="classes.html"><span>Classes</span></a></li>
    <li class="current"><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<h1>csutil/scopedmutexlock.h</h1><a href="scopedmutexlock_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment">  Crystal Space Scoped Mutex Lock Class</span>
<a name="l00003"></a>00003 <span class="comment">  Copyright (C) 2003 by Matze Braun</span>
<a name="l00004"></a>00004 <span class="comment"></span>
<a name="l00005"></a>00005 <span class="comment">  This library is free software; you can redistribute it and/or</span>
<a name="l00006"></a>00006 <span class="comment">  modify it under the terms of the GNU Library General Public</span>
<a name="l00007"></a>00007 <span class="comment">  License as published by the Free Software Foundation; either</span>
<a name="l00008"></a>00008 <span class="comment">  version 2 of the License, or (at your option) any later version.</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment">  This library is distributed in the hope that it will be useful,</span>
<a name="l00011"></a>00011 <span class="comment">  but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00012"></a>00012 <span class="comment">  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00013"></a>00013 <span class="comment">  Library General Public License for more details.</span>
<a name="l00014"></a>00014 <span class="comment"></span>
<a name="l00015"></a>00015 <span class="comment">  You should have received a copy of the GNU Library General Public</span>
<a name="l00016"></a>00016 <span class="comment">  License along with this library; if not, write to the Free</span>
<a name="l00017"></a>00017 <span class="comment">  Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00018"></a>00018 <span class="comment">*/</span>
<a name="l00019"></a>00019 <span class="preprocessor">#ifndef __CSUTIL_SCOPEDMUTEX_H__</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define __CSUTIL_SCOPEDMUTEX_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "csextern.h"</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="thread_8h.html" title="Threading and synchronization support.">csutil/thread.h</a>"</span>
<a name="l00028"></a>00028 
<a name="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="msvc__deprecated__warn__off_8h.html" title="Disable MSVC deprecated warnings.">csutil/win32/msvc_deprecated_warn_off.h</a>"</span>
<a name="l00030"></a>00030 
<a name="l00046"></a><a class="code" href="classcsScopedMutexLock.html">00046</a> <span class="keyword">class </span><a class="code" href="classcsScopedMutexLock.html" title="This is a utility class for locking a Mutex.">csScopedMutexLock</a>
<a name="l00047"></a>00047 {
<a name="l00048"></a>00048 <span class="keyword">public</span>:
<a name="l00049"></a><a class="code" href="classcsScopedMutexLock.html#f27c7c4313d4fb14a906187fed4eae93">00049</a>   <a class="code" href="classcsScopedMutexLock.html#f27c7c4313d4fb14a906187fed4eae93">csScopedMutexLock</a> (<a class="code" href="classcsMutex.html" title="A mutual-exclusion object.">csMutex</a>* newmutex)
<a name="l00050"></a>00050     : <a class="code" href="classcsScopedMutexLock.html#06ed0fd837c43217b9c1d4d008db672b">mutex</a>(newmutex)
<a name="l00051"></a>00051   { <a class="code" href="classcsScopedMutexLock.html#06ed0fd837c43217b9c1d4d008db672b">mutex</a>-&gt;<a class="code" href="classcsMutex.html#9e037cca32b323f1a590d53db570b134" title="Lock the mutex.">LockWait</a> (); }
<a name="l00052"></a><a class="code" href="classcsScopedMutexLock.html#f3f8d24440daef71d3a9769b282d5161">00052</a>   <a class="code" href="classcsScopedMutexLock.html#f3f8d24440daef71d3a9769b282d5161">~csScopedMutexLock</a> ()
<a name="l00053"></a>00053   { <a class="code" href="classcsScopedMutexLock.html#06ed0fd837c43217b9c1d4d008db672b">mutex</a>-&gt;<a class="code" href="classcsMutex.html#ad4921586c4d05e0f008251993a85d74" title="Unlock the mutex.">Release</a> (); }
<a name="l00054"></a>00054 
<a name="l00055"></a><a class="code" href="classcsScopedMutexLock.html#06ed0fd837c43217b9c1d4d008db672b">00055</a>   <a class="code" href="classcsMutex.html" title="A mutual-exclusion object.">csMutex</a>* <a class="code" href="classcsScopedMutexLock.html#06ed0fd837c43217b9c1d4d008db672b">mutex</a>;
<a name="l00056"></a>00056 };
<a name="l00057"></a>00057 
<a name="l00058"></a>00058 <span class="keyword">template</span>&lt;<span class="keyword">class</span> T&gt;
<a name="l00059"></a><a class="code" href="classcsScopedLock.html">00059</a> <span class="keyword">class </span><a class="code" href="classcsScopedLock.html">csScopedLock</a>
<a name="l00060"></a>00060 {
<a name="l00061"></a>00061 <span class="keyword">public</span>:
<a name="l00062"></a><a class="code" href="classcsScopedLock.html#ab4bba5aa777db6612891a2cc7666251">00062</a>   <a class="code" href="classcsScopedLock.html#ab4bba5aa777db6612891a2cc7666251">csScopedLock</a> (T&amp; <a class="code" href="classcsScopedLock.html#c1e6bf572067eed85ad0f71dc2a279a4">lock</a>)
<a name="l00063"></a>00063     : lock (lock)
<a name="l00064"></a>00064   { lock.LockWait (); }
<a name="l00065"></a><a class="code" href="classcsScopedLock.html#b6b5efbb3c1fc3e1acae91e3c17f3422">00065</a>   <a class="code" href="classcsScopedLock.html#b6b5efbb3c1fc3e1acae91e3c17f3422">~csScopedLock</a> ()
<a name="l00066"></a>00066   { <a class="code" href="classcsScopedLock.html#c1e6bf572067eed85ad0f71dc2a279a4">lock</a>.Release (); }
<a name="l00067"></a>00067 
<a name="l00068"></a><a class="code" href="classcsScopedLock.html#c1e6bf572067eed85ad0f71dc2a279a4">00068</a>   T&amp; <a class="code" href="classcsScopedLock.html#c1e6bf572067eed85ad0f71dc2a279a4">lock</a>;
<a name="l00069"></a>00069 };
<a name="l00070"></a>00070 
<a name="l00071"></a>00071 <span class="preprocessor">#include "<a class="code" href="msvc__deprecated__warn__on_8h.html" title="Re-enable MSVC deprecated warnings.">csutil/win32/msvc_deprecated_warn_on.h</a>"</span>
<a name="l00072"></a>00072 
<a name="l00073"></a>00073 <span class="preprocessor">#endif</span>
<a name="l00074"></a>00074 <span class="preprocessor"></span>
</pre></div><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>