<!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: Module 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_1Module.html">Module</a>
</div>
</div>
<div class="contents">
<h1>Module Class Reference</h1><!-- doxytag: class="TelEngine::Module" --><!-- doxytag: inherits="TelEngine::Plugin,TelEngine::Mutex,TelEngine::MessageReceiver,TelEngine::DebugEnabler" -->A <a class="el" href="classTelEngine_1_1Plugin.html" title="Plugin support.">Plugin</a> that implements a module.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="yatephone_8h-source.html">yatephone.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for Module:</div>
<div class="dynsection">
<p><center><img src="classTelEngine_1_1Module.png" usemap="#Module_map" border="0" alt=""></center>
<map name="Module_map">
<area href="classTelEngine_1_1Plugin.html" alt="Plugin" shape="rect" coords="0,56,114,80">
<area href="classTelEngine_1_1Mutex.html" alt="Mutex" shape="rect" coords="124,56,238,80">
<area href="classTelEngine_1_1MessageReceiver.html" alt="MessageReceiver" shape="rect" coords="248,56,362,80">
<area href="classTelEngine_1_1DebugEnabler.html" alt="DebugEnabler" shape="rect" coords="372,56,486,80">
<area href="classTelEngine_1_1GenObject.html" alt="GenObject" shape="rect" coords="0,0,114,24">
<area href="classTelEngine_1_1GenObject.html" alt="GenObject" shape="rect" coords="248,0,362,24">
<area href="classTelEngine_1_1ChanAssistList.html" alt="ChanAssistList" shape="rect" coords="124,168,238,192">
<area href="classTelEngine_1_1Driver.html" alt="Driver" shape="rect" coords="248,168,362,192">
<area href="classTelEngine_1_1ClientDriver.html" alt="ClientDriver" shape="rect" coords="248,224,362,248">
</map>
</div>
<p>
<a href="classTelEngine_1_1Module-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">virtual void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Module.html#aa71c3294b1a073c3ad0b64a2ed6325a">getObject</a> (const <a class="el" href="classTelEngine_1_1String.html">String</a> &name) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Module.html#b31e7357671cfe484e3c3ed3cd6258e4">name</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Module.html#5b48c8dd7c541addfed3f5ccbf79ccae">type</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_1Module.html#5d42414aede4a6105b6956c0aca81fa0">changed</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Module.html#09e932c4fb1b3bfa7b59c68fca044811">filterInstalled</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_1Module.html#bd01611c6dfde1de99dbaf8d5ee36c78">filterDebug</a> (const <a class="el" href="classTelEngine_1_1String.html">String</a> &item) const </td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Module.html#8d6c861f8cb5f6cea62b1241b3c07478">updateDelay</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Module.html#f8db52628a006fe4959fdbe9b57a2ae1">updateDelay</a> (unsigned int delay)</td></tr>
<tr><td colspan="2"><br><h2>Protected Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom">{ <br>
<b>Status</b> = 0x00000001,
<b>Timer</b> = 0x00000002,
<b>Level</b> = 0x00000004,
<b>Command</b> = 0x00000008,
<br>
<b>Help</b> = 0x00000010,
<b>Halt</b> = 0x00000020,
<b>Route</b> = 0x00000040,
<b>Execute</b> = 0x00000100,
<br>
<b>Drop</b> = 0x00000200,
<b>Locate</b> = 0x00000400,
<b>Masquerade</b> = 0x00000800,
<b>Ringing</b> = 0x00001000,
<br>
<b>Answered</b> = 0x00002000,
<b>Tone</b> = 0x00004000,
<b>Text</b> = 0x00008000,
<b>Progress</b> = 0x00010000,
<br>
<b>Update</b> = 0x00020000,
<b>Transfer</b> = 0x00040000,
<b>Control</b> = 0x00080000,
<b>PubLast</b> = 0x0fffffff,
<br>
<b>Private</b> = 0x10000000
<br>
}</td></tr>
<tr><td colspan="2"><br><h2>Protected 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_1Module.html#ba26ca9c5de850d4600933b4bba1dece">Module</a> (const char *name, const char *type=0, bool earlyInit=false)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Module.html#33bac84c3f29d49ffdb4c536cdf1e367">~Module</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Module.html#6365dca5a7d8ddb694726a53b55a4c27">initialize</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Module.html#4fc01d736fe50cf5b977f755b675f11d">setup</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Module.html#ca4a3ab2b96c3f9d03706621f2a54d9f">installRelay</a> (int id, unsigned priority=100)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Module.html#fdb82fe452badc19a2f7a6f694a4066a">installRelay</a> (const char *name, unsigned priority=100)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Module.html#f5a27b2802e4a0f2d19317c9fbd04799">installRelay</a> (int id, const char *name, unsigned priority=100)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Module.html#4d7452109240069fc6f5bd4bb60d0756">installRelay</a> (<a class="el" href="classTelEngine_1_1MessageRelay.html">MessageRelay</a> *relay)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Module.html#80bffd17e7c5b741d43be1baf9285353">uninstallRelay</a> (<a class="el" href="classTelEngine_1_1MessageRelay.html">MessageRelay</a> *relay, bool delRelay=true)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Module.html#2c0463f0b1d135ea810af63300d4efd4">uninstallRelay</a> (int id, bool delRelay=true)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Module.html#7a591f87daee85aaf82ec238987fd2ef">uninstallRelays</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Module.html#83a6735e1655ebb8c96a3f91314ba682">received</a> (<a class="el" href="classTelEngine_1_1Message.html">Message</a> &msg, int id)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Module.html#4567b13cc84cbdd238fdb72400db779e">genUpdate</a> (<a class="el" href="classTelEngine_1_1Message.html">Message</a> &msg)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Module.html#0d13088f320767e4719998693e1ade19">msgTimer</a> (<a class="el" href="classTelEngine_1_1Message.html">Message</a> &msg)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Module.html#b0e7bac83e35ee6e8bf3e66faa094efd">msgStatus</a> (<a class="el" href="classTelEngine_1_1Message.html">Message</a> &msg)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Module.html#cfde90793ec85684f300b905cdc97005">msgRoute</a> (<a class="el" href="classTelEngine_1_1Message.html">Message</a> &msg)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Module.html#ea9ba2e8cd2178ac6388f733bc066814">msgCommand</a> (<a class="el" href="classTelEngine_1_1Message.html">Message</a> &msg)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Module.html#10d13a32476cc8029388c46bf4767522">statusModule</a> (<a class="el" href="classTelEngine_1_1String.html">String</a> &str)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Module.html#0b03ee0e462004bbe59a7bcd1b6f7f3c">statusParams</a> (<a class="el" href="classTelEngine_1_1String.html">String</a> &str)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Module.html#4c2ff980c410e87f3b9e03d1afb4e1a1">statusDetail</a> (<a class="el" href="classTelEngine_1_1String.html">String</a> &str)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Module.html#1e7cb7235b09201ef1e370319173aea6">commandExecute</a> (<a class="el" href="classTelEngine_1_1String.html">String</a> &retVal, const <a class="el" href="classTelEngine_1_1String.html">String</a> &line)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Module.html#f149b955546da7e8b8b86faaa285471f">commandComplete</a> (<a class="el" href="classTelEngine_1_1Message.html">Message</a> &msg, const <a class="el" href="classTelEngine_1_1String.html">String</a> &partLine, const <a class="el" href="classTelEngine_1_1String.html">String</a> &partWord)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Module.html#0f175a394a846c1b374dcb808c8d6660">setDebug</a> (<a class="el" href="classTelEngine_1_1Message.html">Message</a> &msg, const <a class="el" href="classTelEngine_1_1String.html">String</a> &target)</td></tr>
<tr><td colspan="2"><br><h2>Static Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Module.html#0c0d28af81d03aad371c1333dee560ea">messageName</a> (int id)</td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum TelEngine::Module:: { ... } </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Module.html#aa1d7632be019ac4f6ca135eba978ec4">RelayID</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A <a class="el" href="classTelEngine_1_1Plugin.html" title="Plugin support.">Plugin</a> that implements a module.
<p>
<a class="el" href="classTelEngine_1_1Module.html" title="A Plugin that implements a module.">Module</a> is a descendent of <a class="el" href="classTelEngine_1_1Plugin.html" title="Plugin support.">Plugin</a> specialized in implementing modules <hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="06fc87d81c62e9abb8790b6e5713c55b"></a><!-- doxytag: member="TelEngine::Module::@0" ref="06fc87d81c62e9abb8790b6e5713c55b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">anonymous enum<code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
IDs of the installed relays
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="ba26ca9c5de850d4600933b4bba1dece"></a><!-- doxytag: member="TelEngine::Module::Module" ref="ba26ca9c5de850d4600933b4bba1dece" args="(const char *name, const char *type=0, bool earlyInit=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1Module.html">Module</a> </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>type</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>earlyInit</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</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>name</em> </td><td><a class="el" href="classTelEngine_1_1Plugin.html" title="Plugin support.">Plugin</a> name of this driver </td></tr>
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>Type of the driver: "misc", "route", etc. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>earlyInit</em> </td><td>True to attempt to initialize module before others </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="33bac84c3f29d49ffdb4c536cdf1e367"></a><!-- doxytag: member="TelEngine::Module::~Module" ref="33bac84c3f29d49ffdb4c536cdf1e367" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ~<a class="el" href="classTelEngine_1_1Module.html">Module</a> </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="5d42414aede4a6105b6956c0aca81fa0"></a><!-- doxytag: member="TelEngine::Module::changed" ref="5d42414aede4a6105b6956c0aca81fa0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void changed </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Mark the driver statistics "dirty" therefore triggring a delayed status update.
</div>
</div><p>
<a class="anchor" name="f149b955546da7e8b8b86faaa285471f"></a><!-- doxytag: member="TelEngine::Module::commandComplete" ref="f149b955546da7e8b8b86faaa285471f" args="(Message &msg, const String &partLine, const String &partWord)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool commandComplete </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1Message.html">Message</a> & </td>
<td class="paramname"> <em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>partLine</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>partWord</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Complete a command line <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td><a class="el" href="classTelEngine_1_1Message.html" title="A message container class.">Message</a> to return completion into </td></tr>
<tr><td valign="top"></td><td valign="top"><em>partLine</em> </td><td>Partial line to complete, excluding the last word </td></tr>
<tr><td valign="top"></td><td valign="top"><em>partWord</em> </td><td>Partial word to complete </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True to stop processing the message, false to try other handlers </dd></dl>
<p>Reimplemented in <a class="el" href="classTelEngine_1_1Driver.html#f149b955546da7e8b8b86faaa285471f">Driver</a>.</p>
</div>
</div><p>
<a class="anchor" name="1e7cb7235b09201ef1e370319173aea6"></a><!-- doxytag: member="TelEngine::Module::commandExecute" ref="1e7cb7235b09201ef1e370319173aea6" args="(String &retVal, const String &line)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool commandExecute </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>retVal</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>line</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Execute a specific command <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>retVal</em> </td><td><a class="el" href="classTelEngine_1_1String.html" title="A C-style string handling class.">String</a> to append the textual command output to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>line</em> </td><td>Command line to attempt to execute </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True to stop processing the message, false to try other handlers </dd></dl>
</div>
</div><p>
<a class="anchor" name="bd01611c6dfde1de99dbaf8d5ee36c78"></a><!-- doxytag: member="TelEngine::Module::filterDebug" ref="bd01611c6dfde1de99dbaf8d5ee36c78" args="(const String &item) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool filterDebug </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>item</em> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check by filter rule if debugging should be active <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>item</em> </td><td>Value of the item to match </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if debugging should be activated </dd></dl>
</div>
</div><p>
<a class="anchor" name="09e932c4fb1b3bfa7b59c68fca044811"></a><!-- doxytag: member="TelEngine::Module::filterInstalled" ref="09e932c4fb1b3bfa7b59c68fca044811" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool filterInstalled </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if a debug filter is installed <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if debugging should be filtered </dd></dl>
</div>
</div><p>
<a class="anchor" name="4567b13cc84cbdd238fdb72400db779e"></a><!-- doxytag: member="TelEngine::Module::genUpdate" ref="4567b13cc84cbdd238fdb72400db779e" args="(Message &msg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void genUpdate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1Message.html">Message</a> & </td>
<td class="paramname"> <em>msg</em> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Opportunity to modify the update message <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>Status update message </td></tr>
</table>
</dl>
<p>Reimplemented in <a class="el" href="classTelEngine_1_1Driver.html#4567b13cc84cbdd238fdb72400db779e">Driver</a>.</p>
</div>
</div><p>
<a class="anchor" name="aa71c3294b1a073c3ad0b64a2ed6325a"></a><!-- doxytag: member="TelEngine::Module::getObject" ref="aa71c3294b1a073c3ad0b64a2ed6325a" args="(const String &name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void* getObject </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a pointer to a derived class given that class 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>Name of the class we are asking for </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Pointer to the requested class or NULL if this object doesn't implement it </dd></dl>
<p>Reimplemented from <a class="el" href="classTelEngine_1_1Plugin.html#aa71c3294b1a073c3ad0b64a2ed6325a">Plugin</a>.</p>
<p>Reimplemented in <a class="el" href="classTelEngine_1_1Driver.html#aa71c3294b1a073c3ad0b64a2ed6325a">Driver</a>.</p>
</div>
</div><p>
<a class="anchor" name="6365dca5a7d8ddb694726a53b55a4c27"></a><!-- doxytag: member="TelEngine::Module::initialize" ref="6365dca5a7d8ddb694726a53b55a4c27" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void initialize </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This method is called to initialize the loaded module
<p>Implements <a class="el" href="classTelEngine_1_1Plugin.html#a5085af8ee5e5c39b4c20c60231e5c92">Plugin</a>.</p>
<p>Reimplemented in <a class="el" href="classTelEngine_1_1Driver.html#6365dca5a7d8ddb694726a53b55a4c27">Driver</a>, <a class="el" href="classTelEngine_1_1ClientDriver.html#a5085af8ee5e5c39b4c20c60231e5c92">ClientDriver</a>, and <a class="el" href="classTelEngine_1_1ChanAssistList.html#6365dca5a7d8ddb694726a53b55a4c27">ChanAssistList</a>.</p>
</div>
</div><p>
<a class="anchor" name="4d7452109240069fc6f5bd4bb60d0756"></a><!-- doxytag: member="TelEngine::Module::installRelay" ref="4d7452109240069fc6f5bd4bb60d0756" args="(MessageRelay *relay)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool installRelay </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1MessageRelay.html">MessageRelay</a> * </td>
<td class="paramname"> <em>relay</em> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Install a custom message relay <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>relay</em> </td><td>Custom message relay </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if installed, false if there was already one with same ID </dd></dl>
</div>
</div><p>
<a class="anchor" name="f5a27b2802e4a0f2d19317c9fbd04799"></a><!-- doxytag: member="TelEngine::Module::installRelay" ref="f5a27b2802e4a0f2d19317c9fbd04799" args="(int id, const char *name, unsigned priority=100)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool installRelay </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>priority</em> = <code>100</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Install a custom message relay <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>RelayID of the new relay to create </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name of the custom relay to create </td></tr>
<tr><td valign="top"></td><td valign="top"><em>priority</em> </td><td>Priority of the handler, 0 = top </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if installed or already was one installed </dd></dl>
</div>
</div><p>
<a class="anchor" name="fdb82fe452badc19a2f7a6f694a4066a"></a><!-- doxytag: member="TelEngine::Module::installRelay" ref="fdb82fe452badc19a2f7a6f694a4066a" args="(const char *name, unsigned priority=100)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool installRelay </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>priority</em> = <code>100</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Install a standard message relay <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>Name of the relay to create, must match a RelayID </td></tr>
<tr><td valign="top"></td><td valign="top"><em>priority</em> </td><td>Priority of the handler, 0 = top </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if installed or already was one installed </dd></dl>
</div>
</div><p>
<a class="anchor" name="ca4a3ab2b96c3f9d03706621f2a54d9f"></a><!-- doxytag: member="TelEngine::Module::installRelay" ref="ca4a3ab2b96c3f9d03706621f2a54d9f" args="(int id, unsigned priority=100)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool installRelay </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>priority</em> = <code>100</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Install a standard message relay <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>RelayID of the new relay to create </td></tr>
<tr><td valign="top"></td><td valign="top"><em>priority</em> </td><td>Priority of the handler, 0 = top </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if installed or already was one installed </dd></dl>
</div>
</div><p>
<a class="anchor" name="0c0d28af81d03aad371c1333dee560ea"></a><!-- doxytag: member="TelEngine::Module::messageName" ref="0c0d28af81d03aad371c1333dee560ea" args="(int id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const char* messageName </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em> </td>
<td> ) </td>
<td><code> [static, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Find the name of a specific Relay ID <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>RelayID of the message </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Pointer to name of the message or NULL if not found </dd></dl>
</div>
</div><p>
<a class="anchor" name="ea9ba2e8cd2178ac6388f733bc066814"></a><!-- doxytag: member="TelEngine::Module::msgCommand" ref="ea9ba2e8cd2178ac6388f733bc066814" args="(Message &msg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool msgCommand </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1Message.html">Message</a> & </td>
<td class="paramname"> <em>msg</em> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Handler for special commands and line completion requests. By default it calls <a class="el" href="classTelEngine_1_1Module.html#1e7cb7235b09201ef1e370319173aea6">commandExecute()</a> or <a class="el" href="classTelEngine_1_1Module.html#f149b955546da7e8b8b86faaa285471f">commandComplete()</a>. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>Command message </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True to stop processing the message, false to try other handlers </dd></dl>
</div>
</div><p>
<a class="anchor" name="cfde90793ec85684f300b905cdc97005"></a><!-- doxytag: member="TelEngine::Module::msgRoute" ref="cfde90793ec85684f300b905cdc97005" args="(Message &msg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool msgRoute </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1Message.html">Message</a> & </td>
<td class="paramname"> <em>msg</em> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Routing message handler that is invoked for all call.route messages. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>Call routing message </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True to stop processing the message, false to try other handlers </dd></dl>
<p>Reimplemented in <a class="el" href="classTelEngine_1_1Driver.html#cfde90793ec85684f300b905cdc97005">Driver</a>, and <a class="el" href="classTelEngine_1_1ClientDriver.html#cfde90793ec85684f300b905cdc97005">ClientDriver</a>.</p>
</div>
</div><p>
<a class="anchor" name="b0e7bac83e35ee6e8bf3e66faa094efd"></a><!-- doxytag: member="TelEngine::Module::msgStatus" ref="b0e7bac83e35ee6e8bf3e66faa094efd" args="(Message &msg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void msgStatus </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1Message.html">Message</a> & </td>
<td class="paramname"> <em>msg</em> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Status message handler that is invoked only for matching messages. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>Status message </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="0d13088f320767e4719998693e1ade19"></a><!-- doxytag: member="TelEngine::Module::msgTimer" ref="0d13088f320767e4719998693e1ade19" args="(Message &msg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void msgTimer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1Message.html">Message</a> & </td>
<td class="paramname"> <em>msg</em> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Timer message handler. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td><a class="el" href="classTelEngine_1_1Time.html" title="A time holding class.">Time</a> message </td></tr>
</table>
</dl>
<p>Reimplemented in <a class="el" href="classTelEngine_1_1ClientDriver.html#0d13088f320767e4719998693e1ade19">ClientDriver</a>.</p>
</div>
</div><p>
<a class="anchor" name="b31e7357671cfe484e3c3ed3cd6258e4"></a><!-- doxytag: member="TelEngine::Module::name" ref="b31e7357671cfe484e3c3ed3cd6258e4" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classTelEngine_1_1String.html">String</a>& name </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrive the name of the module <dl class="return" compact><dt><b>Returns:</b></dt><dd>The module's name as <a class="el" href="classTelEngine_1_1String.html" title="A C-style string handling class.">String</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="83a6735e1655ebb8c96a3f91314ba682"></a><!-- doxytag: member="TelEngine::Module::received" ref="83a6735e1655ebb8c96a3f91314ba682" args="(Message &msg, int id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool received </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1Message.html">Message</a> & </td>
<td class="paramname"> <em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<a class="el" href="classTelEngine_1_1Message.html" title="A message container class.">Message</a> receiver handler <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>The received message </td></tr>
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>The identifier with which the relay was created </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True to stop processing, false to try other handlers </dd></dl>
<p>Implements <a class="el" href="classTelEngine_1_1MessageReceiver.html#e913436a4047edb97a9aca429234a393">MessageReceiver</a>.</p>
<p>Reimplemented in <a class="el" href="classTelEngine_1_1Driver.html#83a6735e1655ebb8c96a3f91314ba682">Driver</a>, <a class="el" href="classTelEngine_1_1ClientDriver.html#83a6735e1655ebb8c96a3f91314ba682">ClientDriver</a>, and <a class="el" href="classTelEngine_1_1ChanAssistList.html#83a6735e1655ebb8c96a3f91314ba682">ChanAssistList</a>.</p>
</div>
</div><p>
<a class="anchor" name="0f175a394a846c1b374dcb808c8d6660"></a><!-- doxytag: member="TelEngine::Module::setDebug" ref="0f175a394a846c1b374dcb808c8d6660" args="(Message &msg, const String &target)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool setDebug </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1Message.html">Message</a> & </td>
<td class="paramname"> <em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>target</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the local debugging 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>msg</em> </td><td>Debug setting message </td></tr>
<tr><td valign="top"></td><td valign="top"><em>target</em> </td><td><a class="el" href="classTelEngine_1_1String.html" title="A C-style string handling class.">String</a> to match for local settings </td></tr>
</table>
</dl>
<p>Reimplemented in <a class="el" href="classTelEngine_1_1Driver.html#0f175a394a846c1b374dcb808c8d6660">Driver</a>.</p>
</div>
</div><p>
<a class="anchor" name="4fc01d736fe50cf5b977f755b675f11d"></a><!-- doxytag: member="TelEngine::Module::setup" ref="4fc01d736fe50cf5b977f755b675f11d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setup </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Install standard message relays
<p>Reimplemented in <a class="el" href="classTelEngine_1_1ClientDriver.html#4fc01d736fe50cf5b977f755b675f11d">ClientDriver</a>.</p>
</div>
</div><p>
<a class="anchor" name="4c2ff980c410e87f3b9e03d1afb4e1a1"></a><!-- doxytag: member="TelEngine::Module::statusDetail" ref="4c2ff980c410e87f3b9e03d1afb4e1a1" args="(String &str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void statusDetail </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>str</em> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Build the details reporting part of the status answer <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>str</em> </td><td><a class="el" href="classTelEngine_1_1String.html" title="A C-style string handling class.">String</a> variable to fill up </td></tr>
</table>
</dl>
<p>Reimplemented in <a class="el" href="classTelEngine_1_1Driver.html#4c2ff980c410e87f3b9e03d1afb4e1a1">Driver</a>.</p>
</div>
</div><p>
<a class="anchor" name="10d13a32476cc8029388c46bf4767522"></a><!-- doxytag: member="TelEngine::Module::statusModule" ref="10d13a32476cc8029388c46bf4767522" args="(String &str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void statusModule </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>str</em> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Build the module identification part of the status answer <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>str</em> </td><td><a class="el" href="classTelEngine_1_1String.html" title="A C-style string handling class.">String</a> variable to fill up </td></tr>
</table>
</dl>
<p>Reimplemented in <a class="el" href="classTelEngine_1_1Driver.html#10d13a32476cc8029388c46bf4767522">Driver</a>.</p>
</div>
</div><p>
<a class="anchor" name="0b03ee0e462004bbe59a7bcd1b6f7f3c"></a><!-- doxytag: member="TelEngine::Module::statusParams" ref="0b03ee0e462004bbe59a7bcd1b6f7f3c" args="(String &str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void statusParams </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>str</em> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Build the parameter reporting part of the status answer <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>str</em> </td><td><a class="el" href="classTelEngine_1_1String.html" title="A C-style string handling class.">String</a> variable to fill up </td></tr>
</table>
</dl>
<p>Reimplemented in <a class="el" href="classTelEngine_1_1Driver.html#0b03ee0e462004bbe59a7bcd1b6f7f3c">Driver</a>.</p>
</div>
</div><p>
<a class="anchor" name="5b48c8dd7c541addfed3f5ccbf79ccae"></a><!-- doxytag: member="TelEngine::Module::type" ref="5b48c8dd7c541addfed3f5ccbf79ccae" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classTelEngine_1_1String.html">String</a>& type </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrive the type of the module <dl class="return" compact><dt><b>Returns:</b></dt><dd>The module's type as <a class="el" href="classTelEngine_1_1String.html" title="A C-style string handling class.">String</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="2c0463f0b1d135ea810af63300d4efd4"></a><!-- doxytag: member="TelEngine::Module::uninstallRelay" ref="2c0463f0b1d135ea810af63300d4efd4" args="(int id, bool delRelay=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool uninstallRelay </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>delRelay</em> = <code>true</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Uninstall a message relay <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>RelayID to uninstall, relay will be deleted </td></tr>
<tr><td valign="top"></td><td valign="top"><em>delRelay</em> </td><td>True to delete the relay after removing it </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if uninstalled, false if if was not present </dd></dl>
</div>
</div><p>
<a class="anchor" name="80bffd17e7c5b741d43be1baf9285353"></a><!-- doxytag: member="TelEngine::Module::uninstallRelay" ref="80bffd17e7c5b741d43be1baf9285353" args="(MessageRelay *relay, bool delRelay=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool uninstallRelay </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1MessageRelay.html">MessageRelay</a> * </td>
<td class="paramname"> <em>relay</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>delRelay</em> = <code>true</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Uninstall a message relay <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>relay</em> </td><td>Pointer to message relay </td></tr>
<tr><td valign="top"></td><td valign="top"><em>delRelay</em> </td><td>True to delete the relay after removing it </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if uninstalled, false if if was not present </dd></dl>
</div>
</div><p>
<a class="anchor" name="7a591f87daee85aaf82ec238987fd2ef"></a><!-- doxytag: member="TelEngine::Module::uninstallRelays" ref="7a591f87daee85aaf82ec238987fd2ef" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool uninstallRelays </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Uninstall all installed relays in preparation for unloading <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if all relays were uninstalled, false if something wrong </dd></dl>
</div>
</div><p>
<a class="anchor" name="f8db52628a006fe4959fdbe9b57a2ae1"></a><!-- doxytag: member="TelEngine::Module::updateDelay" ref="f8db52628a006fe4959fdbe9b57a2ae1" args="(unsigned int delay)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void updateDelay </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>delay</em> </td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the global update notification delay <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>delay</em> </td><td>New update delay value in seconds, 0 to disable </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="8d6c861f8cb5f6cea62b1241b3c07478"></a><!-- doxytag: member="TelEngine::Module::updateDelay" ref="8d6c861f8cb5f6cea62b1241b3c07478" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static unsigned int updateDelay </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrive the global update notification delay <dl class="return" compact><dt><b>Returns:</b></dt><dd>Update delay value in seconds </dd></dl>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="aa1d7632be019ac4f6ca135eba978ec4"></a><!-- doxytag: member="TelEngine::Module::RelayID" ref="aa1d7632be019ac4f6ca135eba978ec4" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum { ... } <a class="el" href="classTelEngine_1_1Module.html#aa1d7632be019ac4f6ca135eba978ec4">RelayID</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
IDs of the installed relays
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="yatephone_8h-source.html">yatephone.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Dec 7 21:36:12 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
>
363
