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
|
<!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: PVLoggerRegistry 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>PVLoggerRegistry Class Reference</h1><!-- doxytag: class="PVLoggerRegistry" -->
<p><code>#include <<a class="el" href="pvlogger__registry_8h_source.html">pvlogger_registry.h</a>></code></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classPVLogger.html#aa09724be71250bc721f19885e230873d">PVLogger::log_level_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPVLoggerRegistry.html#ae7aea846719fe00b493c2c8cc505eb5f">log_level_type</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="class__OsclBasicAllocator.html">PVLogger::alloc_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPVLoggerRegistry.html#aa1d05d38e94ff28411ab3a75c92b8cd9">alloc_type</a></td></tr>
<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="classPVLoggerRegistry.html#a37793154da4dd2e3d7f1168247714e66">PVLoggerRegistry</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual OSCL_IMPORT_REF </td><td class="memItemRight" valign="bottom"><a class="el" href="classPVLoggerRegistry.html#a61cfb1ebf4d5e31f6ff1818d5fec0037">~PVLoggerRegistry</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF <a class="el" href="classPVLogger.html">PVLogger</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPVLoggerRegistry.html#a5c69a47c59f53643505396d6c66859e4">GetPVLoggerObject</a> (const char *tagIn)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF <a class="el" href="classPVLogger.html">PVLogger</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPVLoggerRegistry.html#a549715e3f2295bb2734820239bfcf4fa">CreatePVLogger</a> (const char *tagIn, <a class="el" href="classPVLoggerRegistry.html#ae7aea846719fe00b493c2c8cc505eb5f">log_level_type</a> level, bool oAppenderInheritance)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPVLoggerRegistry.html#adcb342ff8f6118d7f7431bcf03c068d4">SetNodeLogLevelExplicit</a> (char *tagIn, <a class="el" href="classPVLoggerRegistry.html#ae7aea846719fe00b493c2c8cc505eb5f">log_level_type</a> level)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPVLoggerRegistry.html#a91de8c5ff1f80c71c333ffc04ad26d15">SetNodeLogLevelExplicit</a> (<a class="el" href="classOscl__TagTree.html">Oscl_TagTree</a>< <a class="el" href="classPVLogger.html">PVLogger</a> *, <a class="el" href="class__OsclBasicAllocator.html">alloc_type</a> >::node_type *node, <a class="el" href="classPVLoggerRegistry.html#ae7aea846719fe00b493c2c8cc505eb5f">log_level_type</a> level)</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 <br class="typebreak"/>
<a class="el" href="classPVLoggerRegistry.html">PVLoggerRegistry</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPVLoggerRegistry.html#a5834d7a260eab2990f22556cc51b7a90">GetPVLoggerRegistry</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Class: <a class="el" href="classPVLoggerRegistry.html">PVLoggerRegistry</a></p>
<p><a class="el" href="classPVLoggerRegistry.html">PVLoggerRegistry</a> class, maintains a repository of all the loggers, along with their associated tags, in a tag tree. Any request for a log control point is serviced by this class.</p>
<p>Memory Ownership: Creates log control points for each tag, and holds these pointers in the tag tree. <a class="el" href="classPVLogger.html">PVLogger</a> registry is responsible for calling the destructor on each of these loggers. </p>
<hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="aa1d05d38e94ff28411ab3a75c92b8cd9"></a><!-- doxytag: member="PVLoggerRegistry::alloc_type" ref="aa1d05d38e94ff28411ab3a75c92b8cd9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="class__OsclBasicAllocator.html">PVLogger::alloc_type</a> <a class="el" href="class__OsclBasicAllocator.html">PVLoggerRegistry::alloc_type</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ae7aea846719fe00b493c2c8cc505eb5f"></a><!-- doxytag: member="PVLoggerRegistry::log_level_type" ref="ae7aea846719fe00b493c2c8cc505eb5f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classPVLogger.html#aa09724be71250bc721f19885e230873d">PVLogger::log_level_type</a> <a class="el" href="classPVLoggerRegistry.html#ae7aea846719fe00b493c2c8cc505eb5f">PVLoggerRegistry::log_level_type</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a37793154da4dd2e3d7f1168247714e66"></a><!-- doxytag: member="PVLoggerRegistry::PVLoggerRegistry" ref="a37793154da4dd2e3d7f1168247714e66" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OSCL_IMPORT_REF PVLoggerRegistry::PVLoggerRegistry </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classPVLoggerRegistry.html">PVLoggerRegistry</a> Constructor </p>
</div>
</div>
<a class="anchor" id="a61cfb1ebf4d5e31f6ff1818d5fec0037"></a><!-- doxytag: member="PVLoggerRegistry::~PVLoggerRegistry" ref="a61cfb1ebf4d5e31f6ff1818d5fec0037" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual OSCL_IMPORT_REF PVLoggerRegistry::~PVLoggerRegistry </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classPVLoggerRegistry.html">PVLoggerRegistry</a> Destructor </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a549715e3f2295bb2734820239bfcf4fa"></a><!-- doxytag: member="PVLoggerRegistry::CreatePVLogger" ref="a549715e3f2295bb2734820239bfcf4fa" args="(const char *tagIn, log_level_type level, bool oAppenderInheritance)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OSCL_IMPORT_REF <a class="el" href="classPVLogger.html">PVLogger</a>* PVLoggerRegistry::CreatePVLogger </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>tagIn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classPVLoggerRegistry.html#ae7aea846719fe00b493c2c8cc505eb5f">log_level_type</a> </td>
<td class="paramname"> <em>level</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>oAppenderInheritance</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method creates a log control point, with specified tag, and level</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>inputTag</em> </td><td>logger tag, viz. "x.y.z" </td></tr>
<tr><td valign="top"></td><td valign="top"><em>level</em> </td><td>log level associated with the logging control point</td></tr>
<tr><td valign="top"></td><td valign="top"><em>oAppenderInheritance</em> </td><td></td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>PVLogger<alloc_type, TheLock>* Pointer to the logging control point </dd></dl>
</div>
</div>
<a class="anchor" id="a5c69a47c59f53643505396d6c66859e4"></a><!-- doxytag: member="PVLoggerRegistry::GetPVLoggerObject" ref="a5c69a47c59f53643505396d6c66859e4" args="(const char *tagIn)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OSCL_IMPORT_REF <a class="el" href="classPVLogger.html">PVLogger</a>* PVLoggerRegistry::GetPVLoggerObject </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>tagIn</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classPVLoggerRegistry.html">PVLoggerRegistry</a> method to get access to a logging control point, associated with a tag. In case the logger for this tag does not exist, it is created afresh, else pointer to the existing one is returned.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>inputTag</em> </td><td>logger tag, viz. "x.y.z" </td></tr>
<tr><td valign="top"></td><td valign="top"><em>level</em> </td><td>log level associated with the logging control point</td></tr>
<tr><td valign="top"></td><td valign="top"><em>oAppenderInheritance</em> </td><td></td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>PVLogger<Alloc, TheLock>* Pointer to the logging control point </dd></dl>
</div>
</div>
<a class="anchor" id="a5834d7a260eab2990f22556cc51b7a90"></a><!-- doxytag: member="PVLoggerRegistry::GetPVLoggerRegistry" ref="a5834d7a260eab2990f22556cc51b7a90" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static OSCL_IMPORT_REF <a class="el" href="classPVLoggerRegistry.html">PVLoggerRegistry</a>* PVLoggerRegistry::GetPVLoggerRegistry </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the logger registry. There is only one logger registry instance per thread. </p>
</div>
</div>
<a class="anchor" id="a91de8c5ff1f80c71c333ffc04ad26d15"></a><!-- doxytag: member="PVLoggerRegistry::SetNodeLogLevelExplicit" ref="a91de8c5ff1f80c71c333ffc04ad26d15" args="(Oscl_TagTree< PVLogger *, alloc_type >::node_type *node, log_level_type level)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OSCL_IMPORT_REF void PVLoggerRegistry::SetNodeLogLevelExplicit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classOscl__TagTree.html">Oscl_TagTree</a>< <a class="el" href="classPVLogger.html">PVLogger</a> *, <a class="el" href="class__OsclBasicAllocator.html">alloc_type</a> >::node_type * </td>
<td class="paramname"> <em>node</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classPVLoggerRegistry.html#ae7aea846719fe00b493c2c8cc505eb5f">log_level_type</a> </td>
<td class="paramname"> <em>level</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method recursively propagates the log level to all the descendents, of a node.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>node</em> </td><td>Node ptr, associated with a logger, from the tag tree. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>level</em> </td><td>log level associated with the logging control point</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>NONE </dd></dl>
</div>
</div>
<a class="anchor" id="adcb342ff8f6118d7f7431bcf03c068d4"></a><!-- doxytag: member="PVLoggerRegistry::SetNodeLogLevelExplicit" ref="adcb342ff8f6118d7f7431bcf03c068d4" args="(char *tagIn, log_level_type level)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OSCL_IMPORT_REF bool PVLoggerRegistry::SetNodeLogLevelExplicit </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>tagIn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classPVLoggerRegistry.html#ae7aea846719fe00b493c2c8cc505eb5f">log_level_type</a> </td>
<td class="paramname"> <em>level</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method propagates the log level to all the descendents of the node, with a specified tag.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>tagIn</em> </td><td>logger tag, viz. "x.y.z" </td></tr>
<tr><td valign="top"></td><td valign="top"><em>level</em> </td><td>log level associated with the logging control point</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, else false. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="pvlogger__registry_8h_source.html">pvlogger_registry.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>
|
