Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > eeacaa4eb55fa544d622989e42fc27b1 > files > 108

libyate-devel-2.0.0-2mdv2009.1.i586.rpm

<!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: Driver 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&nbsp;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&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="namespaceTelEngine.html">TelEngine</a>::<a class="el" href="classTelEngine_1_1Driver.html">Driver</a>
  </div>
</div>
<div class="contents">
<h1>Driver Class Reference</h1><!-- doxytag: class="TelEngine::Driver" --><!-- doxytag: inherits="TelEngine::Module" -->A <a class="el" href="classTelEngine_1_1Channel.html" title="An abstract communication channel.">Channel</a> driver module.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="yatephone_8h-source.html">yatephone.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for Driver:</div>
<div class="dynsection">

<p><center><img src="classTelEngine_1_1Driver.png" usemap="#Driver_map" border="0" alt=""></center>
<map name="Driver_map">
<area href="classTelEngine_1_1Module.html" alt="Module" shape="rect" coords="186,112,300,136">
<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_1ClientDriver.html" alt="ClientDriver" shape="rect" coords="186,224,300,248">
</map>
</div>

<p>
<a href="classTelEngine_1_1Driver-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 *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Driver.html#aa71c3294b1a073c3ad0b64a2ed6325a">getObject</a> (const <a class="el" href="classTelEngine_1_1String.html">String</a> &amp;name) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classTelEngine_1_1String.html">String</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Driver.html#594d5e541ef32b757348f20581ad5cd8">prefix</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Driver.html#afc32f90d09f675e05a75e0cc2236d63">varchan</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1ObjList.html">ObjList</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Driver.html#dc2a11b4f8a42e08e46c92e790443578">channels</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classTelEngine_1_1Channel.html">Channel</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Driver.html#988856c0fce5326708637bce0c9337d3">find</a> (const <a class="el" href="classTelEngine_1_1String.html">String</a> &amp;id) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Driver.html#beb36e46a4679f3d29c28d783447a920">isBusy</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Driver.html#42da4684c32903217216fdfd32babf86">dropAll</a> (<a class="el" href="classTelEngine_1_1Message.html">Message</a> &amp;msg)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Driver.html#a21e34545287c6bb4b7be98e2f8d50e4">canAccept</a> (bool routers=true)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Driver.html#25246213702e229eb65a4afa1cd206c2">canRoute</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Driver.html#1d9e4c6ea5055ba97ee7f76fe6d217bc">nextid</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Driver.html#b60d2f24ca66b4a5fef300c0a10d4b93">lastid</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Driver.html#aa0d28397aee37e1297013614093c116">timeout</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Driver.html#b486bff16ae96e6a6987f13dcc2ff50c">routing</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Driver.html#eec5b9f0f65e9419cecb42653db6380e">routed</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Driver.html#9ff8b3e2d7cd9f288033fc9e74a8c3d4">total</a> () const </td></tr>

<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Driver.html#06d9e232f11dbcf62c315d39738402f3">Driver</a> (const char *name, const char *type=0)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Driver.html#6365dca5a7d8ddb694726a53b55a4c27">initialize</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Driver.html#0426a4610460a1c7923ba7353a7252f1">setup</a> (const char *prefix=0, bool minimal=false)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Driver.html#83a6735e1655ebb8c96a3f91314ba682">received</a> (<a class="el" href="classTelEngine_1_1Message.html">Message</a> &amp;msg, int id)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Driver.html#4567b13cc84cbdd238fdb72400db779e">genUpdate</a> (<a class="el" href="classTelEngine_1_1Message.html">Message</a> &amp;msg)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Driver.html#9ba580c0044e457c36de4f311b4c352f">hasLine</a> (const <a class="el" href="classTelEngine_1_1String.html">String</a> &amp;line) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Driver.html#cfde90793ec85684f300b905cdc97005">msgRoute</a> (<a class="el" href="classTelEngine_1_1Message.html">Message</a> &amp;msg)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Driver.html#046d188b2c6599ea960d16df3cd66e55">msgExecute</a> (<a class="el" href="classTelEngine_1_1Message.html">Message</a> &amp;msg, <a class="el" href="classTelEngine_1_1String.html">String</a> &amp;dest)=0</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Driver.html#f149b955546da7e8b8b86faaa285471f">commandComplete</a> (<a class="el" href="classTelEngine_1_1Message.html">Message</a> &amp;msg, const <a class="el" href="classTelEngine_1_1String.html">String</a> &amp;partLine, const <a class="el" href="classTelEngine_1_1String.html">String</a> &amp;partWord)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Driver.html#10d13a32476cc8029388c46bf4767522">statusModule</a> (<a class="el" href="classTelEngine_1_1String.html">String</a> &amp;str)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Driver.html#0b03ee0e462004bbe59a7bcd1b6f7f3c">statusParams</a> (<a class="el" href="classTelEngine_1_1String.html">String</a> &amp;str)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Driver.html#4c2ff980c410e87f3b9e03d1afb4e1a1">statusDetail</a> (<a class="el" href="classTelEngine_1_1String.html">String</a> &amp;str)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Driver.html#0f175a394a846c1b374dcb808c8d6660">setDebug</a> (<a class="el" href="classTelEngine_1_1Message.html">Message</a> &amp;msg, const <a class="el" href="classTelEngine_1_1String.html">String</a> &amp;target)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Driver.html#62bf3cbfda1cd7641f20c6b5267b015e">loadLimits</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Driver.html#a639363d0dcf31cef945b1b91b16a7d1">varchan</a> (bool variable)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Driver.html#0b460706e6305f6fdc2af8097210917a">timeout</a> (int tout)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Driver.html#6db0325f9b32e30c33c8c5d9c48c5027">maxRoute</a> (int ncalls)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Driver.html#dd8852fb2cd53967c0319ea605873a55">maxChans</a> (int ncalls)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Driver.html#a9964968adc5a5e8d7e052862e1712b9">dtmfDups</a> (bool duplicates)</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="d1fd3424328f664cd049fe429e0e3dc6"></a><!-- doxytag: member="TelEngine::Driver::Router" ref="d1fd3424328f664cd049fe429e0e3dc6" args="" -->
class&nbsp;</td><td class="memItemRight" valign="bottom"><b>Router</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c47342240f21ce36f47485e4ab41a10d"></a><!-- doxytag: member="TelEngine::Driver::Channel" ref="c47342240f21ce36f47485e4ab41a10d" args="" -->
class&nbsp;</td><td class="memItemRight" valign="bottom"><b>Channel</b></td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A <a class="el" href="classTelEngine_1_1Channel.html" title="An abstract communication channel.">Channel</a> driver module. 
<p>
<a class="el" href="classTelEngine_1_1Driver.html" title="A Channel driver module.">Driver</a> is a module specialized for implementing channel drivers <hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="06d9e232f11dbcf62c315d39738402f3"></a><!-- doxytag: member="TelEngine::Driver::Driver" ref="06d9e232f11dbcf62c315d39738402f3" args="(const char *name, const char *type=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTelEngine_1_1Driver.html">Driver</a>           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>type</em> = <code>0</code></td><td>&nbsp;</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>&nbsp;</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>&nbsp;</td><td>Type of the driver: "fixchans", "varchans", etc. </td></tr>
  </table>
</dl>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a21e34545287c6bb4b7be98e2f8d50e4"></a><!-- doxytag: member="TelEngine::Driver::canAccept" ref="a21e34545287c6bb4b7be98e2f8d50e4" args="(bool routers=true)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool canAccept           </td>
          <td>(</td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>routers</em> = <code>true</code>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Check if new connections can be accepted <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>routers</em>&nbsp;</td><td>Set to true to check routing threads for incoming connections </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if at least one new connection can be accepted, false if not </dd></dl>

</div>
</div><p>
<a class="anchor" name="25246213702e229eb65a4afa1cd206c2"></a><!-- doxytag: member="TelEngine::Driver::canRoute" ref="25246213702e229eb65a4afa1cd206c2" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool canRoute           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Check if new incoming connections can be routed <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if at least one new connection can be routed, false if not </dd></dl>

</div>
</div><p>
<a class="anchor" name="dc2a11b4f8a42e08e46c92e790443578"></a><!-- doxytag: member="TelEngine::Driver::channels" ref="dc2a11b4f8a42e08e46c92e790443578" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTelEngine_1_1ObjList.html">ObjList</a>&amp; channels           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the list of channels of this driver <dl class="return" compact><dt><b>Returns:</b></dt><dd>A reference to the channel list </dd></dl>

</div>
</div><p>
<a class="anchor" name="f149b955546da7e8b8b86faaa285471f"></a><!-- doxytag: member="TelEngine::Driver::commandComplete" ref="f149b955546da7e8b8b86faaa285471f" args="(Message &amp;msg, const String &amp;partLine, const String &amp;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> &amp;&nbsp;</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> &amp;&nbsp;</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> &amp;&nbsp;</td>
          <td class="paramname"> <em>partWord</em></td><td>&nbsp;</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>&nbsp;</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>&nbsp;</td><td>Partial line to complete, excluding the last word </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>partWord</em>&nbsp;</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 from <a class="el" href="classTelEngine_1_1Module.html#f149b955546da7e8b8b86faaa285471f">Module</a>.</p>

</div>
</div><p>
<a class="anchor" name="42da4684c32903217216fdfd32babf86"></a><!-- doxytag: member="TelEngine::Driver::dropAll" ref="42da4684c32903217216fdfd32babf86" args="(Message &amp;msg)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void dropAll           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classTelEngine_1_1Message.html">Message</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>msg</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Drop all current channels <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>&nbsp;</td><td>Notification message </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="a9964968adc5a5e8d7e052862e1712b9"></a><!-- doxytag: member="TelEngine::Driver::dtmfDups" ref="a9964968adc5a5e8d7e052862e1712b9" args="(bool duplicates)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void dtmfDups           </td>
          <td>(</td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>duplicates</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the DTMF duplicates allowed flag <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>duplicates</em>&nbsp;</td><td>True to allow DTMF duplicate messages </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="988856c0fce5326708637bce0c9337d3"></a><!-- doxytag: member="TelEngine::Driver::find" ref="988856c0fce5326708637bce0c9337d3" args="(const String &amp;id) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classTelEngine_1_1Channel.html">Channel</a>* find           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>id</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Find a channel by 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>&nbsp;</td><td>Unique identifier of the channel to find </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Pointer to the channel or NULL if not found </dd></dl>

</div>
</div><p>
<a class="anchor" name="4567b13cc84cbdd238fdb72400db779e"></a><!-- doxytag: member="TelEngine::Driver::genUpdate" ref="4567b13cc84cbdd238fdb72400db779e" args="(Message &amp;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> &amp;&nbsp;</td>
          <td class="paramname"> <em>msg</em>          </td>
          <td>&nbsp;)&nbsp;</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>&nbsp;</td><td>Status update message </td></tr>
  </table>
</dl>

<p>Reimplemented from <a class="el" href="classTelEngine_1_1Module.html#4567b13cc84cbdd238fdb72400db779e">Module</a>.</p>

</div>
</div><p>
<a class="anchor" name="aa71c3294b1a073c3ad0b64a2ed6325a"></a><!-- doxytag: member="TelEngine::Driver::getObject" ref="aa71c3294b1a073c3ad0b64a2ed6325a" args="(const String &amp;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> &amp;&nbsp;</td>
          <td class="paramname"> <em>name</em>          </td>
          <td>&nbsp;)&nbsp;</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>&nbsp;</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_1Module.html#aa71c3294b1a073c3ad0b64a2ed6325a">Module</a>.</p>

</div>
</div><p>
<a class="anchor" name="9ba580c0044e457c36de4f311b4c352f"></a><!-- doxytag: member="TelEngine::Driver::hasLine" ref="9ba580c0044e457c36de4f311b4c352f" args="(const String &amp;line) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool hasLine           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>line</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Check if driver owns a client line (registered to an external server) <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>line</em>&nbsp;</td><td>Name of the line to check </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if this driver owns line with the specified name </dd></dl>

</div>
</div><p>
<a class="anchor" name="6365dca5a7d8ddb694726a53b55a4c27"></a><!-- doxytag: member="TelEngine::Driver::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>&nbsp;)&nbsp;</td>
          <td><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
This method is called to initialize the loaded module 
<p>Reimplemented from <a class="el" href="classTelEngine_1_1Module.html#6365dca5a7d8ddb694726a53b55a4c27">Module</a>.</p>

<p>Reimplemented in <a class="el" href="classTelEngine_1_1ClientDriver.html#a5085af8ee5e5c39b4c20c60231e5c92">ClientDriver</a>.</p>

</div>
</div><p>
<a class="anchor" name="beb36e46a4679f3d29c28d783447a920"></a><!-- doxytag: member="TelEngine::Driver::isBusy" ref="beb36e46a4679f3d29c28d783447a920" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool isBusy           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Check if the driver is actively used. <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the driver is in use, false if should be ok to restart </dd></dl>

<p>Reimplemented from <a class="el" href="classTelEngine_1_1Plugin.html#beb36e46a4679f3d29c28d783447a920">Plugin</a>.</p>

</div>
</div><p>
<a class="anchor" name="b60d2f24ca66b4a5fef300c0a10d4b93"></a><!-- doxytag: member="TelEngine::Driver::lastid" ref="b60d2f24ca66b4a5fef300c0a10d4b93" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned int lastid           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the current (last used) unique numeric id from a sequence <dl class="return" compact><dt><b>Returns:</b></dt><dd>The driver unique number </dd></dl>

</div>
</div><p>
<a class="anchor" name="62bf3cbfda1cd7641f20c6b5267b015e"></a><!-- doxytag: member="TelEngine::Driver::loadLimits" ref="62bf3cbfda1cd7641f20c6b5267b015e" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void loadLimits           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Load the global limits from the main config file 
</div>
</div><p>
<a class="anchor" name="dd8852fb2cd53967c0319ea605873a55"></a><!-- doxytag: member="TelEngine::Driver::maxChans" ref="dd8852fb2cd53967c0319ea605873a55" args="(int ncalls)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void maxChans           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>ncalls</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the maximum number of running channels for this driver <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>ncalls</em>&nbsp;</td><td>Number of calls to run simultaneously, zero to accept all </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="6db0325f9b32e30c33c8c5d9c48c5027"></a><!-- doxytag: member="TelEngine::Driver::maxRoute" ref="6db0325f9b32e30c33c8c5d9c48c5027" args="(int ncalls)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void maxRoute           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>ncalls</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the maximum number of routing messages for this driver <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>ncalls</em>&nbsp;</td><td>Number of calls to route simultaneously, zero to accept all </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="046d188b2c6599ea960d16df3cd66e55"></a><!-- doxytag: member="TelEngine::Driver::msgExecute" ref="046d188b2c6599ea960d16df3cd66e55" args="(Message &amp;msg, String &amp;dest)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool msgExecute           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classTelEngine_1_1Message.html">Message</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>msg</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classTelEngine_1_1String.html">String</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>dest</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [protected, pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create an outgoing calling channel <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>&nbsp;</td><td>Call execute message </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>dest</em>&nbsp;</td><td>Destination of the new call </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if outgoing call was created </dd></dl>

<p>Implemented in <a class="el" href="classTelEngine_1_1ClientDriver.html#88fd4092ab3c294e0cc115b60d2b7671">ClientDriver</a>.</p>

</div>
</div><p>
<a class="anchor" name="cfde90793ec85684f300b905cdc97005"></a><!-- doxytag: member="TelEngine::Driver::msgRoute" ref="cfde90793ec85684f300b905cdc97005" args="(Message &amp;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> &amp;&nbsp;</td>
          <td class="paramname"> <em>msg</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Routing message handler. The default implementation routes to this driver if it owns a line named in the "account" or "line" parameter. <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>&nbsp;</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 from <a class="el" href="classTelEngine_1_1Module.html#cfde90793ec85684f300b905cdc97005">Module</a>.</p>

<p>Reimplemented in <a class="el" href="classTelEngine_1_1ClientDriver.html#cfde90793ec85684f300b905cdc97005">ClientDriver</a>.</p>

</div>
</div><p>
<a class="anchor" name="1d9e4c6ea5055ba97ee7f76fe6d217bc"></a><!-- doxytag: member="TelEngine::Driver::nextid" ref="1d9e4c6ea5055ba97ee7f76fe6d217bc" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned int nextid           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the next unique numeric id from a sequence <dl class="return" compact><dt><b>Returns:</b></dt><dd>A driver unique number that increments by 1 at each call </dd></dl>

</div>
</div><p>
<a class="anchor" name="594d5e541ef32b757348f20581ad5cd8"></a><!-- doxytag: member="TelEngine::Driver::prefix" ref="594d5e541ef32b757348f20581ad5cd8" 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>&amp; prefix           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Retrive the prefix that is used as base for all channels <dl class="return" compact><dt><b>Returns:</b></dt><dd>The driver's prefix </dd></dl>

</div>
</div><p>
<a class="anchor" name="83a6735e1655ebb8c96a3f91314ba682"></a><!-- doxytag: member="TelEngine::Driver::received" ref="83a6735e1655ebb8c96a3f91314ba682" args="(Message &amp;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> &amp;&nbsp;</td>
          <td class="paramname"> <em>msg</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>id</em></td><td>&nbsp;</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>&nbsp;</td><td>The received message </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>id</em>&nbsp;</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>Reimplemented from <a class="el" href="classTelEngine_1_1Module.html#83a6735e1655ebb8c96a3f91314ba682">Module</a>.</p>

<p>Reimplemented in <a class="el" href="classTelEngine_1_1ClientDriver.html#83a6735e1655ebb8c96a3f91314ba682">ClientDriver</a>.</p>

</div>
</div><p>
<a class="anchor" name="eec5b9f0f65e9419cecb42653db6380e"></a><!-- doxytag: member="TelEngine::Driver::routed" ref="eec5b9f0f65e9419cecb42653db6380e" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int routed           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the number of calls successfully routed <dl class="return" compact><dt><b>Returns:</b></dt><dd>Number of calls that have gone past the routing stage </dd></dl>

</div>
</div><p>
<a class="anchor" name="b486bff16ae96e6a6987f13dcc2ff50c"></a><!-- doxytag: member="TelEngine::Driver::routing" ref="b486bff16ae96e6a6987f13dcc2ff50c" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int routing           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the number of calls currently in the routing stage <dl class="return" compact><dt><b>Returns:</b></dt><dd>Number of router threads currently running </dd></dl>

</div>
</div><p>
<a class="anchor" name="0f175a394a846c1b374dcb808c8d6660"></a><!-- doxytag: member="TelEngine::Driver::setDebug" ref="0f175a394a846c1b374dcb808c8d6660" args="(Message &amp;msg, const String &amp;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> &amp;&nbsp;</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> &amp;&nbsp;</td>
          <td class="paramname"> <em>target</em></td><td>&nbsp;</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>&nbsp;</td><td>Debug setting message </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>target</em>&nbsp;</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 from <a class="el" href="classTelEngine_1_1Module.html#0f175a394a846c1b374dcb808c8d6660">Module</a>.</p>

</div>
</div><p>
<a class="anchor" name="0426a4610460a1c7923ba7353a7252f1"></a><!-- doxytag: member="TelEngine::Driver::setup" ref="0426a4610460a1c7923ba7353a7252f1" args="(const char *prefix=0, bool minimal=false)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void setup           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>prefix</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>minimal</em> = <code>false</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Install standard message relays and set up the prefix <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>prefix</em>&nbsp;</td><td>Prefix to use with channels of this driver </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>minimal</em>&nbsp;</td><td>Install just a minimal set of message relays </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="4c2ff980c410e87f3b9e03d1afb4e1a1"></a><!-- doxytag: member="TelEngine::Driver::statusDetail" ref="4c2ff980c410e87f3b9e03d1afb4e1a1" args="(String &amp;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> &amp;&nbsp;</td>
          <td class="paramname"> <em>str</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Build the channel list 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>&nbsp;</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 from <a class="el" href="classTelEngine_1_1Module.html#4c2ff980c410e87f3b9e03d1afb4e1a1">Module</a>.</p>

</div>
</div><p>
<a class="anchor" name="10d13a32476cc8029388c46bf4767522"></a><!-- doxytag: member="TelEngine::Driver::statusModule" ref="10d13a32476cc8029388c46bf4767522" args="(String &amp;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> &amp;&nbsp;</td>
          <td class="paramname"> <em>str</em>          </td>
          <td>&nbsp;)&nbsp;</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>&nbsp;</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 from <a class="el" href="classTelEngine_1_1Module.html#10d13a32476cc8029388c46bf4767522">Module</a>.</p>

</div>
</div><p>
<a class="anchor" name="0b03ee0e462004bbe59a7bcd1b6f7f3c"></a><!-- doxytag: member="TelEngine::Driver::statusParams" ref="0b03ee0e462004bbe59a7bcd1b6f7f3c" args="(String &amp;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> &amp;&nbsp;</td>
          <td class="paramname"> <em>str</em>          </td>
          <td>&nbsp;)&nbsp;</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>&nbsp;</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 from <a class="el" href="classTelEngine_1_1Module.html#0b03ee0e462004bbe59a7bcd1b6f7f3c">Module</a>.</p>

</div>
</div><p>
<a class="anchor" name="0b460706e6305f6fdc2af8097210917a"></a><!-- doxytag: member="TelEngine::Driver::timeout" ref="0b460706e6305f6fdc2af8097210917a" args="(int tout)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void timeout           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>tout</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the default driver timeout <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>tout</em>&nbsp;</td><td>New timeout in milliseconds or zero to disable </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="aa0d28397aee37e1297013614093c116"></a><!-- doxytag: member="TelEngine::Driver::timeout" ref="aa0d28397aee37e1297013614093c116" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int timeout           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the default driver timeout <dl class="return" compact><dt><b>Returns:</b></dt><dd>Timeout value in milliseconds </dd></dl>

</div>
</div><p>
<a class="anchor" name="9ff8b3e2d7cd9f288033fc9e74a8c3d4"></a><!-- doxytag: member="TelEngine::Driver::total" ref="9ff8b3e2d7cd9f288033fc9e74a8c3d4" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int total           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the total number of calls ever created <dl class="return" compact><dt><b>Returns:</b></dt><dd>Number of channels ever created for this driver </dd></dl>

</div>
</div><p>
<a class="anchor" name="a639363d0dcf31cef945b1b91b16a7d1"></a><!-- doxytag: member="TelEngine::Driver::varchan" ref="a639363d0dcf31cef945b1b91b16a7d1" args="(bool variable)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void varchan           </td>
          <td>(</td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>variable</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set if this driver is for dynamic (variable number) channels <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>variable</em>&nbsp;</td><td>True if the channels are dynamic, false for fixed </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="afc32f90d09f675e05a75e0cc2236d63"></a><!-- doxytag: member="TelEngine::Driver::varchan" ref="afc32f90d09f675e05a75e0cc2236d63" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool varchan           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Check if this driver is for dynamic (variable number) channels <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the channels are dynamic, false for fixed </dd></dl>

</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&nbsp;
<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>