<!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: ClientDriver 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_1ClientDriver.html">ClientDriver</a>
</div>
</div>
<div class="contents">
<h1>ClientDriver Class Reference</h1><!-- doxytag: class="TelEngine::ClientDriver" --><!-- doxytag: inherits="TelEngine::Driver" -->Base <a class="el" href="classTelEngine_1_1Driver.html" title="A Channel driver module.">Driver</a> with client specific functions.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="yatecbase_8h-source.html">yatecbase.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for ClientDriver:</div>
<div class="dynsection">
<p><center><img src="classTelEngine_1_1ClientDriver.png" usemap="#ClientDriver_map" border="0" alt=""></center>
<map name="ClientDriver_map">
<area href="classTelEngine_1_1Driver.html" alt="Driver" shape="rect" coords="186,168,300,192">
<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">
</map>
</div>
<p>
<a href="classTelEngine_1_1ClientDriver-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientDriver.html#a5085af8ee5e5c39b4c20c60231e5c92">initialize</a> ()=0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientDriver.html#88fd4092ab3c294e0cc115b60d2b7671">msgExecute</a> (<a class="el" href="classTelEngine_1_1Message.html">Message</a> &msg, <a class="el" href="classTelEngine_1_1String.html">String</a> &dest)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientDriver.html#0d13088f320767e4719998693e1ade19">msgTimer</a> (<a class="el" href="classTelEngine_1_1Message.html">Message</a> &msg)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientDriver.html#cfde90793ec85684f300b905cdc97005">msgRoute</a> (<a class="el" href="classTelEngine_1_1Message.html">Message</a> &msg)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientDriver.html#83a6735e1655ebb8c96a3f91314ba682">received</a> (<a class="el" href="classTelEngine_1_1Message.html">Message</a> &msg, int id)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientDriver.html#9c2a22b9ac2fa2e78470149d69d4009c">activeId</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientDriver.html#4a6b2cbd935d2ab51af09b5123c3bb73">setActive</a> (const <a class="el" href="classTelEngine_1_1String.html">String</a> &id=String::empty())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1ClientChannel.html">ClientChannel</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientDriver.html#3af11d81cbe3160faf15dedcf4ef75e4">findLine</a> (int line)</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 <a class="el" href="classTelEngine_1_1ClientDriver.html">ClientDriver</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientDriver.html#2bb728acb9046e62f734a5765f55db0e">self</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_1ClientDriver.html#ac847bc0f614eaba61e3fb4138a62ae6">device</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_1ClientDriver.html#0245b7488fcae9d049a84db7a5239682">setAudioTransfer</a> (const <a class="el" href="classTelEngine_1_1String.html">String</a> &id, const <a class="el" href="classTelEngine_1_1String.html">String</a> &target=String::empty())</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_1ClientDriver.html#1c8506d151f14fdcfb74f9360552fe5d">setConference</a> (const <a class="el" href="classTelEngine_1_1String.html">String</a> &id, bool in, const <a class="el" href="classTelEngine_1_1String.html">String</a> *confName=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classTelEngine_1_1ClientChannel.html">ClientChannel</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientDriver.html#53a91ff1c6eb1283c46bf1597059ae4a">findChan</a> (const <a class="el" href="classTelEngine_1_1String.html">String</a> &id)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classTelEngine_1_1ClientChannel.html">ClientChannel</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientDriver.html#16c008311b6cbb474ac227c91c585fdc">findChanByPeer</a> (const <a class="el" href="classTelEngine_1_1String.html">String</a> &peer)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classTelEngine_1_1ClientChannel.html">ClientChannel</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientDriver.html#e322a4747de8e6d0fc5bfd62b60c5416">findActiveChan</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Static Public Attributes</h2></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_1ClientDriver.html#60b0b64b3bfc09e4f303d2e97dfc7b73">s_confName</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_1ClientDriver.html#7126c28e5f1198260b4a573b5245cd30">s_dropConfPeer</a></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientDriver.html#4fc01d736fe50cf5b977f755b675f11d">setup</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e24d67564e097f91b7f9c72a0c6ace90"></a><!-- doxytag: member="TelEngine::ClientDriver::m_activeId" ref="e24d67564e097f91b7f9c72a0c6ace90" args="" -->
<a class="el" href="classTelEngine_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><b>m_activeId</b></td></tr>
<tr><td colspan="2"><br><h2>Static Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="817ddb29f3812fccbadb8a8e5c4706ea"></a><!-- doxytag: member="TelEngine::ClientDriver::s_driver" ref="817ddb29f3812fccbadb8a8e5c4706ea" args="" -->
static <a class="el" href="classTelEngine_1_1ClientDriver.html">ClientDriver</a> * </td><td class="memItemRight" valign="bottom"><b>s_driver</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6256b9aee854cdc936ed20ae1c71e283"></a><!-- doxytag: member="TelEngine::ClientDriver::s_device" ref="6256b9aee854cdc936ed20ae1c71e283" args="" -->
static <a class="el" href="classTelEngine_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><b>s_device</b></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="1cdcceed53e77b73e26188f048fda4c3"></a><!-- doxytag: member="TelEngine::ClientDriver::ClientChannel" ref="1cdcceed53e77b73e26188f048fda4c3" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>ClientChannel</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Base <a class="el" href="classTelEngine_1_1Driver.html" title="A Channel driver module.">Driver</a> with client specific functions.
<p>
Abstract client <a class="el" href="classTelEngine_1_1Driver.html" title="A Channel driver module.">Driver</a> that implements some of the specific functionality <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="9c2a22b9ac2fa2e78470149d69d4009c"></a><!-- doxytag: member="TelEngine::ClientDriver::activeId" ref="9c2a22b9ac2fa2e78470149d69d4009c" 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>& activeId </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the active channel's id <dl class="return" compact><dt><b>Returns:</b></dt><dd>The active channel's id </dd></dl>
</div>
</div><p>
<a class="anchor" name="ac847bc0f614eaba61e3fb4138a62ae6"></a><!-- doxytag: member="TelEngine::ClientDriver::device" ref="ac847bc0f614eaba61e3fb4138a62ae6" 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>& device </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the current audio device's name <dl class="return" compact><dt><b>Returns:</b></dt><dd>The current audio device's name </dd></dl>
</div>
</div><p>
<a class="anchor" name="e322a4747de8e6d0fc5bfd62b60c5416"></a><!-- doxytag: member="TelEngine::ClientDriver::findActiveChan" ref="e322a4747de8e6d0fc5bfd62b60c5416" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classTelEngine_1_1ClientChannel.html">ClientChannel</a>* findActiveChan </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the active channel <dl class="return" compact><dt><b>Returns:</b></dt><dd>Referenced <a class="el" href="classTelEngine_1_1ClientChannel.html" title="Channel used by client programs.">ClientChannel</a> pointer or 0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="53a91ff1c6eb1283c46bf1597059ae4a"></a><!-- doxytag: member="TelEngine::ClientDriver::findChan" ref="53a91ff1c6eb1283c46bf1597059ae4a" args="(const String &id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classTelEngine_1_1ClientChannel.html">ClientChannel</a>* findChan </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>id</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a referenced channel found by its id <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>The id of the channel to find </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Referenced <a class="el" href="classTelEngine_1_1ClientChannel.html" title="Channel used by client programs.">ClientChannel</a> pointer or 0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="16c008311b6cbb474ac227c91c585fdc"></a><!-- doxytag: member="TelEngine::ClientDriver::findChanByPeer" ref="16c008311b6cbb474ac227c91c585fdc" args="(const String &peer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classTelEngine_1_1ClientChannel.html">ClientChannel</a>* findChanByPeer </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>peer</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a referenced channel whose stored peer is the given one <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>peer</em> </td><td>Peer id to check </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Referenced <a class="el" href="classTelEngine_1_1ClientChannel.html" title="Channel used by client programs.">ClientChannel</a> pointer or 0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="3af11d81cbe3160faf15dedcf4ef75e4"></a><!-- doxytag: member="TelEngine::ClientDriver::findLine" ref="3af11d81cbe3160faf15dedcf4ef75e4" args="(int line)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1ClientChannel.html">ClientChannel</a>* findLine </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>line</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Find a channel by its 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>line</em> </td><td>The line to find </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="classTelEngine_1_1ClientChannel.html" title="Channel used by client programs.">ClientChannel</a> pointer of 0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="a5085af8ee5e5c39b4c20c60231e5c92"></a><!-- doxytag: member="TelEngine::ClientDriver::initialize" ref="a5085af8ee5e5c39b4c20c60231e5c92" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void initialize </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure 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_1Driver.html#6365dca5a7d8ddb694726a53b55a4c27">Driver</a>.</p>
</div>
</div><p>
<a class="anchor" name="88fd4092ab3c294e0cc115b60d2b7671"></a><!-- doxytag: member="TelEngine::ClientDriver::msgExecute" ref="88fd4092ab3c294e0cc115b60d2b7671" args="(Message &msg, String &dest)" -->
<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> & </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> & </td>
<td class="paramname"> <em>dest</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [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> </td><td>Call execute message </td></tr>
<tr><td valign="top"></td><td valign="top"><em>dest</em> </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>Implements <a class="el" href="classTelEngine_1_1Driver.html#046d188b2c6599ea960d16df3cd66e55">Driver</a>.</p>
</div>
</div><p>
<a class="anchor" name="cfde90793ec85684f300b905cdc97005"></a><!-- doxytag: member="TelEngine::ClientDriver::msgRoute" ref="cfde90793ec85684f300b905cdc97005" args="(Message &msg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool msgRoute </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1Message.html">Message</a> & </td>
<td class="paramname"> <em>msg</em> </td>
<td> ) </td>
<td><code> [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> </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_1Driver.html#cfde90793ec85684f300b905cdc97005">Driver</a>.</p>
</div>
</div><p>
<a class="anchor" name="0d13088f320767e4719998693e1ade19"></a><!-- doxytag: member="TelEngine::ClientDriver::msgTimer" ref="0d13088f320767e4719998693e1ade19" args="(Message &msg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void msgTimer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1Message.html">Message</a> & </td>
<td class="paramname"> <em>msg</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Timer message handler. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td><a class="el" href="classTelEngine_1_1Time.html" title="A time holding class.">Time</a> message </td></tr>
</table>
</dl>
<p>Reimplemented from <a class="el" href="classTelEngine_1_1Module.html#0d13088f320767e4719998693e1ade19">Module</a>.</p>
</div>
</div><p>
<a class="anchor" name="83a6735e1655ebb8c96a3f91314ba682"></a><!-- doxytag: member="TelEngine::ClientDriver::received" ref="83a6735e1655ebb8c96a3f91314ba682" args="(Message &msg, int id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool received </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1Message.html">Message</a> & </td>
<td class="paramname"> <em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<a class="el" href="classTelEngine_1_1Message.html" title="A message container class.">Message</a> receiver handler <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>The received message </td></tr>
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>The identifier with which the relay was created </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True to stop processing, false to try other handlers </dd></dl>
<p>Reimplemented from <a class="el" href="classTelEngine_1_1Driver.html#83a6735e1655ebb8c96a3f91314ba682">Driver</a>.</p>
</div>
</div><p>
<a class="anchor" name="2bb728acb9046e62f734a5765f55db0e"></a><!-- doxytag: member="TelEngine::ClientDriver::self" ref="2bb728acb9046e62f734a5765f55db0e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classTelEngine_1_1ClientDriver.html">ClientDriver</a>* self </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the global client driver object's address <dl class="return" compact><dt><b>Returns:</b></dt><dd>The global client driver object's address </dd></dl>
</div>
</div><p>
<a class="anchor" name="4a6b2cbd935d2ab51af09b5123c3bb73"></a><!-- doxytag: member="TelEngine::ClientDriver::setActive" ref="4a6b2cbd935d2ab51af09b5123c3bb73" args="(const String &id=String::empty())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool setActive </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>id</em> = <code>String::empty()</code> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set/reset the active channel. Does nothing if the selected channel is the active one. Put the active channel on hold before trying to set the active 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>id</em> </td><td>The new active channel's id. Set to empty if don't want to set a new active channel </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True on success </dd></dl>
</div>
</div><p>
<a class="anchor" name="0245b7488fcae9d049a84db7a5239682"></a><!-- doxytag: member="TelEngine::ClientDriver::setAudioTransfer" ref="0245b7488fcae9d049a84db7a5239682" args="(const String &id, const String &target=String::empty())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool setAudioTransfer </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>target</em> = <code>String::empty()</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>
Attach/detach client channels peers' source/consumer <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>The id of the channel to tranfer </td></tr>
<tr><td valign="top"></td><td valign="top"><em>target</em> </td><td>The transfer target. Leave blank to reset the channel's transfer id </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True on success </dd></dl>
</div>
</div><p>
<a class="anchor" name="1c8506d151f14fdcfb74f9360552fe5d"></a><!-- doxytag: member="TelEngine::ClientDriver::setConference" ref="1c8506d151f14fdcfb74f9360552fe5d" args="(const String &id, bool in, const String *confName=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool setConference </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>in</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> * </td>
<td class="paramname"> <em>confName</em> = <code>0</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>
Attach/detach a client channel to/from a conference room <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>The id of the channel to process </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in</em> </td><td>True to enter the conference room, false to exit from it </td></tr>
<tr><td valign="top"></td><td valign="top"><em>confName</em> </td><td>Optional id of the conference. Set to 0 to use the default one Ignored if 'in' is false </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True on success </dd></dl>
</div>
</div><p>
<a class="anchor" name="4fc01d736fe50cf5b977f755b675f11d"></a><!-- doxytag: member="TelEngine::ClientDriver::setup" ref="4fc01d736fe50cf5b977f755b675f11d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setup </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Install standard message relays
<p>Reimplemented from <a class="el" href="classTelEngine_1_1Module.html#4fc01d736fe50cf5b977f755b675f11d">Module</a>.</p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="60b0b64b3bfc09e4f303d2e97dfc7b73"></a><!-- doxytag: member="TelEngine::ClientDriver::s_confName" ref="60b0b64b3bfc09e4f303d2e97dfc7b73" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1String.html">String</a> <a class="el" href="classTelEngine_1_1ClientDriver.html#60b0b64b3bfc09e4f303d2e97dfc7b73">s_confName</a><code> [static]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The name to use when the client is in conference
</div>
</div><p>
<a class="anchor" name="7126c28e5f1198260b4a573b5245cd30"></a><!-- doxytag: member="TelEngine::ClientDriver::s_dropConfPeer" ref="7126c28e5f1198260b4a573b5245cd30" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classTelEngine_1_1ClientDriver.html#7126c28e5f1198260b4a573b5245cd30">s_dropConfPeer</a><code> [static]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Indicates wether a channel should drop its former peer when terminated while in conference
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="yatecbase_8h-source.html">yatecbase.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
>
67
