<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Yate: DebugEnabler Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</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>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceTelEngine.html">TelEngine</a>::<a class="el" href="classTelEngine_1_1DebugEnabler.html">DebugEnabler</a>
</div>
</div>
<div class="contents">
<h1>DebugEnabler Class Reference</h1><!-- doxytag: class="TelEngine::DebugEnabler" -->A holder for a debug level.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="yateclass_8h-source.html">yateclass.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for DebugEnabler:</div>
<div class="dynsection">
<p><center><img src="classTelEngine_1_1DebugEnabler.png" usemap="#DebugEnabler_map" border="0" alt=""></center>
<map name="DebugEnabler_map">
<area href="classTelEngine_1_1Channel.html" alt="Channel" shape="rect" coords="140,56,270,80">
<area href="classTelEngine_1_1IAXEngine.html" alt="IAXEngine" shape="rect" coords="140,112,270,136">
<area href="classTelEngine_1_1JBEngine.html" alt="JBEngine" shape="rect" coords="140,168,270,192">
<area href="classTelEngine_1_1JBService.html" alt="JBService" shape="rect" coords="140,224,270,248">
<area href="classTelEngine_1_1MGCPEngine.html" alt="MGCPEngine" shape="rect" coords="140,280,270,304">
<area href="classTelEngine_1_1Module.html" alt="Module" shape="rect" coords="140,336,270,360">
<area href="classTelEngine_1_1SignallingComponent.html" alt="SignallingComponent" shape="rect" coords="140,392,270,416">
<area href="classTelEngine_1_1SignallingEngine.html" alt="SignallingEngine" shape="rect" coords="140,448,270,472">
<area href="classTelEngine_1_1SIPEngine.html" alt="SIPEngine" shape="rect" coords="140,504,270,528">
<area href="classTelEngine_1_1UART.html" alt="UART" shape="rect" coords="140,560,270,584">
</map>
</div>
<p>
<a href="classTelEngine_1_1DebugEnabler-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DebugEnabler.html#3f9f30882c176143e4f0859ad6bd85a8">DebugEnabler</a> (int level=TelEngine::debugLevel(), bool enabled=true)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DebugEnabler.html#aa9299c731b2139441de785117db74df">debugLevel</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DebugEnabler.html#fb4d5a4fc0d18ae8dcaba49b9c5559e1">debugLevel</a> (int level)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DebugEnabler.html#e94ed9ab1b10b205bc1f41a1c592ed5a">debugEnabled</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DebugEnabler.html#35f55e108977290c1f8e42298e1c32c3">debugEnabled</a> (bool enable)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DebugEnabler.html#a9796ed97f9ff77ba4cee77c10a8df87">debugName</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DebugEnabler.html#12b095188cc5ad9b9325be59e63bf144">debugAt</a> (int level) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DebugEnabler.html#a855d269ab630c35e1426876bfd71551">debugChained</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DebugEnabler.html#03116f3831321a668da764b21ade3b3b">debugChain</a> (const <a class="el" href="classTelEngine_1_1DebugEnabler.html">DebugEnabler</a> *chain=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DebugEnabler.html#707be41a9757fd9c037f59046b7265d4">debugCopy</a> (const <a class="el" href="classTelEngine_1_1DebugEnabler.html">DebugEnabler</a> *original=0)</td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DebugEnabler.html#22d5f9a6466d35e78ffc1e0ce82bb2f8">debugName</a> (const char *name)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A holder for a debug level.
<p>
Holds a local debugging level that can be modified separately from the global debugging <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="3f9f30882c176143e4f0859ad6bd85a8"></a><!-- doxytag: member="TelEngine::DebugEnabler::DebugEnabler" ref="3f9f30882c176143e4f0859ad6bd85a8" args="(int level=TelEngine::debugLevel(), bool enabled=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1DebugEnabler.html">DebugEnabler</a> </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>level</em> = <code>TelEngine::debugLevel()</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>enabled</em> = <code>true</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor <dl compact><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>The initial local debug level </td></tr>
<tr><td valign="top"></td><td valign="top"><em>enabled</em> </td><td>Enable debugging on this object </td></tr>
</table>
</dl>
<p>References <a class="el" href="namespaceTelEngine.html#312b12a37958f0e2bc028e63732a1690">TelEngine::debugLevel()</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="12b095188cc5ad9b9325be59e63bf144"></a><!-- doxytag: member="TelEngine::DebugEnabler::debugAt" ref="12b095188cc5ad9b9325be59e63bf144" args="(int level) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool debugAt </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>level</em> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if debugging output should be generated <dl compact><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>The debug level we are testing </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if messages should be output, false otherwise </dd></dl>
</div>
</div><p>
<a class="anchor" name="03116f3831321a668da764b21ade3b3b"></a><!-- doxytag: member="TelEngine::DebugEnabler::debugChain" ref="03116f3831321a668da764b21ade3b3b" args="(const DebugEnabler *chain=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void debugChain </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1DebugEnabler.html">DebugEnabler</a> * </td>
<td class="paramname"> <em>chain</em> = <code>0</code> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Chain this debug holder to a parent or detach from existing one <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>chain</em> </td><td>Pointer to parent debug level, NULL to detach </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="a855d269ab630c35e1426876bfd71551"></a><!-- doxytag: member="TelEngine::DebugEnabler::debugChained" ref="a855d269ab630c35e1426876bfd71551" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool debugChained </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if this enabler is chained to another one <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if local debugging is chained to other enabler </dd></dl>
</div>
</div><p>
<a class="anchor" name="707be41a9757fd9c037f59046b7265d4"></a><!-- doxytag: member="TelEngine::DebugEnabler::debugCopy" ref="707be41a9757fd9c037f59046b7265d4" args="(const DebugEnabler *original=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void debugCopy </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1DebugEnabler.html">DebugEnabler</a> * </td>
<td class="paramname"> <em>original</em> = <code>0</code> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Copy debug settings from another object or from engine globals <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>original</em> </td><td>Pointer to a <a class="el" href="classTelEngine_1_1DebugEnabler.html" title="A holder for a debug level.">DebugEnabler</a> to copy settings from </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="35f55e108977290c1f8e42298e1c32c3"></a><!-- doxytag: member="TelEngine::DebugEnabler::debugEnabled" ref="35f55e108977290c1f8e42298e1c32c3" args="(bool enable)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void debugEnabled </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>enable</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the current debug activation status <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>enable</em> </td><td>The new debug activation status, true to enable </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="e94ed9ab1b10b205bc1f41a1c592ed5a"></a><!-- doxytag: member="TelEngine::DebugEnabler::debugEnabled" ref="e94ed9ab1b10b205bc1f41a1c592ed5a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool debugEnabled </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrive the current debug activation status <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if local debugging is enabled </dd></dl>
</div>
</div><p>
<a class="anchor" name="fb4d5a4fc0d18ae8dcaba49b9c5559e1"></a><!-- doxytag: member="TelEngine::DebugEnabler::debugLevel" ref="fb4d5a4fc0d18ae8dcaba49b9c5559e1" args="(int level)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int debugLevel </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>level</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the current local debug level. <dl compact><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>The desired debug level </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The new debug level (may be different) </dd></dl>
</div>
</div><p>
<a class="anchor" name="aa9299c731b2139441de785117db74df"></a><!-- doxytag: member="TelEngine::DebugEnabler::debugLevel" ref="aa9299c731b2139441de785117db74df" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int debugLevel </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrive the current local debug level <dl class="return" compact><dt><b>Returns:</b></dt><dd>The current local debug level </dd></dl>
</div>
</div><p>
<a class="anchor" name="22d5f9a6466d35e78ffc1e0ce82bb2f8"></a><!-- doxytag: member="TelEngine::DebugEnabler::debugName" ref="22d5f9a6466d35e78ffc1e0ce82bb2f8" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void debugName </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the current debug name <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Static debug name or NULL </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="a9796ed97f9ff77ba4cee77c10a8df87"></a><!-- doxytag: member="TelEngine::DebugEnabler::debugName" ref="a9796ed97f9ff77ba4cee77c10a8df87" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* debugName </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the current debug name <dl class="return" compact><dt><b>Returns:</b></dt><dd>Name of the debug activation if set or NULL </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="yateclass_8h-source.html">yateclass.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Dec 7 21:36:11 2008 for Yate by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.7.1 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
eeacaa4eb55fa544d622989e42fc27b1
>
files
>
103
