File: TelEngine__Debugger.html

package info (click to toggle)
yate 2.2.0-1~dfsg-1.1
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 17,496 kB
  • ctags: 21,687
  • sloc: cpp: 126,248; ansic: 11,462; sh: 3,573; php: 3,229; python: 2,014; makefile: 1,504; perl: 465; awk: 8
file content (128 lines) | stat: -rw-r--r-- 6,930 bytes parent folder | download 
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
 
<HTML>
<HEAD>
<TITLE>class Debugger</TITLE>

<META NAME="Generator" CONTENT="KDOC ">
</HEAD>
<BODY bgcolor="#ffffff" text="#000000" link="#0000ff" vlink="#000099" alink= "#ffffff">
<TABLE WIDTH="100%" BORDER="0">
<TR>
<TD>
	<TABLE BORDER="0">
		<TR><TD valign="top" align="left" cellspacing="10">
		<h1>class Debugger</h1>
		</TD>
		<TD valign="top" align="right" colspan="1">An object that logs messages on creation and destruction. <small><A HREF="#longdesc">More...</A></small></TD></TR>
	</TABLE>
	<HR>
	<TABLE BORDER="0">
		<TR><TH>Full name</TH><TD><code><A HREF="TelEngine.html">TelEngine</A>::Debugger</code></TD></TR>
<TR><TH>Definition</TH><TD><code>#include &lt;<A HREF="yateclass_h.html">yateclass.h</A>&gt;</code></TD></TR>
<TR><TH><A HREF="full-list-TelEngine__Debugger.html">List of all Methods</A></TH></TR>
	</TABLE>
	</TD>
<TD align="right"><TABLE BORDER="0"><TR><TD><small><A HREF="index-long.html">Annotated List</A></small></TD></TR>
<TR><TD><small><A HREF="header-list.html">Files</A></small></TD></TR>
<TR><TD><small><A HREF="all-globals.html">Globals</A></small></TD></TR>
<TR><TD><small><A HREF="hier.html">Hierarchy</A></small></TD></TR>
<TR><TD><small><A HREF="index.html">Index</A></small></TD></TR>
</TABLE></TD></TR></TABLE>
<h4>Public Types</h4><ul><LI>enum <A HREF="#ref1">Formatting</A> {	None = 0,
	Relative,  
	Absolute,  
	Textual,   
    }
</LI>
</ul><h4>Public Methods</h4><ul><LI>&nbsp;<b><A HREF="#ref2">Debugger</A></b> (const char* name, const char* format = 0, ...) 
</LI>
<LI>&nbsp;<b><A HREF="#ref3">Debugger</A></b> (int level, const char* name, const char* format = 0, ...) 
</LI>
<LI>&nbsp;<b><A HREF="#ref4">~Debugger</A></b> () 
</LI>
</ul><h4>Public Static Methods</h4><ul><LI>static  void &nbsp;<b><A HREF="#ref5">setOutput</A></b> (void (*outFunc)(const char*,int) = 0) 
</LI>
<LI>static  void &nbsp;<b><A HREF="#ref6">setIntOut</A></b> (void (*outFunc)(const char*,int) = 0) 
</LI>
<LI>static  void &nbsp;<b><A HREF="#ref7">enableOutput</A></b> (bool enable = true, bool colorize = false) 
</LI>
<LI>static  void &nbsp;<b><A HREF="#ref8">setFormatting</A></b> (Formatting format) 
</LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
 This class is used as an automatic variable that logs messages on creation
  and destruction (when the instruction block is left or function returns).
 IMPORTANT: the name is not copied so it should best be static.
</p>
<A NAME="Formatting"></A><A NAME="ref1"></A><table width="100%"><tr bgcolor="#eeeeee"><td>enum <strong>Formatting</strong> {	None = 0,
	Relative,  
	Absolute,  
	Textual,   
    }
</td><td align="right"><h3><strong>Formatting</strong></h3></td></tr></table><p></p><p>
 Timestamp formatting
     </p>
<A NAME="Debugger"></A><A NAME="ref2"></A><table width="100%"><tr bgcolor="#eeeeee"><td>&nbsp;<strong>Debugger</strong> (const char* name, const char* format = 0, ...)
<br></td><td align="right"><h3><strong>Debugger</strong></h3></td></tr></table><p></p><p>
 The constructor prints the method entry message and indents.
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>name</i></TD><TD align="left" valign="top">Name of the function or block entered, must be static
</TD></TR>
<TR><TD align="left" valign="top"><i>format</i></TD><TD align="left" valign="top">printf() style format string
     </TD></TR>
</TABLE></P>
<A NAME="Debugger"></A><A NAME="ref3"></A><table width="100%"><tr bgcolor="#eeeeee"><td>&nbsp;<strong>Debugger</strong> (int level, const char* name, const char* format = 0, ...)
<br></td><td align="right"><h3><strong>Debugger</strong></h3></td></tr></table><p></p><p>
 The constructor prints the method entry message and indents.
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>level</i></TD><TD align="left" valign="top">The level of the message
</TD></TR>
<TR><TD align="left" valign="top"><i>name</i></TD><TD align="left" valign="top">Name of the function or block entered, must be static
</TD></TR>
<TR><TD align="left" valign="top"><i>format</i></TD><TD align="left" valign="top">printf() style format string
     </TD></TR>
</TABLE></P>
<A NAME="~Debugger"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td>&nbsp;<strong>~Debugger</strong> ()
<br></td><td align="right"><h3><strong>~Debugger</strong></h3></td></tr></table><p></p><p>
 The destructor prints the method leave message and deindents.
     </p>
<A NAME="setOutput"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void &nbsp;<strong>setOutput</strong> (void (*outFunc)(const char*,int) = 0)
<br></td><td align="right"><h3><strong>setOutput</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
 Set the output callback
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>outFunc</i></TD><TD align="left" valign="top">Pointer to the output function, NULL to use stderr
     </TD></TR>
</TABLE></P>
<A NAME="setIntOut"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void &nbsp;<strong>setIntOut</strong> (void (*outFunc)(const char*,int) = 0)
<br></td><td align="right"><h3><strong>setIntOut</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
 Set the interactive output callback
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>outFunc</i></TD><TD align="left" valign="top">Pointer to the output function, NULL to disable
     </TD></TR>
</TABLE></P>
<A NAME="enableOutput"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void &nbsp;<strong>enableOutput</strong> (bool enable = true, bool colorize = false)
<br></td><td align="right"><h3><strong>enableOutput</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
 Enable or disable the debug output
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>enable</i></TD><TD align="left" valign="top">Set to true to globally enable output
</TD></TR>
<TR><TD align="left" valign="top"><i>colorize</i></TD><TD align="left" valign="top">Enable ANSI colorization of output
     </TD></TR>
</TABLE></P>
<A NAME="setFormatting"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void &nbsp;<strong>setFormatting</strong> (Formatting format)
<br></td><td align="right"><h3><strong>setFormatting</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
 Set the format of timestamps on output messages and set the time start reference
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>format</i></TD><TD align="left" valign="top">Desired timestamp formatting
     </TD></TR>
</TABLE></P>
<HR>
	<table>
	<tr><td><small>Generated by: paulc on bussard on Mon Mar  8 12:18:15 2010, using kdoc 2.0a54.</small></td></tr>
	</table>
</BODY>
</HTML>