doc/oscl_html/classOsclMutex.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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234

<!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: OsclMutex Class Reference</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 class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>OsclMutex Class Reference</h1><!-- doxytag: class="OsclMutex" --><!-- doxytag: inherits="OsclLockBase" -->
<p><code>#include &lt;<a class="el" href="oscl__mutex_8h_source.html">oscl_mutex.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for OsclMutex:</div>
<div class="dynsection">
 <div class="center">
  <img src="classOsclMutex.png" usemap="#OsclMutex_map" alt=""/>
  <map id="OsclMutex_map" name="OsclMutex_map">
<area href="classOsclLockBase.html" alt="OsclLockBase" shape="rect" coords="0,0,93,24"/>
</map>
 </div>
</div>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclMutex.html#acb8191cc7539e1d4424754fd0221a1f7">OsclMutex</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual OSCL_IMPORT_REF&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclMutex.html#a7f537d13b981fc88e7f1fa9a0c6420de">~OsclMutex</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF <br class="typebreak"/>
<a class="el" href="classOsclProcStatus.html#aabff5308a6581dcb84532c3b5d63b763">OsclProcStatus::eOsclProcError</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclMutex.html#af8a780e2468598e27c3b8bc4bc9efeb2">Create</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclMutex.html#aae0f614c691dff49b71256eb59d63cdc">Lock</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF <br class="typebreak"/>
<a class="el" href="classOsclProcStatus.html#aabff5308a6581dcb84532c3b5d63b763">OsclProcStatus::eOsclProcError</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclMutex.html#ad13cd8432dfe718df56a644fec55a676">TryLock</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclMutex.html#afe3556cb5ca7c9b4a2331e4f1e61cb8f">Unlock</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF <br class="typebreak"/>
<a class="el" href="classOsclProcStatus.html#aabff5308a6581dcb84532c3b5d63b763">OsclProcStatus::eOsclProcError</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclMutex.html#aedf3ae510283e500471012db0db0e141">Close</a> (void)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Class <a class="el" href="classOsclMutex.html">OsclMutex</a> </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="acb8191cc7539e1d4424754fd0221a1f7"></a><!-- doxytag: member="OsclMutex::OsclMutex" ref="acb8191cc7539e1d4424754fd0221a1f7" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_IMPORT_REF OsclMutex::OsclMutex </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Class constructor </p>

</div>
</div>
<a class="anchor" id="a7f537d13b981fc88e7f1fa9a0c6420de"></a><!-- doxytag: member="OsclMutex::~OsclMutex" ref="a7f537d13b981fc88e7f1fa9a0c6420de" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual OSCL_IMPORT_REF OsclMutex::~OsclMutex </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Class destructor </p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aedf3ae510283e500471012db0db0e141"></a><!-- doxytag: member="OsclMutex::Close" ref="aedf3ae510283e500471012db0db0e141" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_IMPORT_REF <a class="el" href="classOsclProcStatus.html#aabff5308a6581dcb84532c3b5d63b763">OsclProcStatus::eOsclProcError</a> OsclMutex::Close </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Closes the Mutex</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>It</em>&nbsp;</td><td>wont take any prameters</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns the Error whether it is success or failure. Incase of failure it will return what is the specific error </dd></dl>

</div>
</div>
<a class="anchor" id="af8a780e2468598e27c3b8bc4bc9efeb2"></a><!-- doxytag: member="OsclMutex::Create" ref="af8a780e2468598e27c3b8bc4bc9efeb2" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_IMPORT_REF <a class="el" href="classOsclProcStatus.html#aabff5308a6581dcb84532c3b5d63b763">OsclProcStatus::eOsclProcError</a> OsclMutex::Create </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Creates the Mutex</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>No</em>&nbsp;</td><td>input arguments</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns the Error whether it is success or failure. Incase of failure it will return what is the specific error </dd></dl>

</div>
</div>
<a class="anchor" id="aae0f614c691dff49b71256eb59d63cdc"></a><!-- doxytag: member="OsclMutex::Lock" ref="aae0f614c691dff49b71256eb59d63cdc" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_IMPORT_REF void OsclMutex::Lock </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Locks the Mutex</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>It</em>&nbsp;</td><td>wont take any parameters</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns nothing </dd></dl>

<p>Implements <a class="el" href="classOsclLockBase.html#a21d499c7b86d8dbb0bf3260bcb90877f">OsclLockBase</a>.</p>

</div>
</div>
<a class="anchor" id="ad13cd8432dfe718df56a644fec55a676"></a><!-- doxytag: member="OsclMutex::TryLock" ref="ad13cd8432dfe718df56a644fec55a676" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_IMPORT_REF <a class="el" href="classOsclProcStatus.html#aabff5308a6581dcb84532c3b5d63b763">OsclProcStatus::eOsclProcError</a> OsclMutex::TryLock </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Try to lock the mutex,if the Mutex is already locked calling thread immediately returns with out blocking </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>It</em>&nbsp;</td><td>wont take any parameters</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns SUCCESS_ERROR if the mutex was acquired, MUTEX_LOCKED_ERROR if the mutex cannot be acquired without waiting, or an error code if the operation failed. Note: this function may not be supported on all platforms, and may return NOT_IMPLEMENTED. </dd></dl>

</div>
</div>
<a class="anchor" id="afe3556cb5ca7c9b4a2331e4f1e61cb8f"></a><!-- doxytag: member="OsclMutex::Unlock" ref="afe3556cb5ca7c9b4a2331e4f1e61cb8f" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_IMPORT_REF void OsclMutex::Unlock </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Releases the Mutex</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>It</em>&nbsp;</td><td>wont take any parameters</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns nothing </dd></dl>

<p>Implements <a class="el" href="classOsclLockBase.html#a063f128a62a84012077e29eb12d26e1f">OsclLockBase</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="oscl__mutex_8h_source.html">oscl_mutex.h</a></li>
</ul>
</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.002.1.1 </small>
</small></address>
</body>
</html>