<!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/threading/mutex.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 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 Pages</span></a></li>
</ul>
</div>
<h1>csutil/threading/mutex.h</h1><a href="mutex_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"> Copyright (C) 2006 by Marten Svanfeldt</span>
<a name="l00003"></a>00003 <span class="comment"></span>
<a name="l00004"></a>00004 <span class="comment"> This library is free software; you can redistribute it and/or</span>
<a name="l00005"></a>00005 <span class="comment"> modify it under the terms of the GNU Lesser General Public</span>
<a name="l00006"></a>00006 <span class="comment"> License as published by the Free Software Foundation; either</span>
<a name="l00007"></a>00007 <span class="comment"> version 2 of the License, or (at your option) any later version.</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment"> This library is distributed in the hope that it will be useful,</span>
<a name="l00010"></a>00010 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00011"></a>00011 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="l00012"></a>00012 <span class="comment"> Library General Public License for more details.</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment"> You should have received a copy of the GNU Library General Public</span>
<a name="l00015"></a>00015 <span class="comment"> License along with this library; if not, write to the Free</span>
<a name="l00016"></a>00016 <span class="comment"> Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00017"></a>00017 <span class="comment">*/</span>
<a name="l00018"></a>00018
<a name="l00019"></a>00019 <span class="preprocessor">#ifndef __CS_CSUTIL_THREADING_MUTEX_H__</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define __CS_CSUTIL_THREADING_MUTEX_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span>
<a name="l00022"></a>00022 <span class="preprocessor">#include "csutil/noncopyable.h"</span>
<a name="l00023"></a>00023
<a name="l00030"></a>00030 <span class="comment">// Include implementation specific versions</span>
<a name="l00031"></a>00031 <span class="preprocessor">#if defined(CS_PLATFORM_WIN32)</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span><span class="preprocessor"># include "csutil/threading/win32_mutex.h"</span>
<a name="l00033"></a>00033 <span class="preprocessor">#elif defined(CS_PLATFORM_UNIX) || \</span>
<a name="l00034"></a>00034 <span class="preprocessor"> defined(CS_PLATFORM_MACOSX)</span>
<a name="l00035"></a>00035 <span class="preprocessor"></span><span class="preprocessor"># include "csutil/threading/pthread_mutex.h"</span>
<a name="l00036"></a>00036 <span class="preprocessor">#else</span>
<a name="l00037"></a>00037 <span class="preprocessor"></span><span class="preprocessor">#error "No threading implementation for your platform"</span>
<a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00039"></a>00039 <span class="preprocessor"></span>
<a name="l00040"></a>00040 <span class="keyword">namespace </span>CS
<a name="l00041"></a>00041 {
<a name="l00042"></a>00042 <span class="keyword">namespace </span>Threading
<a name="l00043"></a>00043 {
<a name="l00044"></a>00044
<a name="l00054"></a>00054 <span class="keyword">template</span><<span class="keyword">typename</span> BaseMutex>
<a name="l00055"></a><a class="code" href="classCS_1_1Threading_1_1MutexImpl.html">00055</a> <span class="keyword">class </span><a class="code" href="classCS_1_1Threading_1_1MutexImpl.html" title="General mutex class.">MutexImpl</a> : <span class="keyword">public</span> BaseMutex,
<a name="l00056"></a>00056 <span class="keyword">private</span> CS::<a class="code" href="classCS_1_1Implementation_1_1NonCopyable__.html" title="Base-class which ensures that derived classes are not copy-constructible or assignable...">NonCopyable</a>
<a name="l00057"></a>00057 {
<a name="l00058"></a>00058 <span class="keyword">public</span>:
<a name="l00062"></a><a class="code" href="classCS_1_1Threading_1_1MutexImpl.html#2166e99cada67e17ffd296b2c2d5c318">00062</a> <a class="code" href="classCS_1_1Threading_1_1MutexImpl.html#2166e99cada67e17ffd296b2c2d5c318" title="Initialize an initially unlocked mutex.">MutexImpl</a> ()
<a name="l00063"></a>00063 {
<a name="l00064"></a>00064 BaseMutex::Initialize ();
<a name="l00065"></a>00065 }
<a name="l00066"></a>00066
<a name="l00070"></a><a class="code" href="classCS_1_1Threading_1_1MutexImpl.html#67dafe9e16692afb83d2dbd3bdc02cf8">00070</a> <a class="code" href="classCS_1_1Threading_1_1MutexImpl.html#67dafe9e16692afb83d2dbd3bdc02cf8" title="Destroy mutex.">~MutexImpl</a> ()
<a name="l00071"></a>00071 {
<a name="l00072"></a>00072 BaseMutex::Destroy ();
<a name="l00073"></a>00073 }
<a name="l00074"></a>00074
<a name="l00080"></a><a class="code" href="classCS_1_1Threading_1_1MutexImpl.html#d34e0160362cdd1d6805e58a84d4a406">00080</a> <span class="keywordtype">bool</span> <a class="code" href="classCS_1_1Threading_1_1MutexImpl.html#d34e0160362cdd1d6805e58a84d4a406" title="Acquire lock on mutex.">Lock</a> ()
<a name="l00081"></a>00081 {
<a name="l00082"></a>00082 <span class="keywordflow">return</span> BaseMutex::Lock ();
<a name="l00083"></a>00083 }
<a name="l00084"></a>00084
<a name="l00090"></a><a class="code" href="classCS_1_1Threading_1_1MutexImpl.html#93f2bf37a3fd1214caa5e9dd3d797271">00090</a> <span class="keywordtype">bool</span> <a class="code" href="classCS_1_1Threading_1_1MutexImpl.html#93f2bf37a3fd1214caa5e9dd3d797271" title="Try to acquire lock on mutex.">TryLock</a> ()
<a name="l00091"></a>00091 {
<a name="l00092"></a>00092 <span class="keywordflow">return</span> BaseMutex::TryLock ();
<a name="l00093"></a>00093 }
<a name="l00094"></a>00094
<a name="l00098"></a><a class="code" href="classCS_1_1Threading_1_1MutexImpl.html#e915b3d20f21b4d89246d2fc10109cca">00098</a> <span class="keywordtype">void</span> <a class="code" href="classCS_1_1Threading_1_1MutexImpl.html#e915b3d20f21b4d89246d2fc10109cca" title="Unlock the mutex.">Unlock</a> ()
<a name="l00099"></a>00099 {
<a name="l00100"></a>00100 BaseMutex::Unlock ();
<a name="l00101"></a>00101 }
<a name="l00102"></a>00102
<a name="l00106"></a><a class="code" href="classCS_1_1Threading_1_1MutexImpl.html#a55bee9fceb5f914344a9615253cab75">00106</a> <span class="keywordtype">bool</span> <a class="code" href="classCS_1_1Threading_1_1MutexImpl.html#a55bee9fceb5f914344a9615253cab75" title="Query lock status.">IsLocked</a> ()
<a name="l00107"></a>00107 {
<a name="l00108"></a>00108 <span class="keywordflow">return</span> BaseMutex::IsLocked ();
<a name="l00109"></a>00109 }
<a name="l00110"></a>00110 <span class="keyword">protected</span>:
<a name="l00111"></a><a class="code" href="classCS_1_1Threading_1_1MutexImpl.html#456995844ac1f1ddad02c28161fe211f">00111</a> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classCS_1_1Threading_1_1MutexImpl.html#456995844ac1f1ddad02c28161fe211f">ConditionBase</a>;
<a name="l00112"></a>00112 };
<a name="l00113"></a>00113
<a name="l00117"></a><a class="code" href="namespaceCS_1_1Threading.html#a77233dd556d212f73dba0999f0cb596">00117</a> <span class="keyword">typedef</span> <a class="code" href="classCS_1_1Threading_1_1MutexImpl.html" title="General mutex class.">MutexImpl<Implementation::MutexBase></a> <a class="code" href="classCS_1_1Threading_1_1MutexImpl.html" title="General mutex class.">Mutex</a>;
<a name="l00118"></a>00118
<a name="l00124"></a><a class="code" href="namespaceCS_1_1Threading.html#adf3126962fadbc6a7ed6fff9f318ba6">00124</a> <span class="keyword">typedef</span> <a class="code" href="classCS_1_1Threading_1_1MutexImpl.html" title="General mutex class.">MutexImpl<Implementation::RecursiveMutexBase></a> <a class="code" href="classCS_1_1Threading_1_1MutexImpl.html" title="General mutex class.">RecursiveMutex</a>;
<a name="l00125"></a>00125
<a name="l00126"></a>00126
<a name="l00142"></a>00142 <span class="keyword">template</span><<span class="keyword">typename</span> T>
<a name="l00143"></a><a class="code" href="classCS_1_1Threading_1_1ScopedLock.html">00143</a> <span class="keyword">class </span><a class="code" href="classCS_1_1Threading_1_1ScopedLock.html" title="This is a utility class for locking a Mutex.">ScopedLock</a>
<a name="l00144"></a>00144 {
<a name="l00145"></a>00145 <span class="keyword">public</span>:
<a name="l00146"></a><a class="code" href="classCS_1_1Threading_1_1ScopedLock.html#79e6c5ff51f56878ba40bb543a2db1b0">00146</a> <a class="code" href="classCS_1_1Threading_1_1ScopedLock.html#79e6c5ff51f56878ba40bb543a2db1b0">ScopedLock</a> (T& lockObj)
<a name="l00147"></a>00147 : lockObj (lockObj)
<a name="l00148"></a>00148 {
<a name="l00149"></a>00149 lockObj.Lock ();
<a name="l00150"></a>00150 }
<a name="l00151"></a>00151
<a name="l00152"></a><a class="code" href="classCS_1_1Threading_1_1ScopedLock.html#2bdefaa142d8ef263299ddcd339fa0e2">00152</a> <a class="code" href="classCS_1_1Threading_1_1ScopedLock.html#2bdefaa142d8ef263299ddcd339fa0e2">~ScopedLock</a> ()
<a name="l00153"></a>00153 {
<a name="l00154"></a>00154 <span class="keywordflow">if</span> (lockObj.IsLocked ())
<a name="l00155"></a>00155 {
<a name="l00156"></a>00156 lockObj.Unlock ();
<a name="l00157"></a>00157 }
<a name="l00158"></a>00158 }
<a name="l00159"></a>00159
<a name="l00160"></a>00160 <span class="keyword">private</span>:
<a name="l00161"></a>00161 T& lockObj;
<a name="l00162"></a>00162 };
<a name="l00163"></a>00163
<a name="l00164"></a>00164 <span class="comment">// Standard lock</span>
<a name="l00165"></a><a class="code" href="namespaceCS_1_1Threading.html#c8299196d93b306c8cdda17e9fd42464">00165</a> <span class="keyword">typedef</span> <a class="code" href="classCS_1_1Threading_1_1ScopedLock.html" title="This is a utility class for locking a Mutex.">ScopedLock<Mutex></a> <a class="code" href="classCS_1_1Threading_1_1ScopedLock.html" title="This is a utility class for locking a Mutex.">MutexScopedLock</a>;
<a name="l00166"></a><a class="code" href="namespaceCS_1_1Threading.html#9cfab1149a1836ca407a06c2d00ed0b8">00166</a> <span class="keyword">typedef</span> <a class="code" href="classCS_1_1Threading_1_1ScopedLock.html" title="This is a utility class for locking a Mutex.">ScopedLock<RecursiveMutex></a> <a class="code" href="classCS_1_1Threading_1_1ScopedLock.html" title="This is a utility class for locking a Mutex.">RecursiveMutexScopedLock</a>;
<a name="l00167"></a>00167 }
<a name="l00168"></a>00168 }
<a name="l00169"></a>00169
<a name="l00170"></a>00170 <span class="preprocessor">#endif</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>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
2038
