doc/oscl_html/oscl__mutex_8h_source.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>oscl: oscl_mutex.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
<h1>oscl_mutex.h</h1><a href="oscl__mutex_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 
<a name="l00002"></a>00002 <span class="comment">// -*- c++ -*-</span>
<a name="l00003"></a>00003 <span class="comment">// = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =</span>
<a name="l00004"></a>00004 
<a name="l00005"></a>00005 <span class="comment">//                     O S C L _ M U T E X</span>
<a name="l00006"></a>00006 
<a name="l00007"></a>00007 <span class="comment">// = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =</span>
<a name="l00008"></a>00008 
<a name="l00015"></a>00015 <span class="preprocessor">#ifndef OSCL_MUTEX_H_INCLUDED</span>
<a name="l00016"></a>00016 <span class="preprocessor"></span><span class="preprocessor">#define OSCL_MUTEX_H_INCLUDED</span>
<a name="l00017"></a>00017 <span class="preprocessor"></span>
<a name="l00018"></a>00018 <span class="preprocessor">#ifndef OSCLCONFIG_PROC_H_INCLUDED</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span><span class="preprocessor">#include &quot;<a class="code" href="osclconfig__proc_8h.html" title="This file contains configuration information for the linux platform.">osclconfig_proc.h</a>&quot;</span>
<a name="l00020"></a>00020 <span class="preprocessor">#endif</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#ifndef OSCL_TYPES_H_INCLUDED</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#include &quot;<a class="code" href="oscl__types_8h.html" title="This file contains basic type definitions for common use across platforms.">oscl_types.h</a>&quot;</span>
<a name="l00023"></a>00023 <span class="preprocessor">#endif</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#ifndef OSCL_BASE_H_INCLUDED</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span><span class="preprocessor">#include &quot;<a class="code" href="oscl__base_8h.html" title="The file oscl_base.h is the public header that should be included to pick up the...">oscl_base.h</a>&quot;</span>
<a name="l00026"></a>00026 <span class="preprocessor">#endif</span>
<a name="l00027"></a>00027 <span class="preprocessor"></span><span class="preprocessor">#ifndef OSCL_THREAD_H_INCLUDED</span>
<a name="l00028"></a>00028 <span class="preprocessor"></span><span class="preprocessor">#include &quot;<a class="code" href="oscl__thread_8h.html">oscl_thread.h</a>&quot;</span>
<a name="l00029"></a>00029 <span class="preprocessor">#endif</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span><span class="preprocessor">#ifndef OSCL_LOCK_BASE_H_INCLUDED</span>
<a name="l00031"></a>00031 <span class="preprocessor"></span><span class="preprocessor">#include &quot;<a class="code" href="oscl__lock__base_8h.html" title="This file defines an abstract lock class, OsclLockBase, that is used for APIs potentially...">oscl_lock_base.h</a>&quot;</span>
<a name="l00032"></a>00032 <span class="preprocessor">#endif</span>
<a name="l00033"></a>00033 <span class="preprocessor"></span>
<a name="l00034"></a>00034 
<a name="l00038"></a><a class="code" href="classOsclMutex.html">00038</a> <span class="keyword">class </span><a class="code" href="classOsclMutex.html">OsclMutex</a> : <span class="keyword">public</span> <a class="code" href="classOsclLockBase.html">OsclLockBase</a>
<a name="l00039"></a>00039 {
<a name="l00040"></a>00040     <span class="keyword">public</span>:
<a name="l00041"></a>00041 
<a name="l00045"></a>00045         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> <a class="code" href="classOsclMutex.html#acb8191cc7539e1d4424754fd0221a1f7">OsclMutex</a>();
<a name="l00046"></a>00046 
<a name="l00050"></a>00050         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> <span class="keyword">virtual</span> <a class="code" href="classOsclMutex.html#a7f537d13b981fc88e7f1fa9a0c6420de">~OsclMutex</a>();
<a name="l00051"></a>00051 
<a name="l00060"></a>00060         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> <a class="code" href="classOsclProcStatus.html#aabff5308a6581dcb84532c3b5d63b763">OsclProcStatus::eOsclProcError</a> <a class="code" href="classOsclMutex.html#af8a780e2468598e27c3b8bc4bc9efeb2">Create</a>(<span class="keywordtype">void</span>);
<a name="l00061"></a>00061 
<a name="l00062"></a>00062 
<a name="l00070"></a>00070         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> <span class="keywordtype">void</span> <a class="code" href="classOsclMutex.html#aae0f614c691dff49b71256eb59d63cdc">Lock</a>();
<a name="l00071"></a>00071 
<a name="l00083"></a>00083         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> <a class="code" href="classOsclProcStatus.html#aabff5308a6581dcb84532c3b5d63b763">OsclProcStatus::eOsclProcError</a> <a class="code" href="classOsclMutex.html#ad13cd8432dfe718df56a644fec55a676">TryLock</a>();
<a name="l00084"></a>00084 
<a name="l00085"></a>00085 
<a name="l00093"></a>00093         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> <span class="keywordtype">void</span> <a class="code" href="classOsclMutex.html#afe3556cb5ca7c9b4a2331e4f1e61cb8f">Unlock</a>();
<a name="l00094"></a>00094 
<a name="l00095"></a>00095 
<a name="l00104"></a>00104         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> <a class="code" href="classOsclProcStatus.html#aabff5308a6581dcb84532c3b5d63b763">OsclProcStatus::eOsclProcError</a> <a class="code" href="classOsclMutex.html#aedf3ae510283e500471012db0db0e141">Close</a>(<span class="keywordtype">void</span>);
<a name="l00105"></a>00105 
<a name="l00106"></a>00106     <span class="keyword">private</span>:
<a name="l00107"></a>00107 
<a name="l00115"></a>00115         <a class="code" href="classOsclProcStatus.html#aabff5308a6581dcb84532c3b5d63b763">OsclProcStatus::eOsclProcError</a> ErrorMapping(int32 Error);
<a name="l00116"></a>00116 
<a name="l00117"></a>00117         <a class="code" href="osclconfig__proc__unix__common_8h.html#ad614b4fd9839f6ad888115bdb9770be5">TOsclMutexObject</a>    ObjMutex;
<a name="l00118"></a>00118         <span class="keywordtype">bool</span> bCreated;
<a name="l00119"></a>00119 
<a name="l00120"></a>00120 };
<a name="l00121"></a>00121 
<a name="l00136"></a>00136 <span class="preprocessor">#if !OSCL_HAS_NON_PREEMPTIVE_THREAD_SUPPORT</span>
<a name="l00137"></a>00137 <span class="preprocessor"></span><span class="comment">//In pre-emptive threading, OsclNoYieldMutex is identical to OsclMutex</span>
<a name="l00138"></a><a class="code" href="oscl__mutex_8h.html#ad747a995b5328af45639cfd383ac6a71">00138</a> <span class="keyword">typedef</span> <a class="code" href="classOsclMutex.html">OsclMutex</a> <a class="code" href="classOsclMutex.html">OsclNoYieldMutex</a>;
<a name="l00139"></a>00139 <span class="preprocessor">#else</span>
<a name="l00140"></a>00140 <span class="preprocessor"></span><span class="comment">//In non-pre-emptive threading, OsclNoYieldMutex is a NO-OP.</span>
<a name="l00141"></a>00141 <span class="keyword">class </span><a class="code" href="classOsclMutex.html">OsclNoYieldMutex</a> : <span class="keyword">public</span> <a class="code" href="classOsclLockBase.html">OsclLockBase</a>
<a name="l00142"></a>00142 {
<a name="l00143"></a>00143     <span class="keyword">public</span>:
<a name="l00144"></a>00144 
<a name="l00148"></a>00148         <a class="code" href="oscl__mutex_8h.html#ad747a995b5328af45639cfd383ac6a71">OsclNoYieldMutex</a>()
<a name="l00149"></a>00149         {
<a name="l00150"></a>00150 <span class="preprocessor">#if (!OSCL_RELEASE_BUILD)</span>
<a name="l00151"></a>00151 <span class="preprocessor"></span>            iNumLock = 0;
<a name="l00152"></a>00152             bCreated = <span class="keyword">false</span>;
<a name="l00153"></a>00153 <span class="preprocessor">#endif</span>
<a name="l00154"></a>00154 <span class="preprocessor"></span>        }
<a name="l00155"></a>00155 
<a name="l00159"></a>00159         <span class="keyword">virtual</span> ~<a class="code" href="classOsclMutex.html">OsclNoYieldMutex</a>()
<a name="l00160"></a>00160         {}
<a name="l00161"></a>00161 
<a name="l00170"></a>00170         <a class="code" href="classOsclProcStatus.html#aabff5308a6581dcb84532c3b5d63b763">OsclProcStatus::eOsclProcError</a> <a class="code" href="classOsclMutex.html#af8a780e2468598e27c3b8bc4bc9efeb2">Create</a>(<span class="keywordtype">void</span>)
<a name="l00171"></a>00171         {
<a name="l00172"></a>00172 <span class="preprocessor">#if (!OSCL_RELEASE_BUILD)</span>
<a name="l00173"></a>00173 <span class="preprocessor"></span>            <span class="keywordflow">if</span> (bCreated)
<a name="l00174"></a>00174                 <span class="keywordflow">return</span> <a class="code" href="classOsclProcStatus.html#aabff5308a6581dcb84532c3b5d63b763a87d1f8a4a0d3e7dc01c589dabce4862d">OsclProcStatus::INVALID_OPERATION_ERROR</a>;
<a name="l00175"></a>00175             bCreated = <span class="keyword">true</span>;
<a name="l00176"></a>00176 <span class="preprocessor">#endif</span>
<a name="l00177"></a>00177 <span class="preprocessor"></span>            <span class="keywordflow">return</span> <a class="code" href="classOsclProcStatus.html#aabff5308a6581dcb84532c3b5d63b763a4c0c6b81bfe9cf0f197a74ca8351acea">OsclProcStatus::SUCCESS_ERROR</a>;
<a name="l00178"></a>00178         }
<a name="l00179"></a>00179 
<a name="l00180"></a>00180 
<a name="l00188"></a>00188         <span class="keywordtype">void</span> <a class="code" href="classOsclMutex.html#aae0f614c691dff49b71256eb59d63cdc">Lock</a>()
<a name="l00189"></a>00189         {
<a name="l00190"></a>00190 <span class="preprocessor">#if (!OSCL_RELEASE_BUILD)</span>
<a name="l00191"></a>00191 <span class="preprocessor"></span>            <a class="code" href="group__osclbase.html#gaf7c21e5b6e4fee4247225dd31f89c8ca">OSCL_ASSERT</a>(bCreated);
<a name="l00192"></a>00192             <a class="code" href="group__osclbase.html#gaf7c21e5b6e4fee4247225dd31f89c8ca">OSCL_ASSERT</a>(iNumLock == 0);<span class="comment">//detect deadlock condition.</span>
<a name="l00193"></a>00193             iNumLock++;
<a name="l00194"></a>00194 <span class="preprocessor">#endif</span>
<a name="l00195"></a>00195 <span class="preprocessor"></span>        }
<a name="l00196"></a>00196 
<a name="l00208"></a>00208         <a class="code" href="classOsclProcStatus.html#aabff5308a6581dcb84532c3b5d63b763">OsclProcStatus::eOsclProcError</a> <a class="code" href="classOsclMutex.html#ad13cd8432dfe718df56a644fec55a676">TryLock</a>()
<a name="l00209"></a>00209         {
<a name="l00210"></a>00210 <span class="preprocessor">#if (!OSCL_RELEASE_BUILD)</span>
<a name="l00211"></a>00211 <span class="preprocessor"></span>            <span class="keywordflow">if</span> (!bCreated)
<a name="l00212"></a>00212                 <span class="keywordflow">return</span> <a class="code" href="classOsclProcStatus.html#aabff5308a6581dcb84532c3b5d63b763a87d1f8a4a0d3e7dc01c589dabce4862d">OsclProcStatus::INVALID_OPERATION_ERROR</a>;
<a name="l00213"></a>00213             <span class="keywordflow">if</span> (iNumLock)
<a name="l00214"></a>00214                 <span class="keywordflow">return</span> <a class="code" href="classOsclProcStatus.html#aabff5308a6581dcb84532c3b5d63b763a58200a4a8d727edc4b1f5a4d9da3dc37">OsclProcStatus::MUTEX_LOCKED_ERROR</a>;
<a name="l00215"></a>00215             <span class="keywordflow">else</span>
<a name="l00216"></a>00216                 <a class="code" href="classOsclMutex.html#aae0f614c691dff49b71256eb59d63cdc">Lock</a>();
<a name="l00217"></a>00217             <span class="keywordflow">return</span> <a class="code" href="classOsclProcStatus.html#aabff5308a6581dcb84532c3b5d63b763a4c0c6b81bfe9cf0f197a74ca8351acea">OsclProcStatus::SUCCESS_ERROR</a>;
<a name="l00218"></a>00218 <span class="preprocessor">#endif</span>
<a name="l00219"></a>00219 <span class="preprocessor"></span>        }
<a name="l00220"></a>00220 
<a name="l00221"></a>00221 
<a name="l00229"></a>00229         <span class="keywordtype">void</span> <a class="code" href="classOsclMutex.html#afe3556cb5ca7c9b4a2331e4f1e61cb8f">Unlock</a>()
<a name="l00230"></a>00230         {
<a name="l00231"></a>00231 <span class="preprocessor">#if (!OSCL_RELEASE_BUILD)</span>
<a name="l00232"></a>00232 <span class="preprocessor"></span>            <a class="code" href="group__osclbase.html#gaf7c21e5b6e4fee4247225dd31f89c8ca">OSCL_ASSERT</a>(bCreated);
<a name="l00233"></a>00233             <a class="code" href="group__osclbase.html#gaf7c21e5b6e4fee4247225dd31f89c8ca">OSCL_ASSERT</a>(iNumLock);
<a name="l00234"></a>00234             <span class="keywordflow">if</span> (iNumLock &gt; 0)
<a name="l00235"></a>00235                 iNumLock--;
<a name="l00236"></a>00236 <span class="preprocessor">#endif</span>
<a name="l00237"></a>00237 <span class="preprocessor"></span>        }
<a name="l00238"></a>00238 
<a name="l00239"></a>00239 
<a name="l00248"></a>00248         <a class="code" href="classOsclProcStatus.html#aabff5308a6581dcb84532c3b5d63b763">OsclProcStatus::eOsclProcError</a> <a class="code" href="classOsclMutex.html#aedf3ae510283e500471012db0db0e141">Close</a>(<span class="keywordtype">void</span>)
<a name="l00249"></a>00249         {
<a name="l00250"></a>00250 <span class="preprocessor">#if (!OSCL_RELEASE_BUILD)</span>
<a name="l00251"></a>00251 <span class="preprocessor"></span>            <span class="keywordflow">if</span> (!bCreated)
<a name="l00252"></a>00252                 <span class="keywordflow">return</span> <a class="code" href="classOsclProcStatus.html#aabff5308a6581dcb84532c3b5d63b763a87d1f8a4a0d3e7dc01c589dabce4862d">OsclProcStatus::INVALID_OPERATION_ERROR</a>;
<a name="l00253"></a>00253             bCreated = <span class="keyword">false</span>;
<a name="l00254"></a>00254 <span class="preprocessor">#endif</span>
<a name="l00255"></a>00255 <span class="preprocessor"></span>            <span class="keywordflow">return</span> <a class="code" href="classOsclProcStatus.html#aabff5308a6581dcb84532c3b5d63b763a4c0c6b81bfe9cf0f197a74ca8351acea">OsclProcStatus::SUCCESS_ERROR</a>;
<a name="l00256"></a>00256         }
<a name="l00257"></a>00257 
<a name="l00258"></a>00258     <span class="keyword">private</span>:
<a name="l00259"></a>00259 
<a name="l00260"></a>00260 <span class="preprocessor">#if (!OSCL_RELEASE_BUILD)</span>
<a name="l00261"></a>00261 <span class="preprocessor"></span>        uint32 iNumLock;
<a name="l00262"></a>00262         <span class="keywordtype">bool</span> bCreated;
<a name="l00263"></a>00263 <span class="preprocessor">#endif</span>
<a name="l00264"></a>00264 <span class="preprocessor"></span>
<a name="l00265"></a>00265 };
<a name="l00266"></a>00266 <span class="preprocessor">#endif //OSCL_HAS_NON_PREEMPTIVE_THREAD_SUPPORT</span>
<a name="l00267"></a>00267 <span class="preprocessor"></span>
<a name="l00271"></a><a class="code" href="classOsclThreadLock.html">00271</a> <span class="keyword">class </span><a class="code" href="classOsclThreadLock.html">OsclThreadLock</a>: <span class="keyword">public</span> <a class="code" href="classOsclLockBase.html">OsclLockBase</a>
<a name="l00272"></a>00272 {
<a name="l00273"></a>00273     <span class="keyword">public</span>:
<a name="l00274"></a>00274         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> <a class="code" href="classOsclThreadLock.html#a688ea4f52894a4cd988b50ea10d05509">OsclThreadLock</a>();
<a name="l00275"></a>00275         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> <span class="keyword">virtual</span> <a class="code" href="classOsclThreadLock.html#a8b243e0076b5c938298b82b4db4180c9">~OsclThreadLock</a>();
<a name="l00276"></a>00276         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> <span class="keywordtype">void</span> <a class="code" href="classOsclThreadLock.html#a341cc6d7c3cf3ceef5ccc70282784b3f">Lock</a>();
<a name="l00277"></a>00277         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> <span class="keywordtype">void</span> <a class="code" href="classOsclThreadLock.html#a6f20fa466ebc085b50355fa25e83ed0d">Unlock</a>();
<a name="l00278"></a>00278     <span class="keyword">private</span>:
<a name="l00279"></a>00279         <a class="code" href="classOsclMutex.html">OsclMutex</a> iMutex;
<a name="l00280"></a>00280 };
<a name="l00281"></a>00281 
<a name="l00282"></a>00282 <span class="preprocessor">#endif</span>
<a name="l00283"></a>00283 <span class="preprocessor"></span>
<a name="l00284"></a>00284 
<a name="l00285"></a>00285 
</pre></div></div>
<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small>
<address style="align: left;"><small>Posting Version: CORE_9.005.1.1 </small>
</small></address>
</body>
</html>