aboutsummaryrefslogtreecommitdiff
path: root/doc/oscl_html/oscl__thread_8h_source.html
blob: dab717845faa1731bba18c446ce6a2411719111d (plain)
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
<!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_thread.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_thread.h</h1><a href="oscl__thread_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// -*- c++ -*-</span>
<a name="l00002"></a>00002 <span class="comment">// = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =</span>
<a name="l00003"></a>00003 
<a name="l00004"></a>00004 <span class="comment">//                  OSCL_T H R E A D (T H R E A D  I M P L E M E N T A T I O N)</span>
<a name="l00005"></a>00005 
<a name="l00006"></a>00006 <span class="comment">// = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =</span>
<a name="l00007"></a>00007 
<a name="l00013"></a>00013 <span class="comment">// Definition file for OSCL Threads</span>
<a name="l00014"></a>00014 <span class="preprocessor">#ifndef OSCL_THREAD_H_INCLUDED</span>
<a name="l00015"></a>00015 <span class="preprocessor"></span><span class="preprocessor">#define OSCL_THREAD_H_INCLUDED</span>
<a name="l00016"></a>00016 <span class="preprocessor"></span>
<a name="l00017"></a>00017 <span class="preprocessor">#ifndef OSCLCONFIG_PROC_H_INCLUDED</span>
<a name="l00018"></a>00018 <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="l00019"></a>00019 <span class="preprocessor">#endif</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span>
<a name="l00021"></a>00021 <span class="preprocessor">#ifndef OSCL_PROCSTATUS_H_INCLUDED</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#include &quot;<a class="code" href="oscl__procstatus_8h.html">oscl_procstatus.h</a>&quot;</span>
<a name="l00023"></a>00023 <span class="preprocessor">#endif</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#ifndef OSCL_BASE_H_INCLUDED</span>
<a name="l00026"></a>00026 <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="l00027"></a>00027 <span class="preprocessor">#endif</span>
<a name="l00028"></a>00028 <span class="preprocessor"></span>
<a name="l00029"></a>00029 
<a name="l00030"></a>00030 <span class="comment">// Thread state on creation</span>
<a name="l00031"></a><a class="code" href="oscl__thread_8h.html#a0d37915480fc468c9db787088de58070">00031</a> <span class="keyword">enum</span> <a class="code" href="oscl__thread_8h.html#a0d37915480fc468c9db787088de58070">OsclThread_State</a>
<a name="l00032"></a>00032 {
<a name="l00033"></a><a class="code" href="oscl__thread_8h.html#a0d37915480fc468c9db787088de58070ae83d7e8a00c0d680b8df3f95735dfb27">00033</a>     <a class="code" href="oscl__thread_8h.html#a0d37915480fc468c9db787088de58070ae83d7e8a00c0d680b8df3f95735dfb27">Start_on_creation</a>
<a name="l00034"></a><a class="code" href="oscl__thread_8h.html#a0d37915480fc468c9db787088de58070a7825ce8f06c04faa4b736b586c3d796c">00034</a>     , <a class="code" href="oscl__thread_8h.html#a0d37915480fc468c9db787088de58070a7825ce8f06c04faa4b736b586c3d796c">Suspend_on_creation</a>
<a name="l00035"></a>00035 };
<a name="l00036"></a>00036 
<a name="l00037"></a>00037 <span class="comment">// Enumerated Priority Values</span>
<a name="l00038"></a><a class="code" href="oscl__thread_8h.html#a2587c6e4a01b7ab59591b8f60ac71068">00038</a> <span class="keyword">enum</span> <a class="code" href="oscl__thread_8h.html#a2587c6e4a01b7ab59591b8f60ac71068">OsclThreadPriority</a>
<a name="l00039"></a>00039 {
<a name="l00040"></a><a class="code" href="oscl__thread_8h.html#a2587c6e4a01b7ab59591b8f60ac71068af7f7d84c68273d64015bdaddd38100be">00040</a>     <a class="code" href="oscl__thread_8h.html#a2587c6e4a01b7ab59591b8f60ac71068af7f7d84c68273d64015bdaddd38100be">ThreadPriorityLowest</a>
<a name="l00041"></a><a class="code" href="oscl__thread_8h.html#a2587c6e4a01b7ab59591b8f60ac71068ac86990771d3829bcf5d529e643a8d871">00041</a>     , <a class="code" href="oscl__thread_8h.html#a2587c6e4a01b7ab59591b8f60ac71068ac86990771d3829bcf5d529e643a8d871">ThreadPriorityLow</a>
<a name="l00042"></a><a class="code" href="oscl__thread_8h.html#a2587c6e4a01b7ab59591b8f60ac71068ad5f8cbab7abc8dd2a72f9e68960daaec">00042</a>     , <a class="code" href="oscl__thread_8h.html#a2587c6e4a01b7ab59591b8f60ac71068ad5f8cbab7abc8dd2a72f9e68960daaec">ThreadPriorityBelowNormal</a>
<a name="l00043"></a><a class="code" href="oscl__thread_8h.html#a2587c6e4a01b7ab59591b8f60ac71068a4070705cf29496e7266bf45cc9cc6384">00043</a>     , <a class="code" href="oscl__thread_8h.html#a2587c6e4a01b7ab59591b8f60ac71068a4070705cf29496e7266bf45cc9cc6384">ThreadPriorityNormal</a>
<a name="l00044"></a><a class="code" href="oscl__thread_8h.html#a2587c6e4a01b7ab59591b8f60ac71068a23a8d742691a102b78c64f264c32ea3b">00044</a>     , <a class="code" href="oscl__thread_8h.html#a2587c6e4a01b7ab59591b8f60ac71068a23a8d742691a102b78c64f264c32ea3b">ThreadPriorityAboveNormal</a>
<a name="l00045"></a><a class="code" href="oscl__thread_8h.html#a2587c6e4a01b7ab59591b8f60ac71068a81d3cd9ae353c730376af5e6c30b0cda">00045</a>     , <a class="code" href="oscl__thread_8h.html#a2587c6e4a01b7ab59591b8f60ac71068a81d3cd9ae353c730376af5e6c30b0cda">ThreadPriorityHighest</a>
<a name="l00046"></a><a class="code" href="oscl__thread_8h.html#a2587c6e4a01b7ab59591b8f60ac71068a6ea6662767be4cb26531587df74cbd41">00046</a>     , <a class="code" href="oscl__thread_8h.html#a2587c6e4a01b7ab59591b8f60ac71068a6ea6662767be4cb26531587df74cbd41">ThreadPriorityTimeCritical</a>
<a name="l00047"></a>00047 };
<a name="l00048"></a>00048 
<a name="l00049"></a>00049 <span class="comment">// Thread termiante options</span>
<a name="l00050"></a><a class="code" href="oscl__thread_8h.html#a3bc2a7f5d639c996fb80f60bb53bf4a9">00050</a> <span class="keyword">enum</span> <a class="code" href="oscl__thread_8h.html#a3bc2a7f5d639c996fb80f60bb53bf4a9">TOsclThreadTerminate</a>
<a name="l00051"></a>00051 {
<a name="l00052"></a><a class="code" href="oscl__thread_8h.html#a3bc2a7f5d639c996fb80f60bb53bf4a9a4cda73156655549ce0f02e8e98eb3b4b">00052</a>     <a class="code" href="oscl__thread_8h.html#a3bc2a7f5d639c996fb80f60bb53bf4a9a4cda73156655549ce0f02e8e98eb3b4b">EOsclThreadTerminate_Join</a>,
<a name="l00053"></a><a class="code" href="oscl__thread_8h.html#a3bc2a7f5d639c996fb80f60bb53bf4a9afbb022f8ebe629ab036579d93e8ad214">00053</a>     <a class="code" href="oscl__thread_8h.html#a3bc2a7f5d639c996fb80f60bb53bf4a9afbb022f8ebe629ab036579d93e8ad214">EOsclThreadTerminate_Kill</a>,
<a name="l00054"></a><a class="code" href="oscl__thread_8h.html#a3bc2a7f5d639c996fb80f60bb53bf4a9a29fb75f23807b312a865d83026f3e695">00054</a>     <a class="code" href="oscl__thread_8h.html#a3bc2a7f5d639c996fb80f60bb53bf4a9a29fb75f23807b312a865d83026f3e695">EOsclThreadTerminate_NOP</a>
<a name="l00055"></a>00055 };
<a name="l00056"></a>00056 
<a name="l00057"></a>00057 
<a name="l00058"></a>00058 <span class="comment">//thread function pointer type.</span>
<a name="l00059"></a><a class="code" href="oscl__thread_8h.html#a281d92b5b90c97da3cbcacf3a9db0505">00059</a> <span class="keyword">typedef</span> <a class="code" href="osclconfig__proc__unix__common_8h.html#a6a8ba6877fc9fc6d457fd188ccbc8086">TOsclThreadFuncRet</a>(<a class="code" href="osclconfig__proc__unix__common_8h.html#aaeb6171095ea30f92f3e7c0106901d26">OSCL_THREAD_DECL</a> *<a class="code" href="oscl__thread_8h.html#a281d92b5b90c97da3cbcacf3a9db0505">TOsclThreadFuncPtr</a>)(<a class="code" href="osclconfig__proc__unix__common_8h.html#a79dc72e19d6ed5a3fd5f49a14f0fdb92">TOsclThreadFuncArg</a>);
<a name="l00060"></a>00060 
<a name="l00067"></a><a class="code" href="classOsclThread.html">00067</a> <span class="keyword">class </span><a class="code" href="classOsclThread.html">OsclThread</a>
<a name="l00068"></a>00068 {
<a name="l00069"></a>00069 
<a name="l00070"></a>00070     <span class="keyword">public</span>:
<a name="l00071"></a>00071 
<a name="l00075"></a>00075         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> <a class="code" href="classOsclThread.html#ac520537de13eadc7cfbbdad6ee6e5939">OsclThread</a>();
<a name="l00076"></a>00076 
<a name="l00080"></a>00080         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> <a class="code" href="classOsclThread.html#a9f414ae7e0796a1e5740be998c414b38">~OsclThread</a>();
<a name="l00081"></a>00081 
<a name="l00106"></a>00106         <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="classOsclThread.html#ac69068f62a332bca5f3f5e7a8175e395">Create</a>(<a class="code" href="oscl__thread_8h.html#a281d92b5b90c97da3cbcacf3a9db0505">TOsclThreadFuncPtr</a> func,
<a name="l00107"></a>00107                 int32 stack_size,
<a name="l00108"></a>00108                 <a class="code" href="osclconfig__proc__unix__common_8h.html#a79dc72e19d6ed5a3fd5f49a14f0fdb92">TOsclThreadFuncArg</a> argument,
<a name="l00109"></a>00109                 <a class="code" href="oscl__thread_8h.html#a0d37915480fc468c9db787088de58070">OsclThread_State</a> state = <a class="code" href="oscl__thread_8h.html#a0d37915480fc468c9db787088de58070ae83d7e8a00c0d680b8df3f95735dfb27">Start_on_creation</a>,
<a name="l00110"></a>00110                 <span class="keywordtype">bool</span> oIsJoinable = <span class="keyword">false</span>);
<a name="l00111"></a>00111 
<a name="l00121"></a>00121         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classOsclThread.html#a3f48fe531554523393a65388acebc53c">Exit</a>(<a class="code" href="group__osclbase.html#ga3bac54662348f5e6c08b97ca97066b89" title="The OsclAny is meant to be used the context of a generic pointer (i.e., no specific...">OsclAny</a>* exitcode);
<a name="l00122"></a>00122 
<a name="l00130"></a>00130         <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="classOsclThread.html#a891cc1efcbfcee9a49eee4320b22406e">GetPriority</a>(<a class="code" href="oscl__thread_8h.html#a2587c6e4a01b7ab59591b8f60ac71068">OsclThreadPriority</a>&amp; refThreadPriority);
<a name="l00131"></a>00131 
<a name="l00141"></a>00141         <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="classOsclThread.html#a12debb16f97e8bef820ac499a67eb1b5">SetPriority</a>(<a class="code" href="oscl__thread_8h.html#a2587c6e4a01b7ab59591b8f60ac71068">OsclThreadPriority</a> ePriority);
<a name="l00142"></a>00142 
<a name="l00151"></a>00151         <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="classOsclThread.html#a40d009495846071886f19c561c193a8e">Suspend</a>();
<a name="l00152"></a>00152 
<a name="l00160"></a>00160         <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="classOsclThread.html#a14bbd5c5b4d356d4dcf9c0ad502391b5">Resume</a>();
<a name="l00161"></a>00161 
<a name="l00173"></a>00173         <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="classOsclThread.html#aac962580ed4dc9132567a25d659ca34a">Terminate</a>(<a class="code" href="group__osclbase.html#ga3bac54662348f5e6c08b97ca97066b89" title="The OsclAny is meant to be used the context of a generic pointer (i.e., no specific...">OsclAny</a>* exitcode);
<a name="l00174"></a>00174 
<a name="l00179"></a>00179         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> <a class="code" href="oscl__thread_8h.html#a3bc2a7f5d639c996fb80f60bb53bf4a9">TOsclThreadTerminate</a> <a class="code" href="classOsclThread.html#ac651c00cc339e71ef832e329c4d086e9">CanTerminate</a>();
<a name="l00180"></a>00180 
<a name="l00181"></a>00181 
<a name="l00187"></a>00187         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> <span class="keyword">static</span> <a class="code" href="classOsclProcStatus.html#aabff5308a6581dcb84532c3b5d63b763">OsclProcStatus::eOsclProcError</a> <a class="code" href="classOsclThread.html#a53544ee6b8f66c4251c734f207462266">GetId</a>(<a class="code" href="osclconfig__proc__unix__common_8h.html#a82cf0793edd624dc416a6db1b916ef45">TOsclThreadId</a>&amp; refThreadId);
<a name="l00188"></a>00188 
<a name="l00194"></a>00194         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classOsclThread.html#a2764b0fcf9b8e7d130d53cb3e32d9a9b">CompareId</a>(<a class="code" href="osclconfig__proc__unix__common_8h.html#a82cf0793edd624dc416a6db1b916ef45">TOsclThreadId</a> &amp;t1, <a class="code" href="osclconfig__proc__unix__common_8h.html#a82cf0793edd624dc416a6db1b916ef45">TOsclThreadId</a> &amp;t2);
<a name="l00195"></a>00195 
<a name="l00200"></a>00200         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classOsclThread.html#a77adbfece5bc46a65e8428046d05962b">SleepMillisec</a>(<span class="keyword">const</span> int32 msec);
<a name="l00201"></a>00201 
<a name="l00202"></a>00202     <span class="keyword">private</span>:
<a name="l00203"></a>00203 
<a name="l00211"></a>00211         <a class="code" href="classOsclProcStatus.html#aabff5308a6581dcb84532c3b5d63b763">OsclProcStatus::eOsclProcError</a> MapOsclError(int16 error);
<a name="l00212"></a>00212 
<a name="l00213"></a>00213 
<a name="l00214"></a>00214         <a class="code" href="osclconfig__proc__unix__common_8h.html#ad614b4fd9839f6ad888115bdb9770be5">TOsclMutexObject</a> mutex;
<a name="l00215"></a>00215         <a class="code" href="osclconfig__proc__unix__common_8h.html#af87c672d3e1f8e65c95240b4efb69fa8">TOsclConditionObject</a>  condition;
<a name="l00216"></a>00216         uint8 suspend;
<a name="l00217"></a>00217         <span class="keywordtype">bool</span> bJoinable;
<a name="l00218"></a>00218 
<a name="l00219"></a>00219 
<a name="l00220"></a>00220 
<a name="l00221"></a>00221         <a class="code" href="osclconfig__proc__unix__common_8h.html#a868f0541091962c9d2756cc2ed1875be">TOsclThreadObject</a> ObjThread;
<a name="l00222"></a>00222         <span class="keywordtype">bool</span> bCreated;
<a name="l00223"></a>00223 };
<a name="l00224"></a>00224 
<a name="l00225"></a>00225 <span class="preprocessor">#endif</span>
<a name="l00226"></a>00226 <span class="preprocessor"></span>
</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>