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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
|
<!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: OsclThread 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 Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data 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 Structures</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>OsclThread Class Reference</h1><!-- doxytag: class="OsclThread" -->
<p><code>#include <<a class="el" href="oscl__thread_8h_source.html">oscl_thread.h</a>></code></p>
<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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclThread.html#ac520537de13eadc7cfbbdad6ee6e5939">OsclThread</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF </td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclThread.html#a9f414ae7e0796a1e5740be998c414b38">~OsclThread</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> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclThread.html#ac69068f62a332bca5f3f5e7a8175e395">Create</a> (<a class="el" href="oscl__thread_8h.html#a281d92b5b90c97da3cbcacf3a9db0505">TOsclThreadFuncPtr</a> func, int32 stack_size, <a class="el" href="osclconfig__proc__unix__android_8h.html#a79dc72e19d6ed5a3fd5f49a14f0fdb92">TOsclThreadFuncArg</a> argument, <a class="el" href="oscl__thread_8h.html#a0d37915480fc468c9db787088de58070">OsclThread_State</a> state=Start_on_creation, bool oIsJoinable=false)</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> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclThread.html#a891cc1efcbfcee9a49eee4320b22406e">GetPriority</a> (<a class="el" href="oscl__thread_8h.html#a2587c6e4a01b7ab59591b8f60ac71068">OsclThreadPriority</a> &refThreadPriority)</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> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclThread.html#a12debb16f97e8bef820ac499a67eb1b5">SetPriority</a> (<a class="el" href="oscl__thread_8h.html#a2587c6e4a01b7ab59591b8f60ac71068">OsclThreadPriority</a> ePriority)</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> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclThread.html#a40d009495846071886f19c561c193a8e">Suspend</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> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclThread.html#a14bbd5c5b4d356d4dcf9c0ad502391b5">Resume</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> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclThread.html#aac962580ed4dc9132567a25d659ca34a">Terminate</a> (<a class="el" href="group__osclbase.html#ga3bac54662348f5e6c08b97ca97066b89">OsclAny</a> *exitcode)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF <br class="typebreak"/>
<a class="el" href="oscl__thread_8h.html#a3bc2a7f5d639c996fb80f60bb53bf4a9">TOsclThreadTerminate</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclThread.html#ac651c00cc339e71ef832e329c4d086e9">CanTerminate</a> ()</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static OSCL_IMPORT_REF void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclThread.html#a3f48fe531554523393a65388acebc53c">Exit</a> (<a class="el" href="group__osclbase.html#ga3bac54662348f5e6c08b97ca97066b89">OsclAny</a> *exitcode)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static OSCL_IMPORT_REF <br class="typebreak"/>
<a class="el" href="classOsclProcStatus.html#aabff5308a6581dcb84532c3b5d63b763">OsclProcStatus::eOsclProcError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclThread.html#a53544ee6b8f66c4251c734f207462266">GetId</a> (<a class="el" href="osclconfig__proc__unix__android_8h.html#a82cf0793edd624dc416a6db1b916ef45">TOsclThreadId</a> &refThreadId)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static OSCL_IMPORT_REF bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclThread.html#a2764b0fcf9b8e7d130d53cb3e32d9a9b">CompareId</a> (<a class="el" href="osclconfig__proc__unix__android_8h.html#a82cf0793edd624dc416a6db1b916ef45">TOsclThreadId</a> &t1, <a class="el" href="osclconfig__proc__unix__android_8h.html#a82cf0793edd624dc416a6db1b916ef45">TOsclThreadId</a> &t2)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static OSCL_IMPORT_REF void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclThread.html#a77adbfece5bc46a65e8428046d05962b">SleepMillisec</a> (const int32 msec)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Thread Class. A subset of Thread APIs. It implements platform independendent APIs for thread creation, exiting, suspend, resume, priority and termination. With the use of proper defines it implements the basic thread festures. It provides an opaque layer through which user doesn't need to worry about OS specific data. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ac520537de13eadc7cfbbdad6ee6e5939"></a><!-- doxytag: member="OsclThread::OsclThread" ref="ac520537de13eadc7cfbbdad6ee6e5939" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OSCL_IMPORT_REF OsclThread::OsclThread </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Class constructor </p>
</div>
</div>
<a class="anchor" id="a9f414ae7e0796a1e5740be998c414b38"></a><!-- doxytag: member="OsclThread::~OsclThread" ref="a9f414ae7e0796a1e5740be998c414b38" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OSCL_IMPORT_REF OsclThread::~OsclThread </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Class destructor </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ac651c00cc339e71ef832e329c4d086e9"></a><!-- doxytag: member="OsclThread::CanTerminate" ref="ac651c00cc339e71ef832e329c4d086e9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OSCL_IMPORT_REF <a class="el" href="oscl__thread_8h.html#a3bc2a7f5d639c996fb80f60bb53bf4a9">TOsclThreadTerminate</a> OsclThread::CanTerminate </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Tell if thread terminate will do join, immediate hard kill, or NOP. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Terminate behavior. </dd></dl>
</div>
</div>
<a class="anchor" id="a2764b0fcf9b8e7d130d53cb3e32d9a9b"></a><!-- doxytag: member="OsclThread::CompareId" ref="a2764b0fcf9b8e7d130d53cb3e32d9a9b" args="(TOsclThreadId &t1, TOsclThreadId &t2)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static OSCL_IMPORT_REF bool OsclThread::CompareId </td>
<td>(</td>
<td class="paramtype"><a class="el" href="osclconfig__proc__unix__android_8h.html#a82cf0793edd624dc416a6db1b916ef45">TOsclThreadId</a> & </td>
<td class="paramname"> <em>t1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="osclconfig__proc__unix__android_8h.html#a82cf0793edd624dc416a6db1b916ef45">TOsclThreadId</a> & </td>
<td class="paramname"> <em>t2</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Static routine to compare whether two thread ID's are equal. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>t1,t2,:</em> </td><td>thread ID passed by the application </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if equal. </dd></dl>
</div>
</div>
<a class="anchor" id="ac69068f62a332bca5f3f5e7a8175e395"></a><!-- doxytag: member="OsclThread::Create" ref="ac69068f62a332bca5f3f5e7a8175e395" args="(TOsclThreadFuncPtr func, int32 stack_size, TOsclThreadFuncArg argument, OsclThread_State state=Start_on_creation, bool oIsJoinable=false)" -->
<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> OsclThread::Create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="oscl__thread_8h.html#a281d92b5b90c97da3cbcacf3a9db0505">TOsclThreadFuncPtr</a> </td>
<td class="paramname"> <em>func</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32 </td>
<td class="paramname"> <em>stack_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="osclconfig__proc__unix__android_8h.html#a79dc72e19d6ed5a3fd5f49a14f0fdb92">TOsclThreadFuncArg</a> </td>
<td class="paramname"> <em>argument</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="oscl__thread_8h.html#a0d37915480fc468c9db787088de58070">OsclThread_State</a> </td>
<td class="paramname"> <em>state</em> = <code>Start_on_creation</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>oIsJoinable</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This routine will create a thread. The thread may be launched immediately or may be created in a suspended state and launched with a Resume call.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>func</em> </td><td>= Name of the thread Function stack_size = Size of the thread stack. If zero, then the platform-specific default stack size will be used. argument = Argument to be passed to thread function state = Enumeration which specifies the state of the thread on creation with values Running and Suspend. Note: the Suspend option may not be available on all platforms. If it is not supported, the Create call will return INVALID_PARAM_ERROR. oIsJoinable = A boolean, which when set to true, creates a Joinable thread. The default value for this is false, which creates a Detached thread. Note 1: When a joinable thread is created, it is imperative to call thread Terminate. Otherwise, it would cause a memory leak. Note 2: This is currently available only for platforms that have support for pthreads. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>eOsclProcError </dd></dl>
</div>
</div>
<a class="anchor" id="a3f48fe531554523393a65388acebc53c"></a><!-- doxytag: member="OsclThread::Exit" ref="a3f48fe531554523393a65388acebc53c" args="(OsclAny *exitcode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static OSCL_IMPORT_REF void OsclThread::Exit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__osclbase.html#ga3bac54662348f5e6c08b97ca97066b89">OsclAny</a> * </td>
<td class="paramname"> <em>exitcode</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Exit is a static function which is used to end the current thread. When called it just ends the execution of the current thread. Note: on some platforms this may be a NOP. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>exitcode</em> </td><td>= Exitcode of the thread. This can be used by other threads to know the exit status of this thread. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>None </dd></dl>
</div>
</div>
<a class="anchor" id="a53544ee6b8f66c4251c734f207462266"></a><!-- doxytag: member="OsclThread::GetId" ref="a53544ee6b8f66c4251c734f207462266" args="(TOsclThreadId &refThreadId)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static OSCL_IMPORT_REF <a class="el" href="classOsclProcStatus.html#aabff5308a6581dcb84532c3b5d63b763">OsclProcStatus::eOsclProcError</a> OsclThread::GetId </td>
<td>(</td>
<td class="paramtype"><a class="el" href="osclconfig__proc__unix__android_8h.html#a82cf0793edd624dc416a6db1b916ef45">TOsclThreadId</a> & </td>
<td class="paramname"> <em>refThreadId</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Static routine to retrieve ID of calling thread. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Thread</em> </td><td>ID passed by the application </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Error code </dd></dl>
</div>
</div>
<a class="anchor" id="a891cc1efcbfcee9a49eee4320b22406e"></a><!-- doxytag: member="OsclThread::GetPriority" ref="a891cc1efcbfcee9a49eee4320b22406e" args="(OsclThreadPriority &refThreadPriority)" -->
<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> OsclThread::GetPriority </td>
<td>(</td>
<td class="paramtype"><a class="el" href="oscl__thread_8h.html#a2587c6e4a01b7ab59591b8f60ac71068">OsclThreadPriority</a> & </td>
<td class="paramname"> <em>refThreadPriority</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>GetThreadPriority gets the priority of the thread. It takes reference of the input argument and assigns priority to it from one of the already defined priorities. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>int16&</em> </td><td>refThreadPriority : Output Priority value </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Error code </dd></dl>
</div>
</div>
<a class="anchor" id="a14bbd5c5b4d356d4dcf9c0ad502391b5"></a><!-- doxytag: member="OsclThread::Resume" ref="a14bbd5c5b4d356d4dcf9c0ad502391b5" 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> OsclThread::Resume </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>ResumeThread resumes the suspended thread and brings it into execution. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>None</em> </td><td></td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Error code Note: this function may not be supported on all platforms, and may return NOT_IMPLEMENTED. </dd></dl>
</div>
</div>
<a class="anchor" id="a12debb16f97e8bef820ac499a67eb1b5"></a><!-- doxytag: member="OsclThread::SetPriority" ref="a12debb16f97e8bef820ac499a67eb1b5" args="(OsclThreadPriority ePriority)" -->
<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> OsclThread::SetPriority </td>
<td>(</td>
<td class="paramtype"><a class="el" href="oscl__thread_8h.html#a2587c6e4a01b7ab59591b8f60ac71068">OsclThreadPriority</a> </td>
<td class="paramname"> <em>ePriority</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>SetThreadPriority sets the priority of the thread. It takes priority as the input argument and assigns it to the thread referred. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ePriorityLevel</em> </td><td>: Input Priority value </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Error code Note: this function may not be supported on all platforms, and may return NOT_IMPLEMENTED. </dd></dl>
</div>
</div>
<a class="anchor" id="a77adbfece5bc46a65e8428046d05962b"></a><!-- doxytag: member="OsclThread::SleepMillisec" ref="a77adbfece5bc46a65e8428046d05962b" args="(const int32 msec)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static OSCL_IMPORT_REF void OsclThread::SleepMillisec </td>
<td>(</td>
<td class="paramtype">const int32 </td>
<td class="paramname"> <em>msec</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Suspend current thread execution for specified time. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>msec,t2,:</em> </td><td>sleep time in milliseconds. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a40d009495846071886f19c561c193a8e"></a><!-- doxytag: member="OsclThread::Suspend" ref="a40d009495846071886f19c561c193a8e" 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> OsclThread::Suspend </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This API suspends the thread being referred. The thread can later be brought into execution by calling OSCL_ResumeThread() on it. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>None</em> </td><td></td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Error code Note: this function may not be supported on all platforms, and may return NOT_IMPLEMENTED. </dd></dl>
</div>
</div>
<a class="anchor" id="aac962580ed4dc9132567a25d659ca34a"></a><!-- doxytag: member="OsclThread::Terminate" ref="aac962580ed4dc9132567a25d659ca34a" args="(OsclAny *exitcode)" -->
<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> OsclThread::Terminate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__osclbase.html#ga3bac54662348f5e6c08b97ca97066b89">OsclAny</a> * </td>
<td class="paramname"> <em>exitcode</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Terminate a thread other than the calling thread.</p>
<p>This API may have multiple behaviors. It may do a hard kill, a "join" operation, or a do-nothing. Caller can use CanTerminate option to tell the behavior in advance.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>exitcode</em> </td><td>= Exitcode of the thread. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Error code </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="oscl__thread_8h_source.html">oscl_thread.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>
|
