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
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
|
<!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: PVLogger 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>PVLogger Class Reference</h1><!-- doxytag: class="PVLogger" -->
<p><code>#include <<a class="el" href="pvlogger_8h_source.html">pvlogger.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 int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classPVLogger.html#aa09724be71250bc721f19885e230873d">log_level_type</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classPVLogger.html#aa4fbeb8deb89867ae2414db65f987815">message_id_type</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classPVLogger.html#ae06d7464a1e5f505ccda6f62fb3ca313">filter_status_type</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="class__OsclBasicAllocator.html">_OsclBasicAllocator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPVLogger.html#a3cd7eda43287a1f3d705e57a13bb11f2">alloc_type</a></td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPVLogger.html#aa88033dcb2db4ea1fbbd606a30f23d1a">SetLogLevel</a> (<a class="el" href="classPVLogger.html#aa09724be71250bc721f19885e230873d">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="classPVLogger.html#a8d7e8e026a1a2ce560804c1d9d650eb6">SetLogLevelAndPropagate</a> (<a class="el" href="classPVLogger.html#aa09724be71250bc721f19885e230873d">log_level_type</a> level)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classPVLogger.html#aa09724be71250bc721f19885e230873d">log_level_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPVLogger.html#a28272271f4d1b9eb6045a66b4d5004f1">GetLogLevel</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPVLogger.html#ab7f9fab233ead23fdc0a4075456531b7">DisableAppenderInheritance</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPVLogger.html#ab6e46d998c52634ab566ac2380cda4a9">AddAppender</a> (<a class="el" href="classOsclSharedPtr.html">OsclSharedPtr</a>< <a class="el" href="classPVLoggerAppender.html">PVLoggerAppender</a> > &appender)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPVLogger.html#ad093d21fc9a868735dac8579cc097b2f">RemoveAppender</a> (<a class="el" href="classOsclSharedPtr.html">OsclSharedPtr</a>< <a class="el" href="classPVLoggerAppender.html">PVLoggerAppender</a> > &appender)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPVLogger.html#a633004f1642e563df50dc27cb9d68f71">AddFilter</a> (<a class="el" href="classOsclSharedPtr.html">OsclSharedPtr</a>< <a class="el" href="classPVLoggerFilter.html">PVLoggerFilter</a> > &filter)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classPVLogger.html#a5e8ee20ae00a0538cc7b0e02f52d3c56">GetNumAppenders</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPVLogger.html#aef582b5ba7d56e9f70d14d812d7a960e">IsActive</a> (<a class="el" href="classPVLogger.html#aa09724be71250bc721f19885e230873d">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="classPVLogger.html#ae96f6101dcae915b5192a423f4d25914">LogMsgStringV</a> (<a class="el" href="classPVLogger.html#aa4fbeb8deb89867ae2414db65f987815">message_id_type</a> msgID, const char *fmt, va_list arguments)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPVLogger.html#a3bfc00ac5590bc465a7fbb41948bced3">LogMsgBuffersV</a> (<a class="el" href="classPVLogger.html#aa4fbeb8deb89867ae2414db65f987815">message_id_type</a> msgID, int32 numPairs, va_list arguments)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPVLogger.html#a4ca9d7b2aa229944438f48e4d38265c5">LogMsgString</a> (<a class="el" href="classPVLogger.html#aa4fbeb8deb89867ae2414db65f987815">message_id_type</a> msgID, const char *fmt,...)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPVLogger.html#ab6be0c9da82fdecf3e84fef0b201b022">LogMsgBuffers</a> (<a class="el" href="classPVLogger.html#aa4fbeb8deb89867ae2414db65f987815">message_id_type</a> msgID, int32 numPairs,...)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF </td><td class="memItemRight" valign="bottom"><a class="el" href="classPVLogger.html#a7c7b271f36f77ac4300a64e89e481629">PVLogger</a> (const char *inputTag, <a class="el" href="classPVLogger.html#aa09724be71250bc721f19885e230873d">log_level_type</a> level, bool oAppenderInheritance)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classPVLogger.html#a63577708dc4cbd54829d7b0c59d53d0f">~PVLogger</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="classPVLogger.html#a16f998fb3eab069e693bd6d5d89869be">Init</a> ()</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="classPVLogger.html#a1739f33732dbd7e7e4bb98bad763b962">Cleanup</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static OSCL_IMPORT_REF <a class="el" href="classPVLogger.html">PVLogger</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPVLogger.html#a1050cccac5bf862b8a6a2813b0f9c5ab">GetLoggerObject</a> (const char *inputTag)</td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPVLogger.html#af0b9845f3f03c067e1087fcbbf57df55">SetParent</a> (<a class="el" href="classPVLogger.html">PVLogger</a> *parentLogger)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classPVLogger.html">PVLogger</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPVLogger.html#a047e5ec82674d24e46aad143585d0cb4">GetParent</a> ()</td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classPVLogger.html#abb04741a6424789fd6090a3f46c07f32">PVLoggerRegistry</a></td></tr>
</table>
<hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="a3cd7eda43287a1f3d705e57a13bb11f2"></a><!-- doxytag: member="PVLogger::alloc_type" ref="a3cd7eda43287a1f3d705e57a13bb11f2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="class__OsclBasicAllocator.html">_OsclBasicAllocator</a> <a class="el" href="class__OsclBasicAllocator.html">PVLogger::alloc_type</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ae06d7464a1e5f505ccda6f62fb3ca313"></a><!-- doxytag: member="PVLogger::filter_status_type" ref="ae06d7464a1e5f505ccda6f62fb3ca313" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int32 <a class="el" href="classPVLogger.html#ae06d7464a1e5f505ccda6f62fb3ca313">PVLogger::filter_status_type</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aa09724be71250bc721f19885e230873d"></a><!-- doxytag: member="PVLogger::log_level_type" ref="aa09724be71250bc721f19885e230873d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int32 <a class="el" href="classPVLogger.html#aa09724be71250bc721f19885e230873d">PVLogger::log_level_type</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aa4fbeb8deb89867ae2414db65f987815"></a><!-- doxytag: member="PVLogger::message_id_type" ref="aa4fbeb8deb89867ae2414db65f987815" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int32 <a class="el" href="classPVLogger.html#aa4fbeb8deb89867ae2414db65f987815">PVLogger::message_id_type</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a7c7b271f36f77ac4300a64e89e481629"></a><!-- doxytag: member="PVLogger::PVLogger" ref="a7c7b271f36f77ac4300a64e89e481629" args="(const char *inputTag, log_level_type level, bool oAppenderInheritance)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OSCL_IMPORT_REF PVLogger::PVLogger </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>inputTag</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classPVLogger.html#aa09724be71250bc721f19885e230873d">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>Logger Constructor</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>tag</em> </td><td>Logger tag, unique to a logging control point </td></tr>
<tr><td valign="top"></td><td valign="top"><em>level</em> </td><td>Active Log level of the logger </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>NONE </dd></dl>
</div>
</div>
<a class="anchor" id="a63577708dc4cbd54829d7b0c59d53d0f"></a><!-- doxytag: member="PVLogger::~PVLogger" ref="a63577708dc4cbd54829d7b0c59d53d0f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual PVLogger::~PVLogger </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>References <a class="el" href="oscl__defalloc_8h_source.html#l00155">Oscl_TAlloc< T, Alloc >::deallocate()</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab6e46d998c52634ab566ac2380cda4a9"></a><!-- doxytag: member="PVLogger::AddAppender" ref="ab6e46d998c52634ab566ac2380cda4a9" args="(OsclSharedPtr< PVLoggerAppender > &appender)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PVLogger::AddAppender </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classOsclSharedPtr.html">OsclSharedPtr</a>< <a class="el" href="classPVLoggerAppender.html">PVLoggerAppender</a> > & </td>
<td class="paramname"> <em>appender</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method adds an appender to the logging control point. Each logger maintains a list of appenders. Any msg to a logger if deemed active is logged to all the appenders.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>appender</em> </td><td>pointer to the appender to add</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>NONE</dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>leaves</em> </td><td>if out of memory </td></tr>
</table>
</dd>
</dl>
<p>References <a class="el" href="oscl__base__macros_8h_source.html#l00085">OSCL_UNUSED_ARG</a>, and <a class="el" href="oscl__vector_8h_source.html#l00275">Oscl_Vector< T, Alloc >::push_back()</a>.</p>
</div>
</div>
<a class="anchor" id="a633004f1642e563df50dc27cb9d68f71"></a><!-- doxytag: member="PVLogger::AddFilter" ref="a633004f1642e563df50dc27cb9d68f71" args="(OsclSharedPtr< PVLoggerFilter > &filter)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PVLogger::AddFilter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classOsclSharedPtr.html">OsclSharedPtr</a>< <a class="el" href="classPVLoggerFilter.html">PVLoggerFilter</a> > & </td>
<td class="paramname"> <em>filter</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method adds a message filter to the logging control point. Each logger maintains a list of filters. Any msg to a logger if deemed active is passed through the msg filters prior to logging.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>msgFilter</em> </td><td>pointer to the filter to add</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>NONE</dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>leaves</em> </td><td>if out of memory </td></tr>
</table>
</dd>
</dl>
<p>References <a class="el" href="oscl__base__macros_8h_source.html#l00085">OSCL_UNUSED_ARG</a>, and <a class="el" href="oscl__vector_8h_source.html#l00275">Oscl_Vector< T, Alloc >::push_back()</a>.</p>
</div>
</div>
<a class="anchor" id="a1739f33732dbd7e7e4bb98bad763b962"></a><!-- doxytag: member="PVLogger::Cleanup" ref="a1739f33732dbd7e7e4bb98bad763b962" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static OSCL_IMPORT_REF void PVLogger::Cleanup </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Frees the <a class="el" href="classPVLogger.html">PVLogger</a> singleton used by the current thread. This must be called before thread exit. No messages can be logged after cleanup.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="ab7f9fab233ead23fdc0a4075456531b7"></a><!-- doxytag: member="PVLogger::DisableAppenderInheritance" ref="ab7f9fab233ead23fdc0a4075456531b7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PVLogger::DisableAppenderInheritance </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method disables appender inheritance for the logging control point </p>
</div>
</div>
<a class="anchor" id="a1050cccac5bf862b8a6a2813b0f9c5ab"></a><!-- doxytag: member="PVLogger::GetLoggerObject" ref="a1050cccac5bf862b8a6a2813b0f9c5ab" args="(const char *inputTag)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static OSCL_IMPORT_REF <a class="el" href="classPVLogger.html">PVLogger</a>* PVLogger::GetLoggerObject </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>inputTag</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This is a factory method to create a log control point, with a certain input tag. There is a central registry of all the loggers, with their corresponding tags, called PV Logger Registry. In case the logger with the specified tag exists in the global registry, it is returned, else a new one is created and a pointer to the same is returend.</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 (All messages with log levels less than equal to the log level of the control point would be logged)</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* Pointer to the logging control point</dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>leaves</em> </td><td>if out of memory </td></tr>
</table>
</dd>
</dl>
<p>Referenced by <a class="el" href="oscl__dns__method_8h_source.html#l00023">OsclDNSMethod::OsclDNSMethod()</a>.</p>
</div>
</div>
<a class="anchor" id="a28272271f4d1b9eb6045a66b4d5004f1"></a><!-- doxytag: member="PVLogger::GetLogLevel" ref="a28272271f4d1b9eb6045a66b4d5004f1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classPVLogger.html#aa09724be71250bc721f19885e230873d">log_level_type</a> PVLogger::GetLogLevel </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method returns the log level of a control point. This could either have been set explicitly by the user (at the time of creation or later) or could have been inherited from one of its ancestors.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>log level associated with the logging control point </dd></dl>
</div>
</div>
<a class="anchor" id="a5e8ee20ae00a0538cc7b0e02f52d3c56"></a><!-- doxytag: member="PVLogger::GetNumAppenders" ref="a5e8ee20ae00a0538cc7b0e02f52d3c56" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32 PVLogger::GetNumAppenders </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method returns the number of appenders attached to the logging control point. </p>
<p>References <a class="el" href="oscl__vector_8h_source.html#l00053">Oscl_Vector_Base::size()</a>.</p>
</div>
</div>
<a class="anchor" id="a047e5ec82674d24e46aad143585d0cb4"></a><!-- doxytag: member="PVLogger::GetParent" ref="a047e5ec82674d24e46aad143585d0cb4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classPVLogger.html">PVLogger</a>* PVLogger::GetParent </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a16f998fb3eab069e693bd6d5d89869be"></a><!-- doxytag: member="PVLogger::Init" ref="a16f998fb3eab069e693bd6d5d89869be" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static OSCL_IMPORT_REF void PVLogger::Init </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classPVLogger.html">PVLogger</a> needs to be initialized once per thread. This creates the <a class="el" href="classPVLogger.html">PVLogger</a> singleton that is used throughout the duration of the thread. Initialization must occur before the first message is logged.</p>
<dl><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>leaves</em> </td><td>if out of memory </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aef582b5ba7d56e9f70d14d812d7a960e"></a><!-- doxytag: member="PVLogger::IsActive" ref="aef582b5ba7d56e9f70d14d812d7a960e" args="(log_level_type level)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OSCL_IMPORT_REF bool PVLogger::IsActive </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPVLogger.html#aa09724be71250bc721f19885e230873d">log_level_type</a> </td>
<td class="paramname"> <em>level</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method determines if a msg passed to the logging control point is active or not. Only messages that are deemed active are logged. Messages are considered not active if any of the following criteria are met:</p>
<ul>
<li>All logging is disabled at this logging control point</li>
<li>If all the log levels, leading upto the root log point are uninitialized</li>
<li>If the log level of the incoming message is LESS THAN that of the active log level of the logging control point.</li>
</ul>
<dl class="return"><dt><b>Returns:</b></dt><dd>BOOL </dd></dl>
</div>
</div>
<a class="anchor" id="ab6be0c9da82fdecf3e84fef0b201b022"></a><!-- doxytag: member="PVLogger::LogMsgBuffers" ref="ab6be0c9da82fdecf3e84fef0b201b022" args="(message_id_type msgID, int32 numPairs,...)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OSCL_IMPORT_REF void PVLogger::LogMsgBuffers </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPVLogger.html#aa4fbeb8deb89867ae2414db65f987815">message_id_type</a> </td>
<td class="paramname"> <em>msgID</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32 </td>
<td class="paramname"> <em>numPairs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"> <em>...</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 logs opaque data buffers to all the appenders, after running thrrough the message filters. After logging the message to the appenders attached to the current control point, the message is passed up to the parent node, only if appender inheritance is enabled.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>msgID</em> </td><td>Message ID, that is unique to a message </td></tr>
<tr><td valign="top"></td><td valign="top"><em>numPairs</em> </td><td>Number of (ptr_len, ptr) pairs </td></tr>
<tr><td valign="top"></td><td valign="top"><em>arguments</em> </td><td>Variable list of arguments</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>NONE </dd></dl>
</div>
</div>
<a class="anchor" id="a3bfc00ac5590bc465a7fbb41948bced3"></a><!-- doxytag: member="PVLogger::LogMsgBuffersV" ref="a3bfc00ac5590bc465a7fbb41948bced3" args="(message_id_type msgID, int32 numPairs, va_list arguments)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OSCL_IMPORT_REF void PVLogger::LogMsgBuffersV </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPVLogger.html#aa4fbeb8deb89867ae2414db65f987815">message_id_type</a> </td>
<td class="paramname"> <em>msgID</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32 </td>
<td class="paramname"> <em>numPairs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">va_list </td>
<td class="paramname"> <em>arguments</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 logs opaque data buffers to all the appenders, after running thrrough the message filters. After logging the message to the appenders attached to the current control point, the message is passed up to the parent node, only if appender inheritance is enabled.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>msgID</em> </td><td>Message ID, that is unique to a message </td></tr>
<tr><td valign="top"></td><td valign="top"><em>numPairs</em> </td><td>Number of (ptr_len, ptr) pairs </td></tr>
<tr><td valign="top"></td><td valign="top"><em>arguments</em> </td><td>Variable list of arguments</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>NONE </dd></dl>
</div>
</div>
<a class="anchor" id="a4ca9d7b2aa229944438f48e4d38265c5"></a><!-- doxytag: member="PVLogger::LogMsgString" ref="a4ca9d7b2aa229944438f48e4d38265c5" args="(message_id_type msgID, const char *fmt,...)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OSCL_IMPORT_REF void PVLogger::LogMsgString </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPVLogger.html#aa4fbeb8deb89867ae2414db65f987815">message_id_type</a> </td>
<td class="paramname"> <em>msgID</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>fmt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"> <em>...</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 logs formatted text msg to all the appenders, after running thrrough the message filters. After logging the message to the appenders attached to the current control point, the message is passed up to the parent node, only if appender inheritance is enabled.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>msgID</em> </td><td>Message ID, that is unique to a message </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fmt</em> </td><td>format string, similar to one taken by printf </td></tr>
<tr><td valign="top"></td><td valign="top"><em>arguments</em> </td><td>Variable list of arguments</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>NONE </dd></dl>
</div>
</div>
<a class="anchor" id="ae96f6101dcae915b5192a423f4d25914"></a><!-- doxytag: member="PVLogger::LogMsgStringV" ref="ae96f6101dcae915b5192a423f4d25914" args="(message_id_type msgID, const char *fmt, va_list arguments)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OSCL_IMPORT_REF void PVLogger::LogMsgStringV </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPVLogger.html#aa4fbeb8deb89867ae2414db65f987815">message_id_type</a> </td>
<td class="paramname"> <em>msgID</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>fmt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">va_list </td>
<td class="paramname"> <em>arguments</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 logs formatted text msg to all the appenders, after running thrrough the message filters. After logging the message to the appenders attached to the current control point, the message is passed up to the parent node, only if appender inheritance is enabled.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>msgID</em> </td><td>Message ID, that is unique to a message </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fmt</em> </td><td>format string, similar to one taken by printf </td></tr>
<tr><td valign="top"></td><td valign="top"><em>arguments</em> </td><td>Variable list of arguments</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>NONE </dd></dl>
</div>
</div>
<a class="anchor" id="ad093d21fc9a868735dac8579cc097b2f"></a><!-- doxytag: member="PVLogger::RemoveAppender" ref="ad093d21fc9a868735dac8579cc097b2f" args="(OsclSharedPtr< PVLoggerAppender > &appender)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PVLogger::RemoveAppender </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classOsclSharedPtr.html">OsclSharedPtr</a>< <a class="el" href="classPVLoggerAppender.html">PVLoggerAppender</a> > & </td>
<td class="paramname"> <em>appender</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method removes an appender from the logging control point. Each logger maintains a list of appenders. Any msg to a logger if deemed active is logged to all the appenders.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>appender</em> </td><td>pointer to the appender to delete</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>NONE </dd></dl>
<p>References <a class="el" href="oscl__vector_8h_source.html#l00380">Oscl_Vector< T, Alloc >::begin()</a>, <a class="el" href="oscl__vector_8h_source.html#l00388">Oscl_Vector< T, Alloc >::end()</a>, <a class="el" href="oscl__vector_8h_source.html#l00399">Oscl_Vector< T, Alloc >::erase()</a>, <a class="el" href="oscl__shared__ptr_8h_source.html#l00091">OsclSharedPtr< TheClass >::GetRep()</a>, and <a class="el" href="oscl__base__macros_8h_source.html#l00085">OSCL_UNUSED_ARG</a>.</p>
</div>
</div>
<a class="anchor" id="aa88033dcb2db4ea1fbbd606a30f23d1a"></a><!-- doxytag: member="PVLogger::SetLogLevel" ref="aa88033dcb2db4ea1fbbd606a30f23d1a" args="(log_level_type level)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PVLogger::SetLogLevel </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPVLogger.html#aa09724be71250bc721f19885e230873d">log_level_type</a> </td>
<td class="paramname"> <em>level</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method is used to set the log level of a control point.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<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>
<p>References <a class="el" href="oscl__base__macros_8h_source.html#l00085">OSCL_UNUSED_ARG</a>.</p>
</div>
</div>
<a class="anchor" id="a8d7e8e026a1a2ce560804c1d9d650eb6"></a><!-- doxytag: member="PVLogger::SetLogLevelAndPropagate" ref="a8d7e8e026a1a2ce560804c1d9d650eb6" args="(log_level_type level)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OSCL_IMPORT_REF void PVLogger::SetLogLevelAndPropagate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPVLogger.html#aa09724be71250bc721f19885e230873d">log_level_type</a> </td>
<td class="paramname"> <em>level</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method is used to set the log level of a control point, as well as to propagate the level to all the descendants of this control point.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<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="af0b9845f3f03c067e1087fcbbf57df55"></a><!-- doxytag: member="PVLogger::SetParent" ref="af0b9845f3f03c067e1087fcbbf57df55" args="(PVLogger *parentLogger)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PVLogger::SetParent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPVLogger.html">PVLogger</a> * </td>
<td class="paramname"> <em>parentLogger</em></td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="abb04741a6424789fd6090a3f46c07f32"></a><!-- doxytag: member="PVLogger::PVLoggerRegistry" ref="abb04741a6424789fd6090a3f46c07f32" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classPVLoggerRegistry.html">PVLoggerRegistry</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="pvlogger_8h_source.html">pvlogger.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>
|
