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
|
<!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_singleton.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 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><a href="annotated.html"><span>Data 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 List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<h1>oscl_singleton.h</h1><a href="oscl__singleton_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">// O S C L _ S I N G L E T O N</span>
<a name="l00005"></a>00005
<a name="l00006"></a>00006 <span class="comment">// = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =</span>
<a name="l00007"></a>00007
<a name="l00020"></a>00020 <span class="preprocessor">#ifndef OSCL_SINGLETON_H_INCLUDED</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define OSCL_SINGLETON_H_INCLUDED</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span>
<a name="l00023"></a>00023 <span class="preprocessor">#ifndef OSCL_BASE_H_INCLUDED</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#include "<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>"</span>
<a name="l00025"></a>00025 <span class="preprocessor">#endif</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span>
<a name="l00027"></a>00027 <span class="preprocessor">#ifndef OSCL_DEFALLOC_H_INCLUDED</span>
<a name="l00028"></a>00028 <span class="preprocessor"></span><span class="preprocessor">#include "<a class="code" href="oscl__defalloc_8h.html" title="The file defines simple default memory allocator classes. These allocators are used...">oscl_defalloc.h</a>"</span>
<a name="l00029"></a>00029 <span class="preprocessor">#endif</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="preprocessor">#if (OSCL_HAS_SINGLETON_SUPPORT)</span>
<a name="l00033"></a>00033 <span class="preprocessor"></span>
<a name="l00034"></a>00034 <span class="comment">//verify config-- singleton support requires global var support</span>
<a name="l00035"></a>00035
<a name="l00036"></a>00036 <span class="comment">// list of singleton objects</span>
<a name="l00037"></a>00037 <span class="keyword">const</span> uint32 OSCL_SINGLETON_ID_TEST = 0;
<a name="l00038"></a>00038 <span class="keyword">const</span> uint32 OSCL_SINGLETON_ID_OSCLMEM = 1;
<a name="l00039"></a>00039 <span class="keyword">const</span> uint32 OSCL_SINGLETON_ID_PVLOGGER = 2;
<a name="l00040"></a>00040 <span class="keyword">const</span> uint32 OSCL_SINGLETON_ID_PVSCHEDULER = 3;
<a name="l00041"></a>00041 <span class="keyword">const</span> uint32 OSCL_SINGLETON_ID_PVERRORTRAP = 4;
<a name="l00042"></a>00042 <span class="keyword">const</span> uint32 OSCL_SINGLETON_ID_SDPMEDIAPARSER = 5;
<a name="l00043"></a>00043 <span class="keyword">const</span> uint32 OSCL_SINGLETON_ID_PAYLOADPARSER = 6;
<a name="l00044"></a>00044 <span class="keyword">const</span> uint32 OSCL_SINGLETON_ID_CPM_PLUGIN = 7;
<a name="l00045"></a>00045 <span class="keyword">const</span> uint32 OSCL_SINGLETON_ID_PVMFRECOGNIZER = 8;
<a name="l00046"></a>00046 <span class="keyword">const</span> uint32 OSCL_SINGLETON_ID_OSCLREGISTRY = 9;
<a name="l00047"></a>00047 <span class="keyword">const</span> uint32 OSCL_SINGLETON_ID_OMX = 10;
<a name="l00048"></a>00048 <span class="keyword">const</span> uint32 OSCL_SINGLETON_ID_OMXMASTERCORE = 11;
<a name="l00049"></a>00049 <span class="keyword">const</span> uint32 OSCL_SINGLETON_ID_TICKCOUNT = 12;
<a name="l00050"></a>00050 <span class="keyword">const</span> uint32 OSCL_SINGLETON_ID_WMDRMLOCK = 13;
<a name="l00051"></a>00051 <span class="keyword">const</span> uint32 OSCL_SINGLETON_ID_LAST = 14;
<a name="l00052"></a>00052
<a name="l00053"></a>00053
<a name="l00054"></a>00054 <span class="keyword">class </span>OsclSingletonRegistry
<a name="l00055"></a>00055 {
<a name="l00056"></a>00056 <span class="keyword">public</span>:
<a name="l00057"></a>00057 <span class="comment">/*</span>
<a name="l00058"></a>00058 <span class="comment"> ** Get an entry</span>
<a name="l00059"></a>00059 <span class="comment"> ** @param ID: identifier</span>
<a name="l00060"></a>00060 <span class="comment"> ** @param error (output) 0 for success or an error from TPVBaseErrorEnum</span>
<a name="l00061"></a>00061 <span class="comment"> ** @returns: the entry value</span>
<a name="l00062"></a>00062 <span class="comment"> */</span>
<a name="l00063"></a>00063 <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> <span class="keyword">static</span> <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>* getInstance(uint32 ID, int32 &error);
<a name="l00064"></a>00064 <span class="comment">/*</span>
<a name="l00065"></a>00065 <span class="comment"> ** Set an entry</span>
<a name="l00066"></a>00066 <span class="comment"> ** @param ID: identifier</span>
<a name="l00067"></a>00067 <span class="comment"> ** @param error (output) 0 for success or an error from TPVBaseErrorEnum</span>
<a name="l00068"></a>00068 <span class="comment"> ** @returns: the entry value</span>
<a name="l00069"></a>00069 <span class="comment"> */</span>
<a name="l00070"></a>00070 <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> <span class="keyword">static</span> <span class="keywordtype">void</span> registerInstance(<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>* ptr, uint32 ID, int32 &error);
<a name="l00071"></a>00071
<a name="l00072"></a>00072 <span class="comment">/*</span>
<a name="l00073"></a>00073 <span class="comment"> //These two APIs can be used to do "test and set" operations on a singleton.</span>
<a name="l00074"></a>00074 <span class="comment"> //Be sure to always call both APIs to avoid deadlock.</span>
<a name="l00075"></a>00075 <span class="comment"> */</span>
<a name="l00076"></a>00076
<a name="l00077"></a>00077 <span class="comment">/*</span>
<a name="l00078"></a>00078 <span class="comment"> * Return the current value of the singleton and leave the singleton table locked</span>
<a name="l00079"></a>00079 <span class="comment"> * on return.</span>
<a name="l00080"></a>00080 <span class="comment"> * @param ID the singleton ID</span>
<a name="l00081"></a>00081 <span class="comment"> ** @param error (output) 0 for success or an error from TPVBaseErrorEnum</span>
<a name="l00082"></a>00082 <span class="comment"> * @returns the singleton value.</span>
<a name="l00083"></a>00083 <span class="comment"> */</span>
<a name="l00084"></a>00084 <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> <span class="keyword">static</span> <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>* lockAndGetInstance(uint32 ID, int32& error);
<a name="l00085"></a>00085 <span class="comment">/*</span>
<a name="l00086"></a>00086 <span class="comment"> * Set the value of the singleton. Assume the singleton table is locked on entry.</span>
<a name="l00087"></a>00087 <span class="comment"> * @param ptr the singleton value</span>
<a name="l00088"></a>00088 <span class="comment"> * @param ID the singleton ID</span>
<a name="l00089"></a>00089 <span class="comment"> ** @param error (output) 0 for success or an error from TPVBaseErrorEnum</span>
<a name="l00090"></a>00090 <span class="comment"> */</span>
<a name="l00091"></a>00091 <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> <span class="keyword">static</span> <span class="keywordtype">void</span> registerInstanceAndUnlock(<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>* ptr, uint32 ID, int32& error);
<a name="l00092"></a>00092
<a name="l00093"></a>00093 <span class="keyword">private</span>:
<a name="l00094"></a>00094 OsclSingletonRegistry()
<a name="l00095"></a>00095 {}
<a name="l00096"></a>00096 <span class="keyword">typedef</span> <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>* registry_type;
<a name="l00097"></a>00097 <span class="keyword">typedef</span> registry_type* registry_pointer_type;
<a name="l00098"></a>00098
<a name="l00099"></a>00099 <span class="keyword">private</span>:
<a name="l00100"></a>00100 <span class="keyword">friend</span> <span class="keyword">class </span>OsclBase;
<a name="l00101"></a>00101
<a name="l00102"></a>00102 <span class="keyword">private</span>:
<a name="l00103"></a>00103 <span class="keyword">class </span>SingletonTable
<a name="l00104"></a>00104 {
<a name="l00105"></a>00105 <span class="keyword">public</span>:
<a name="l00106"></a>00106 SingletonTable()
<a name="l00107"></a>00107 {
<a name="l00108"></a>00108 <span class="keywordflow">for</span> (uint32 i = 0; i < OSCL_SINGLETON_ID_LAST; i++)
<a name="l00109"></a>00109 iSingletons[i] = <a class="code" href="group__osclbase.html#ga070d2ce7b6bb7e5c05602aa8c308d0c4" title="The NULL_TERM_CHAR is used to terminate c-style strings.">NULL</a>;
<a name="l00110"></a>00110 }
<a name="l00111"></a>00111 <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>* iSingletons[OSCL_SINGLETON_ID_LAST];
<a name="l00112"></a>00112 _OsclBasicLock iSingletonLocks[OSCL_SINGLETON_ID_LAST];
<a name="l00113"></a>00113 };
<a name="l00114"></a>00114 <span class="comment">//The singleton table is a global variable.</span>
<a name="l00115"></a>00115 <span class="keyword">static</span> SingletonTable sSingletonTable;
<a name="l00116"></a>00116 };
<a name="l00117"></a>00117
<a name="l00118"></a>00118 <span class="keyword">template</span> < <span class="keyword">class</span> T, u<span class="keywordtype">int</span>32 ID, <span class="keyword">class</span> Registry = OsclSingletonRegistry > <span class="keyword">class </span>OsclSingleton
<a name="l00119"></a>00119 {
<a name="l00120"></a>00120 <span class="keyword">private</span>:
<a name="l00121"></a>00121 <span class="comment">// make the copy constructor and assignment operator private</span>
<a name="l00122"></a>00122 OsclSingleton& operator=(OsclSingleton& _Y)
<a name="l00123"></a>00123 {
<a name="l00124"></a>00124 <span class="keywordflow">return</span>(*<span class="keyword">this</span>);
<a name="l00125"></a>00125 }
<a name="l00126"></a>00126
<a name="l00127"></a>00127 <span class="keyword">protected</span>:
<a name="l00128"></a>00128 T* _Ptr;
<a name="l00129"></a>00129
<a name="l00130"></a>00130 <span class="keyword">public</span>:
<a name="l00131"></a>00131 OsclSingleton()
<a name="l00132"></a>00132 {
<a name="l00133"></a>00133 int32 err;
<a name="l00134"></a>00134 _Ptr = <a class="code" href="group__osclbase.html#ga6872259ca6fd7080c6299210e4b13a6f">OSCL_STATIC_CAST</a>(T*, Registry::getInstance(ID, err));
<a name="l00135"></a>00135 }
<a name="l00136"></a>00136
<a name="l00137"></a>00137 ~OsclSingleton() {};
<a name="l00138"></a>00138
<a name="l00146"></a>00146 T& operator*()<span class="keyword"> const</span>
<a name="l00147"></a>00147 <span class="keyword"> </span>{
<a name="l00148"></a>00148 <span class="keywordflow">return</span>(*_Ptr);
<a name="l00149"></a>00149 }
<a name="l00150"></a>00150
<a name="l00158"></a>00158 T *operator->()<span class="keyword"> const</span>
<a name="l00159"></a>00159 <span class="keyword"> </span>{
<a name="l00160"></a>00160 <span class="keywordflow">return</span>(_Ptr);
<a name="l00161"></a>00161 }
<a name="l00162"></a>00162
<a name="l00163"></a>00163
<a name="l00170"></a>00170 <span class="keywordtype">bool</span> <span class="keyword">set</span>()
<a name="l00171"></a>00171 {
<a name="l00172"></a>00172 int32 err;
<a name="l00173"></a>00173 _Ptr = <a class="code" href="group__osclbase.html#ga6872259ca6fd7080c6299210e4b13a6f">OSCL_STATIC_CAST</a>(T*, Registry::getInstance(ID, err));
<a name="l00174"></a>00174 <span class="keywordflow">return</span> (_Ptr ? <span class="keyword">true</span> : <span class="keyword">false</span>);
<a name="l00175"></a>00175 }
<a name="l00176"></a>00176
<a name="l00177"></a>00177 };
<a name="l00178"></a>00178
<a name="l00179"></a>00179
<a name="l00180"></a>00180 <span class="preprocessor">#endif //OSCL_HAS_SINGLETON_SUPPORT</span>
<a name="l00181"></a>00181 <span class="preprocessor"></span>
<a name="l00182"></a>00182 <span class="preprocessor">#endif</span>
<a name="l00183"></a>00183 <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.004.1.1 </small>
</small></address>
</body>
</html>
|
