<!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: Engine 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_1Engine.html">Engine</a>
</div>
</div>
<div class="contents">
<h1>Engine Class Reference</h1><!-- doxytag: class="TelEngine::Engine" --><a class="el" href="classTelEngine_1_1Engine.html" title="Engine globals.">Engine</a> globals.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="yatengine_8h-source.html">yatengine.h</a>></code>
<p>
<p>
<a href="classTelEngine_1_1Engine-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 Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Engine.html#3dfe11cf1a3a8121f6cd7fec4bf5947e">RunMode</a> { <b>Stopped</b> = 0,
<b>Console</b> = 1,
<b>Client</b> = 2,
<b>Server</b> = 3
}</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Engine.html#7e0f7aeb7f80a3b65b90416a9719b7a6">PluginMode</a> { <b>LoadFail</b> = 0,
<b>LoadLate</b>,
<b>LoadEarly</b>
}</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Engine.html#58e8be2db2660128e4e6456a9c981fb5">run</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_1Engine.html#26b1251594cbd70dc5774518ec7b42ba">setHook</a> (<a class="el" href="classTelEngine_1_1MessagePostHook.html">MessagePostHook</a> *hook, bool remove=false)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Engine.html#3f905eb59144371fb27eac5bf55b2a27">usedPlugins</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Engine.html#da7d3d221ee0d87bb9f927f58fc61985">messageCount</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Engine.html#4da8395b9ce6b8554d26dc8905e2e69b">handlerCount</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_1Engine.html#22758889c313179083fce4cb2bdebb32">loadPluginDir</a> (const <a class="el" href="classTelEngine_1_1String.html">String</a> &relPath)</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 int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Engine.html#6e194837c89729eee2eead3efd5bd0ad">main</a> (int argc, const char **argv, const char **env, <a class="el" href="classTelEngine_1_1Engine.html#3dfe11cf1a3a8121f6cd7fec4bf5947e">RunMode</a> mode=Console, bool fail=false)</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_1Engine.html#45abadc53239f7792469b175fa0d952d">help</a> (bool client, bool errout=false)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classTelEngine_1_1Engine.html">Engine</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Engine.html#ede4de7922dea3d7e18b72102ff428c3">self</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classTelEngine_1_1Engine.html#3dfe11cf1a3a8121f6cd7fec4bf5947e">RunMode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Engine.html#1c88d866bcaf4dfc831cb949c147ffd9">mode</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Engine.html#166179bca82218afba68ae767d318924">clientMode</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Engine.html#f28b7e4a15cf438ec7d400bddec45cde">Register</a> (const <a class="el" href="classTelEngine_1_1Plugin.html">Plugin</a> *plugin, bool reg=true)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Engine.html#8a19daacb85cd820012150f4e0215ce6">nodeName</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Engine.html#b0dee886f4c10ebff6904c5851e9fd43">sharedPath</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classTelEngine_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Engine.html#e28cbc7227ac80f84f7d34474c7ae3ff">configFile</a> (const char *name, bool user=false)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Engine.html#e9f8c43197bd92c6490e1b45e24228c6">configPath</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Engine.html#ce3d8ed5872149a0a3e5c5eb54f35b51">configSuffix</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Engine.html#62579eb1a4ef436c184ed7eaf5347ed8">modulePath</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_1Engine.html#814d409d7e53e6454a4bc75b92004b2a">extraPath</a> (const <a class="el" href="classTelEngine_1_1String.html">String</a> &path)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Engine.html#f76d26ac6cb542db24e1f2f9a7e3e7bf">moduleSuffix</a> ()</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_1Engine.html#df9ffcca22ad45d18d1b060d69fe802d">pathSeparator</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="classTelEngine_1_1Configuration.html">Configuration</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Engine.html#321c416eef33774e038017766fa6b61a">config</a> ()</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_1Engine.html#f504fdfba4ac792ebdda72acc5f36d15">runId</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="classTelEngine_1_1NamedList.html">NamedList</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Engine.html#8cf10a511683dcdf192e6b53a25515aa">runParams</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_1Engine.html#edc913c139bb562646d3459b0ca28997">init</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_1Engine.html#2180b66df0a079dadd30eea3addca3c5">halt</a> (unsigned int code)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Engine.html#78adc91868a739f2d76470e1883752bb">restart</a> (unsigned int code, bool gracefull=false)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Engine.html#f0c7e111b9b125a276685abd649d9577">exiting</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Engine.html#7d90514f871e0ab1eaeacb4c553fa128">install</a> (<a class="el" href="classTelEngine_1_1MessageHandler.html">MessageHandler</a> *handler)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Engine.html#56ca768f5ee505bfab9c404a55c8d95e">uninstall</a> (<a class="el" href="classTelEngine_1_1MessageHandler.html">MessageHandler</a> *handler)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Engine.html#a352d5d89f1c37356bfccf4c655e6ae5">enqueue</a> (<a class="el" href="classTelEngine_1_1Message.html">Message</a> *msg)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Engine.html#c6a841edf269105e16094e91272684fa">enqueue</a> (const char *name)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Engine.html#b9e29b97044d8a85c9d22628f11fad3d">dispatch</a> (<a class="el" href="classTelEngine_1_1Message.html">Message</a> *msg)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Engine.html#9af2814bcfae8a949e8574e45b5fc349">dispatch</a> (<a class="el" href="classTelEngine_1_1Message.html">Message</a> &msg)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Engine.html#dac046ce6a585b4876862c108b139d5a">dispatch</a> (const char *name)</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_1Engine.html#7c526099f291b701753f0ebb84c5c076">pluginMode</a> (<a class="el" href="classTelEngine_1_1Engine.html#7e0f7aeb7f80a3b65b90416a9719b7a6">PluginMode</a> mode)</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_1Engine.html#45936cce93ebf1bfdfd7ba305e03e864">~Engine</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_1Engine.html#3b15a51cf3f3fcd4c4acf854c027afd4">loadPlugin</a> (const char *file, bool local=false)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Engine.html#af7576d4ca8745a033953daa6ac19a0b">loadPlugins</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_1Engine.html#e79bf71d50b17bcab7aeb0a57c1c1e05">initPlugins</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9be7b2774e96cf1768c664f886c8a03c"></a><!-- doxytag: member="TelEngine::Engine::EnginePrivate" ref="9be7b2774e96cf1768c664f886c8a03c" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>EnginePrivate</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2d8224e9063cb0f7fb15d34784d2a176"></a><!-- doxytag: member="TelEngine::Engine::EngineCommand" ref="2d8224e9063cb0f7fb15d34784d2a176" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>EngineCommand</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classTelEngine_1_1Engine.html" title="Engine globals.">Engine</a> globals.
<p>
This class holds global information about the engine. Note: this is a singleton class. <hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="7e0f7aeb7f80a3b65b90416a9719b7a6"></a><!-- doxytag: member="TelEngine::Engine::PluginMode" ref="7e0f7aeb7f80a3b65b90416a9719b7a6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classTelEngine_1_1Engine.html#7e0f7aeb7f80a3b65b90416a9719b7a6">PluginMode</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<a class="el" href="classTelEngine_1_1Plugin.html" title="Plugin support.">Plugin</a> load and initialization modes. Default is LoadLate that initailizes the plugin after others. LoadEarly will move the plugin to the front of the init order. LoadFail causes the plugin to be unloaded.
</div>
</div><p>
<a class="anchor" name="3dfe11cf1a3a8121f6cd7fec4bf5947e"></a><!-- doxytag: member="TelEngine::Engine::RunMode" ref="3dfe11cf1a3a8121f6cd7fec4bf5947e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classTelEngine_1_1Engine.html#3dfe11cf1a3a8121f6cd7fec4bf5947e">RunMode</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Running modes - run the engine as Console, <a class="el" href="classTelEngine_1_1Client.html" title="Thread that runs the User Interface.">Client</a> or Server.
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="45936cce93ebf1bfdfd7ba305e03e864"></a><!-- doxytag: member="TelEngine::Engine::~Engine" ref="45936cce93ebf1bfdfd7ba305e03e864" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">~<a class="el" href="classTelEngine_1_1Engine.html">Engine</a> </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destroys the engine and everything. You must not call it directly, <a class="el" href="classTelEngine_1_1Engine.html#58e8be2db2660128e4e6456a9c981fb5">run()</a> will do it for you.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="166179bca82218afba68ae767d318924"></a><!-- doxytag: member="TelEngine::Engine::clientMode" ref="166179bca82218afba68ae767d318924" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool clientMode </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if the engine is running as telephony client <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the engine is running in client mode </dd></dl>
</div>
</div><p>
<a class="anchor" name="321c416eef33774e038017766fa6b61a"></a><!-- doxytag: member="TelEngine::Engine::config" ref="321c416eef33774e038017766fa6b61a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classTelEngine_1_1Configuration.html">Configuration</a>& config </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The global configuration of the engine. You must use this resource with caution. Note that sections [general], [modules], [preload] and [postload] are reserved by the engine. Also [telephony] is reserved by the drivers. <dl class="return" compact><dt><b>Returns:</b></dt><dd>A reference to the read-only engine configuration </dd></dl>
</div>
</div><p>
<a class="anchor" name="e28cbc7227ac80f84f7d34474c7ae3ff"></a><!-- doxytag: member="TelEngine::Engine::configFile" ref="e28cbc7227ac80f84f7d34474c7ae3ff" args="(const char *name, bool user=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classTelEngine_1_1String.html">String</a> configFile </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">bool </td>
<td class="paramname"> <em>user</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the filename for a specific configuration <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 configuration requested </td></tr>
<tr><td valign="top"></td><td valign="top"><em>user</em> </td><td>True to build a user settings path </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A full path configuration file name </dd></dl>
</div>
</div><p>
<a class="anchor" name="e9f8c43197bd92c6490e1b45e24228c6"></a><!-- doxytag: member="TelEngine::Engine::configPath" ref="e9f8c43197bd92c6490e1b45e24228c6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classTelEngine_1_1String.html">String</a>& configPath </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the system configuration directory path <dl class="return" compact><dt><b>Returns:</b></dt><dd>The directory path for system configuration files </dd></dl>
</div>
</div><p>
<a class="anchor" name="ce3d8ed5872149a0a3e5c5eb54f35b51"></a><!-- doxytag: member="TelEngine::Engine::configSuffix" ref="ce3d8ed5872149a0a3e5c5eb54f35b51" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classTelEngine_1_1String.html">String</a>& configSuffix </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the configuration file suffix <dl class="return" compact><dt><b>Returns:</b></dt><dd>The suffix for configuration files </dd></dl>
</div>
</div><p>
<a class="anchor" name="dac046ce6a585b4876862c108b139d5a"></a><!-- doxytag: member="TelEngine::Engine::dispatch" ref="dac046ce6a585b4876862c108b139d5a" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool dispatch </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Convenience function. Dispatch a parameterless message to the registered handlers <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>The name of the message to create and dispatch </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if one handler accepted it, false if all ignored </dd></dl>
</div>
</div><p>
<a class="anchor" name="9af2814bcfae8a949e8574e45b5fc349"></a><!-- doxytag: member="TelEngine::Engine::dispatch" ref="9af2814bcfae8a949e8574e45b5fc349" args="(Message &msg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool dispatch </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> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Synchronously dispatch a message to the registered handlers <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 message to dispatch </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if one handler accepted it, false if all ignored </dd></dl>
</div>
</div><p>
<a class="anchor" name="b9e29b97044d8a85c9d22628f11fad3d"></a><!-- doxytag: member="TelEngine::Engine::dispatch" ref="b9e29b97044d8a85c9d22628f11fad3d" args="(Message *msg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool dispatch </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> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Synchronously dispatch a message to the registered handlers <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>Pointer to the message to dispatch </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if one handler accepted it, false if all ignored </dd></dl>
</div>
</div><p>
<a class="anchor" name="c6a841edf269105e16094e91272684fa"></a><!-- doxytag: member="TelEngine::Engine::enqueue" ref="c6a841edf269105e16094e91272684fa" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool enqueue </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Convenience function. Enqueue a new parameterless message in the message queue <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 parameterless message to put in queue </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if enqueued, false on error (already queued) </dd></dl>
<p>References <a class="el" href="yatengine_8h-source.html#l00937">Engine::enqueue()</a>.</p>
<p>Referenced by <a class="el" href="yatengine_8h-source.html#l00937">Engine::enqueue()</a>.</p>
</div>
</div><p>
<a class="anchor" name="a352d5d89f1c37356bfccf4c655e6ae5"></a><!-- doxytag: member="TelEngine::Engine::enqueue" ref="a352d5d89f1c37356bfccf4c655e6ae5" args="(Message *msg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool enqueue </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> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Enqueue a message in the message queue for asynchronous dispatching <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 message to enqueue, will be destroyed after dispatching </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if enqueued, false on error (already queued) </dd></dl>
</div>
</div><p>
<a class="anchor" name="f0c7e111b9b125a276685abd649d9577"></a><!-- doxytag: member="TelEngine::Engine::exiting" ref="f0c7e111b9b125a276685abd649d9577" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool exiting </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if the engine is currently exiting <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if exiting, false in normal operation </dd></dl>
</div>
</div><p>
<a class="anchor" name="814d409d7e53e6454a4bc75b92004b2a"></a><!-- doxytag: member="TelEngine::Engine::extraPath" ref="814d409d7e53e6454a4bc75b92004b2a" args="(const String &path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void extraPath </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>path</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add a relative extra module loading path. The list is empty by default but can be filled by a main program before calling <a class="el" href="classTelEngine_1_1Engine.html#6e194837c89729eee2eead3efd5bd0ad">main()</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>path</em> </td><td>Relative path to extra modules to be loaded </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="2180b66df0a079dadd30eea3addca3c5"></a><!-- doxytag: member="TelEngine::Engine::halt" ref="2180b66df0a079dadd30eea3addca3c5" args="(unsigned int code)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void halt </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>code</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Stop the engine and the entire program <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>code</em> </td><td>Return code of the program </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="4da8395b9ce6b8554d26dc8905e2e69b"></a><!-- doxytag: member="TelEngine::Engine::handlerCount" ref="4da8395b9ce6b8554d26dc8905e2e69b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int handlerCount </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the number of handlers in the dispatcher <dl class="return" compact><dt><b>Returns:</b></dt><dd>Count of handlers </dd></dl>
</div>
</div><p>
<a class="anchor" name="45abadc53239f7792469b175fa0d952d"></a><!-- doxytag: member="TelEngine::Engine::help" ref="45abadc53239f7792469b175fa0d952d" args="(bool client, bool errout=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void help </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>client</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>errout</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Display the help information on console <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>client</em> </td><td>Display help for client running mode </td></tr>
<tr><td valign="top"></td><td valign="top"><em>errout</em> </td><td>Display on stderr intead of stdout </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="edc913c139bb562646d3459b0ca28997"></a><!-- doxytag: member="TelEngine::Engine::init" ref="edc913c139bb562646d3459b0ca28997" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void init </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reinitialize the plugins
</div>
</div><p>
<a class="anchor" name="e79bf71d50b17bcab7aeb0a57c1c1e05"></a><!-- doxytag: member="TelEngine::Engine::initPlugins" ref="e79bf71d50b17bcab7aeb0a57c1c1e05" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void initPlugins </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Initialize all registered plugins
</div>
</div><p>
<a class="anchor" name="7d90514f871e0ab1eaeacb4c553fa128"></a><!-- doxytag: member="TelEngine::Engine::install" ref="7d90514f871e0ab1eaeacb4c553fa128" args="(MessageHandler *handler)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool install </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1MessageHandler.html">MessageHandler</a> * </td>
<td class="paramname"> <em>handler</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Installs a handler in the dispatcher. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>handler</em> </td><td>A pointer to the handler to install </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True on success, false on failure </dd></dl>
</div>
</div><p>
<a class="anchor" name="3b15a51cf3f3fcd4c4acf854c027afd4"></a><!-- doxytag: member="TelEngine::Engine::loadPlugin" ref="3b15a51cf3f3fcd4c4acf854c027afd4" args="(const char *file, bool local=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool loadPlugin </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>local</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>
Loads one plugin from a shared object file <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>file</em> </td><td>Name of the plugin file to load </td></tr>
<tr><td valign="top"></td><td valign="top"><em>local</em> </td><td>Attempt to keep symbols local if supported by the system </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if success, false on failure </dd></dl>
</div>
</div><p>
<a class="anchor" name="22758889c313179083fce4cb2bdebb32"></a><!-- doxytag: member="TelEngine::Engine::loadPluginDir" ref="22758889c313179083fce4cb2bdebb32" args="(const String &relPath)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool loadPluginDir </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>relPath</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Loads the plugins from an extra plugins directory <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>relPath</em> </td><td>Path to the extra directory, relative to the main modules </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the directory could at least be opened </dd></dl>
</div>
</div><p>
<a class="anchor" name="af7576d4ca8745a033953daa6ac19a0b"></a><!-- doxytag: member="TelEngine::Engine::loadPlugins" ref="af7576d4ca8745a033953daa6ac19a0b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void loadPlugins </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Loads the plugins from the plugins directory
</div>
</div><p>
<a class="anchor" name="6e194837c89729eee2eead3efd5bd0ad"></a><!-- doxytag: member="TelEngine::Engine::main" ref="6e194837c89729eee2eead3efd5bd0ad" args="(int argc, const char **argv, const char **env, RunMode mode=Console, bool fail=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static int main </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>argc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char ** </td>
<td class="paramname"> <em>argv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char ** </td>
<td class="paramname"> <em>env</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1Engine.html#3dfe11cf1a3a8121f6cd7fec4bf5947e">RunMode</a> </td>
<td class="paramname"> <em>mode</em> = <code>Console</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>fail</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Main entry point to be called directly from a wrapper program <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>argc</em> </td><td>Argument count </td></tr>
<tr><td valign="top"></td><td valign="top"><em>argv</em> </td><td>Argument array </td></tr>
<tr><td valign="top"></td><td valign="top"><em>env</em> </td><td>Environment variables </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>Mode the engine must run as - Console, <a class="el" href="classTelEngine_1_1Client.html" title="Thread that runs the User Interface.">Client</a> or Server </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fail</em> </td><td>Fail and return after parsing command line arguments </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Program exit code </dd></dl>
</div>
</div><p>
<a class="anchor" name="da7d3d221ee0d87bb9f927f58fc61985"></a><!-- doxytag: member="TelEngine::Engine::messageCount" ref="da7d3d221ee0d87bb9f927f58fc61985" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int messageCount </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the number of messages waiting in the queue <dl class="return" compact><dt><b>Returns:</b></dt><dd>Count of messages in the queue </dd></dl>
</div>
</div><p>
<a class="anchor" name="1c88d866bcaf4dfc831cb949c147ffd9"></a><!-- doxytag: member="TelEngine::Engine::mode" ref="1c88d866bcaf4dfc831cb949c147ffd9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classTelEngine_1_1Engine.html#3dfe11cf1a3a8121f6cd7fec4bf5947e">RunMode</a> mode </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the running mode of the engine <dl class="return" compact><dt><b>Returns:</b></dt><dd>Engine's run mode as enumerated value </dd></dl>
</div>
</div><p>
<a class="anchor" name="62579eb1a4ef436c184ed7eaf5347ed8"></a><!-- doxytag: member="TelEngine::Engine::modulePath" ref="62579eb1a4ef436c184ed7eaf5347ed8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classTelEngine_1_1String.html">String</a>& modulePath </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The module loading path
</div>
</div><p>
<a class="anchor" name="f76d26ac6cb542db24e1f2f9a7e3e7bf"></a><!-- doxytag: member="TelEngine::Engine::moduleSuffix" ref="f76d26ac6cb542db24e1f2f9a7e3e7bf" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classTelEngine_1_1String.html">String</a>& moduleSuffix </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the module filename suffix <dl class="return" compact><dt><b>Returns:</b></dt><dd>The suffix for module files </dd></dl>
</div>
</div><p>
<a class="anchor" name="8a19daacb85cd820012150f4e0215ce6"></a><!-- doxytag: member="TelEngine::Engine::nodeName" ref="8a19daacb85cd820012150f4e0215ce6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classTelEngine_1_1String.html">String</a>& nodeName </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the server node name, should be unique in a cluster <dl class="return" compact><dt><b>Returns:</b></dt><dd>Node identifier string, defaults to host name </dd></dl>
</div>
</div><p>
<a class="anchor" name="df9ffcca22ad45d18d1b060d69fe802d"></a><!-- doxytag: member="TelEngine::Engine::pathSeparator" ref="df9ffcca22ad45d18d1b060d69fe802d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const char* pathSeparator </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the canonical path element separator for the operating system <dl class="return" compact><dt><b>Returns:</b></dt><dd>The operating system specific path element separator </dd></dl>
</div>
</div><p>
<a class="anchor" name="7c526099f291b701753f0ebb84c5c076"></a><!-- doxytag: member="TelEngine::Engine::pluginMode" ref="7c526099f291b701753f0ebb84c5c076" args="(PluginMode mode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void pluginMode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1Engine.html#7e0f7aeb7f80a3b65b90416a9719b7a6">PluginMode</a> </td>
<td class="paramname"> <em>mode</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the load and init mode of the currently loading <a class="el" href="classTelEngine_1_1Plugin.html">Plugin</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>mode</em> </td><td>Load and init mode, default LoadLate </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="f28b7e4a15cf438ec7d400bddec45cde"></a><!-- doxytag: member="TelEngine::Engine::Register" ref="f28b7e4a15cf438ec7d400bddec45cde" args="(const Plugin *plugin, bool reg=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool Register </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1Plugin.html">Plugin</a> * </td>
<td class="paramname"> <em>plugin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>reg</em> = <code>true</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Register or unregister a plugin to the engine. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>plugin</em> </td><td>A pointer to the plugin to (un)register </td></tr>
<tr><td valign="top"></td><td valign="top"><em>reg</em> </td><td>True to register (default), false to unregister </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True on success, false on failure </dd></dl>
</div>
</div><p>
<a class="anchor" name="78adc91868a739f2d76470e1883752bb"></a><!-- doxytag: member="TelEngine::Engine::restart" ref="78adc91868a739f2d76470e1883752bb" args="(unsigned int code, bool gracefull=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool restart </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>code</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>gracefull</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Stop and restart the engine and the entire program <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>code</em> </td><td>Return code of the program </td></tr>
<tr><td valign="top"></td><td valign="top"><em>gracefull</em> </td><td>Attempt to wait until no plugin is busy </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if restart was initiated, false if exiting or no supervisor </dd></dl>
</div>
</div><p>
<a class="anchor" name="58e8be2db2660128e4e6456a9c981fb5"></a><!-- doxytag: member="TelEngine::Engine::run" ref="58e8be2db2660128e4e6456a9c981fb5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int run </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Run the engine. <dl class="return" compact><dt><b>Returns:</b></dt><dd>Error code, 0 for success </dd></dl>
</div>
</div><p>
<a class="anchor" name="f504fdfba4ac792ebdda72acc5f36d15"></a><!-- doxytag: member="TelEngine::Engine::runId" ref="f504fdfba4ac792ebdda72acc5f36d15" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static unsigned int runId </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a - supposedly unique - instance ID <dl class="return" compact><dt><b>Returns:</b></dt><dd>Unique ID of the current running instance </dd></dl>
</div>
</div><p>
<a class="anchor" name="8cf10a511683dcdf192e6b53a25515aa"></a><!-- doxytag: member="TelEngine::Engine::runParams" ref="8cf10a511683dcdf192e6b53a25515aa" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classTelEngine_1_1NamedList.html">NamedList</a>& runParams </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the engine parameters specific to this run. <dl class="return" compact><dt><b>Returns:</b></dt><dd>A reference to the list of run specific parameters </dd></dl>
</div>
</div><p>
<a class="anchor" name="ede4de7922dea3d7e18b72102ff428c3"></a><!-- doxytag: member="TelEngine::Engine::self" ref="ede4de7922dea3d7e18b72102ff428c3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classTelEngine_1_1Engine.html">Engine</a>* self </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a pointer to the unique instance. <dl class="return" compact><dt><b>Returns:</b></dt><dd>A pointer to the singleton instance of the engine </dd></dl>
</div>
</div><p>
<a class="anchor" name="26b1251594cbd70dc5774518ec7b42ba"></a><!-- doxytag: member="TelEngine::Engine::setHook" ref="26b1251594cbd70dc5774518ec7b42ba" args="(MessagePostHook *hook, bool remove=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setHook </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1MessagePostHook.html">MessagePostHook</a> * </td>
<td class="paramname"> <em>hook</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>remove</em> = <code>false</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>
Install or remove a hook to catch messages after being dispatched <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>hook</em> </td><td>Pointer to a post-dispatching message hook </td></tr>
<tr><td valign="top"></td><td valign="top"><em>remove</em> </td><td>Set to True to remove the hook instead of adding </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="b0dee886f4c10ebff6904c5851e9fd43"></a><!-- doxytag: member="TelEngine::Engine::sharedPath" ref="b0dee886f4c10ebff6904c5851e9fd43" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classTelEngine_1_1String.html">String</a>& sharedPath </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the application's shared directory path <dl class="return" compact><dt><b>Returns:</b></dt><dd>The base path for shared files and directories </dd></dl>
</div>
</div><p>
<a class="anchor" name="56ca768f5ee505bfab9c404a55c8d95e"></a><!-- doxytag: member="TelEngine::Engine::uninstall" ref="56ca768f5ee505bfab9c404a55c8d95e" args="(MessageHandler *handler)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool uninstall </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1MessageHandler.html">MessageHandler</a> * </td>
<td class="paramname"> <em>handler</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Uninstalls a handler drom the dispatcher. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>handler</em> </td><td>A pointer to the handler to uninstall </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True on success, false on failure </dd></dl>
</div>
</div><p>
<a class="anchor" name="3f905eb59144371fb27eac5bf55b2a27"></a><!-- doxytag: member="TelEngine::Engine::usedPlugins" ref="3f905eb59144371fb27eac5bf55b2a27" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int usedPlugins </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a count of plugins that are actively in use <dl class="return" compact><dt><b>Returns:</b></dt><dd>Count of plugins in use </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="yatengine_8h-source.html">yatengine.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
>
117
