<!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/win32_condition.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/win32_condition.h</h1><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_WIN32_CONDITION_H__</span> <a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define __CS_CSUTIL_THREADING_WIN32_CONDITION_H__</span> <a name="l00021"></a>00021 <span class="preprocessor"></span> <a name="l00022"></a>00022 <span class="preprocessor">#if !defined(CS_PLATFORM_WIN32)</span> <a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#error "This file is only for Windows and requires you to include csysdefs.h before"</span> <a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#else</span> <a name="l00025"></a>00025 <span class="preprocessor"></span> <a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="atomicops_8h.html" title="Basic low-level atomic operations for different processors.">csutil/threading/atomicops.h</a>"</span> <a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="mutex_8h.html" title="Mutual-exclusion object.">csutil/threading/mutex.h</a>"</span> <a name="l00028"></a>00028 <span class="preprocessor">#include "csutil/threading//win32_apifuncs.h"</span> <a name="l00029"></a>00029 <span class="preprocessor">#include "csutil/noncopyable.h"</span> <a name="l00030"></a>00030 <a name="l00031"></a>00031 <span class="keyword">namespace </span>CS <a name="l00032"></a>00032 { <a name="l00033"></a>00033 <span class="keyword">namespace </span>Threading <a name="l00034"></a>00034 { <a name="l00035"></a>00035 <span class="keyword">namespace </span>Implementation <a name="l00036"></a>00036 { <a name="l00037"></a>00037 <a name="l00038"></a>00038 <span class="keyword">static</span> <span class="keywordtype">void</span> __stdcall NotifyFunc (<a class="code" href="namespaceCS_1_1Threading_1_1Implementation.html#9d41520eb29a3738739203db43425fac">Implementation::ulong_ptr</a>) <a name="l00039"></a>00039 { <a name="l00040"></a>00040 } <a name="l00041"></a>00041 <a name="l00042"></a>00042 <span class="keyword">class </span>ConditionBase <a name="l00043"></a>00043 { <a name="l00044"></a>00044 <span class="keyword">public</span>: <a name="l00045"></a>00045 ConditionBase () <a name="l00046"></a>00046 { <a name="l00047"></a>00047 waitingList.next = &waitingList; <a name="l00048"></a>00048 waitingList.prev = &waitingList; <a name="l00049"></a>00049 } <a name="l00050"></a>00050 <a name="l00051"></a>00051 <span class="keywordtype">void</span> NotifyOne () <a name="l00052"></a>00052 { <a name="l00053"></a>00053 StateGateLock lock (stateGate); <a name="l00054"></a>00054 <a name="l00055"></a>00055 <span class="keywordflow">if</span> (waitingList.prev != &waitingList) <a name="l00056"></a>00056 { <a name="l00057"></a>00057 WaitListEntry* <span class="keyword">const</span> entry = waitingList.prev; <a name="l00058"></a>00058 entry->Unlink (); <a name="l00059"></a>00059 NotifyEntry (entry); <a name="l00060"></a>00060 } <a name="l00061"></a>00061 } <a name="l00062"></a>00062 <a name="l00063"></a>00063 <span class="keywordtype">void</span> NotifyAll () <a name="l00064"></a>00064 { <a name="l00065"></a>00065 StateGateLock lock (stateGate); <a name="l00066"></a>00066 <a name="l00067"></a>00067 WaitListEntry* head = waitingList.prev; <a name="l00068"></a>00068 waitingList.prev = &waitingList; <a name="l00069"></a>00069 waitingList.next = &waitingList; <a name="l00070"></a>00070 <a name="l00071"></a>00071 <span class="keywordflow">while</span> (head != &waitingList) <a name="l00072"></a>00072 { <a name="l00073"></a>00073 WaitListEntry* <span class="keyword">const</span> prev = head->prev; <a name="l00074"></a>00074 NotifyEntry (head); <a name="l00075"></a>00075 head = prev; <a name="l00076"></a>00076 } <a name="l00077"></a>00077 } <a name="l00078"></a>00078 <a name="l00079"></a>00079 <span class="keyword">template</span><<span class="keyword">typename</span> LockType> <a name="l00080"></a>00080 <span class="keywordtype">bool</span> Wait (LockType& lock, <a class="code" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793" title="A time value measured in milliseconds (1/1000 of a second).">csTicks</a> timeout) <a name="l00081"></a>00081 { <a name="l00082"></a>00082 WaitListEntry waitEntry; <a name="l00083"></a>00083 <a name="l00084"></a>00084 <span class="keywordtype">void</span>* <span class="keyword">const</span> currentProcess = Implementation::GetCurrentProcess (); <a name="l00085"></a>00085 <span class="keywordtype">void</span>* <span class="keyword">const</span> currentThread = Implementation::GetCurrentThread (); <a name="l00086"></a>00086 <a name="l00087"></a>00087 Implementation::DuplicateHandle (currentProcess, currentThread, currentProcess, <a name="l00088"></a>00088 &waitEntry.waitingThreadHandle, 0, <span class="keyword">false</span>, DUPLICATE_SAME_ACCESS); <a name="l00089"></a>00089 <a name="l00090"></a>00090 { <a name="l00091"></a>00091 AddEntryHelper<LockType> entryGuard (<span class="keyword">this</span>, waitEntry, lock); <a name="l00092"></a>00092 <a name="l00093"></a>00093 DWORD r; <a name="l00094"></a>00094 <span class="comment">// Loop until notified</span> <a name="l00095"></a>00095 <span class="keywordflow">while</span> (!AtomicOperations::Read (&waitEntry.notified) && <a name="l00096"></a>00096 (r = Implementation::SleepEx (timeout == 0 ? INFINITE : timeout, <a name="l00097"></a>00097 <span class="keyword">true</span>)) == WAIT_IO_COMPLETION) <a name="l00098"></a>00098 ; <a name="l00099"></a>00099 <span class="keywordflow">return</span> r != 0; <a name="l00100"></a>00100 } <a name="l00101"></a>00101 } <a name="l00102"></a>00102 <a name="l00103"></a>00103 <a name="l00104"></a>00104 <span class="keyword">protected</span>: <a name="l00105"></a>00105 <a name="l00106"></a>00106 <span class="comment">// Keep a list of waiting threads</span> <a name="l00107"></a>00107 <span class="keyword">struct </span>WaitListEntry <a name="l00108"></a>00108 { <a name="l00109"></a>00109 <span class="keywordtype">void</span>* waitingThreadHandle; <a name="l00110"></a>00110 <a class="code" href="group__util.html#g56f1a81c92849566ae864511088eb7e8" title="signed 32-bit integer (-2 147 483 648..2 147 483 647)">int32</a> notified; <a name="l00111"></a>00111 WaitListEntry* next; <a name="l00112"></a>00112 WaitListEntry* prev; <a name="l00113"></a>00113 <a name="l00114"></a>00114 WaitListEntry () <a name="l00115"></a>00115 : waitingThreadHandle (0), notified (0), next (0), prev (0) <a name="l00116"></a>00116 { <a name="l00117"></a>00117 } <a name="l00118"></a>00118 <a name="l00119"></a>00119 <span class="keywordtype">void</span> Unlink () <a name="l00120"></a>00120 { <a name="l00121"></a>00121 next->prev = prev; <a name="l00122"></a>00122 prev->next = next; <a name="l00123"></a>00123 next = <span class="keyword">this</span>; <a name="l00124"></a>00124 prev = <span class="keyword">this</span>; <a name="l00125"></a>00125 } <a name="l00126"></a>00126 }; <a name="l00127"></a>00127 <a name="l00128"></a>00128 <span class="comment">// Guard our own state</span> <a name="l00129"></a>00129 <a class="code" href="namespaceCS_1_1Threading.html#a77233dd556d212f73dba0999f0cb596" title="Basic non-recursive mutex.">Mutex</a> stateGate; <a name="l00130"></a>00130 <span class="keyword">typedef</span> ScopedLock<Mutex> StateGateLock; <a name="l00131"></a>00131 <a name="l00132"></a>00132 WaitListEntry waitingList; <a name="l00133"></a>00133 <a name="l00134"></a>00134 <span class="comment">// Helper-class to add/remove entries from waiting list</span> <a name="l00135"></a>00135 <span class="keyword">template</span><<span class="keyword">typename</span> LockType> <a name="l00136"></a>00136 <span class="keyword">struct </span>AddEntryHelper <a name="l00137"></a>00137 { <a name="l00138"></a>00138 ConditionBase* owner; <a name="l00139"></a>00139 WaitListEntry& entry; <a name="l00140"></a>00140 LockType& lock; <a name="l00141"></a>00141 <a name="l00142"></a>00142 AddEntryHelper (ConditionBase* owner, WaitListEntry& entry, LockType& lock) <a name="l00143"></a>00143 : owner (owner), entry (entry), lock (lock) <a name="l00144"></a>00144 { <a name="l00145"></a>00145 entry.prev = &owner->waitingList; <a name="l00146"></a>00146 StateGateLock locks (owner->stateGate); <a name="l00147"></a>00147 <a name="l00148"></a>00148 entry.next = owner->waitingList.next; <a name="l00149"></a>00149 owner->waitingList.next = &entry; <a name="l00150"></a>00150 entry.next->prev = &entry; <a name="l00151"></a>00151 <a name="l00152"></a>00152 lock.Unlock (); <a name="l00153"></a>00153 } <a name="l00154"></a>00154 <a name="l00155"></a>00155 ~AddEntryHelper () <a name="l00156"></a>00156 { <a name="l00157"></a>00157 <span class="keywordflow">if</span> (!entry.notified) <a name="l00158"></a>00158 { <a name="l00159"></a>00159 StateGateLock locks (owner->stateGate); <a name="l00160"></a>00160 <span class="keywordflow">if</span> (!entry.notified) <a name="l00161"></a>00161 { <a name="l00162"></a>00162 entry.Unlink (); <a name="l00163"></a>00163 } <a name="l00164"></a>00164 } <a name="l00165"></a>00165 <a name="l00166"></a>00166 Implementation::CloseHandle ((HANDLE)entry.waitingThreadHandle); <a name="l00167"></a>00167 lock.Lock (); <a name="l00168"></a>00168 } <a name="l00169"></a>00169 }; <a name="l00170"></a>00170 <span class="keyword">template</span><<span class="keyword">typename</span> LockType> <span class="keyword">friend</span> <span class="keyword">struct </span>AddEntryHelper; <a name="l00171"></a>00171 <a name="l00172"></a>00172 <span class="keywordtype">void</span> NotifyEntry (WaitListEntry* entry) <a name="l00173"></a>00173 { <a name="l00174"></a>00174 AtomicOperations::Set (&entry->notified, 1); <a name="l00175"></a>00175 <span class="keywordflow">if</span> (entry->waitingThreadHandle) <a name="l00176"></a>00176 { <a name="l00177"></a>00177 <span class="comment">// Wake up thread</span> <a name="l00178"></a>00178 Implementation::QueueUserAPC (NotifyFunc, entry->waitingThreadHandle, 0); <a name="l00179"></a>00179 } <a name="l00180"></a>00180 } <a name="l00181"></a>00181 }; <a name="l00182"></a>00182 <a name="l00183"></a>00183 } <a name="l00184"></a>00184 } <a name="l00185"></a>00185 } <a name="l00186"></a>00186 <a name="l00187"></a>00187 <span class="preprocessor">#endif // !defined(CS_PLATFORM_WIN32)</span> <a name="l00188"></a>00188 <span class="preprocessor"></span> <a name="l00189"></a>00189 <span class="preprocessor">#endif // __CS_CSUTIL_THREADING_WIN32_CONDITION_H__</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>