<!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: ClientChannel 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_1ClientChannel.html">ClientChannel</a>
</div>
</div>
<div class="contents">
<h1>ClientChannel Class Reference</h1><!-- doxytag: class="TelEngine::ClientChannel" --><!-- doxytag: inherits="TelEngine::Channel" --><a class="el" href="classTelEngine_1_1Channel.html" title="An abstract communication channel.">Channel</a> used by client programs.
<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 ClientChannel:</div>
<div class="dynsection">
<p><center><img src="classTelEngine_1_1ClientChannel.png" usemap="#ClientChannel_map" border="0" alt=""></center>
<map name="ClientChannel_map">
<area href="classTelEngine_1_1Channel.html" alt="Channel" shape="rect" coords="51,168,144,192">
<area href="classTelEngine_1_1CallEndpoint.html" alt="CallEndpoint" shape="rect" coords="0,112,93,136">
<area href="classTelEngine_1_1DebugEnabler.html" alt="DebugEnabler" shape="rect" coords="103,112,196,136">
<area href="classTelEngine_1_1RefObject.html" alt="RefObject" shape="rect" coords="0,56,93,80">
<area href="classTelEngine_1_1GenObject.html" alt="GenObject" shape="rect" coords="0,0,93,24">
</map>
</div>
<p>
<a href="classTelEngine_1_1ClientChannel-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_1ClientChannel.html#9b7018c6a58f6d63a9446fea1f12ad89">Notification</a> { <br>
<b>Startup</b>,
<b>Destroyed</b>,
<b>Active</b>,
<b>OnHold</b>,
<br>
<b>Noticed</b>,
<b>AddrChanged</b>,
<b>Routed</b>,
<b>Accepted</b>,
<br>
<b>Rejected</b>,
<b>Progressing</b>,
<b>Ringing</b>,
<b>Answered</b>,
<br>
<b>Transfer</b>,
<b>Conference</b>,
<b>Unknown</b>
<br>
}</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="42c1fa3a2e6145e432abd8aed4d33fc8"></a><!-- doxytag: member="TelEngine::ClientChannel::ClientChannel" ref="42c1fa3a2e6145e432abd8aed4d33fc8" args="(const Message &msg, const String &peerid)" -->
</td><td class="memItemRight" valign="bottom"><b>ClientChannel</b> (const <a class="el" href="classTelEngine_1_1Message.html">Message</a> &msg, const <a class="el" href="classTelEngine_1_1String.html">String</a> &peerid)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="941df895b8c336cbe661259a32640462"></a><!-- doxytag: member="TelEngine::ClientChannel::ClientChannel" ref="941df895b8c336cbe661259a32640462" args="(const String &target, const NamedList &params)" -->
</td><td class="memItemRight" valign="bottom"><b>ClientChannel</b> (const <a class="el" href="classTelEngine_1_1String.html">String</a> &target, const <a class="el" href="classTelEngine_1_1NamedList.html">NamedList</a> &params)</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_1ClientChannel.html#2245bcc7008090dfd5d201733f453847">msgProgress</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_1ClientChannel.html#07f2ebd8defa68d0c320ae09337b184a">msgRinging</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_1ClientChannel.html#60097ee73cb6411471467da98ff3c014">msgAnswered</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_1ClientChannel.html#4b96a8fd6c1dc96dbb7a3bcc31fef0ea">msgDrop</a> (<a class="el" href="classTelEngine_1_1Message.html">Message</a> &msg, const char *reason)</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_1ClientChannel.html#20af7b70238cd69c088a9a2c2f5e0117">callRouted</a> (<a class="el" href="classTelEngine_1_1Message.html">Message</a> &msg)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientChannel.html#b6196c00a7b0597032e9f05c192d184a">callAccept</a> (<a class="el" href="classTelEngine_1_1Message.html">Message</a> &msg)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientChannel.html#871ccaca4cba40444872853bacd99e3f">callRejected</a> (const char *error, const char *reason, const <a class="el" href="classTelEngine_1_1Message.html">Message</a> *msg)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientChannel.html#9017bd6ad7394096baea28d02bf61ca1">callAnswer</a> ()</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_1ClientChannel.html#bce72a4816d5d08dff32743ecce8e5ec">party</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_1ClientChannel.html#d340cb8fb9bd06a321e569e43af3e3b9">conference</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientChannel.html#c740a79f9964556107d91fa8cc922241">transferId</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1RefObject.html">RefObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientChannel.html#61560f68f3febaa92d4730dad84b8395">clientData</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientChannel.html#9de437e14f039bee0d0e22d19bbd1218">setClientData</a> (<a class="el" href="classTelEngine_1_1RefObject.html">RefObject</a> *obj=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientChannel.html#95cca47cb8024cf7c3dd41c52ee522dc">setMedia</a> (bool open=false, bool replace=false)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientChannel.html#91cfb394d8af5b3baef8bc6958a4a9f9">setActive</a> (bool active, bool update=true)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientChannel.html#71b903b5e887cfa766cd9277846be690">setTransfer</a> (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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientChannel.html#d733fd7a4be12b24567da3eafebe9126">setConference</a> (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">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientChannel.html#91c623b01d4db316ba97aea7ea964b75">peerOutFormat</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientChannel.html#e99741468e382e2b5c7db3765c9e9a9b">peerInFormat</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_1ClientChannel.html#6fd1dc792a0b98e6530a7383d4ef3074">active</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_1ClientChannel.html#f15ab718b20fdd39fb5dc43d1657b9c2">isNoticed</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientChannel.html#a04163d7d58d16a4f0f77f2fc6c63b60">noticed</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientChannel.html#a6e2444d9f9eb15566a2c8cb42e45788">line</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientChannel.html#e077c9ced45cd7b4bf959b0695a1c016">line</a> (int newLine)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientChannel.html#b669c1a7946ecc220b7f930c0d973a1d">update</a> (int notif, bool chan=true, bool updatePeer=true, const char *engineMsg=0, bool minimal=false, bool data=false)</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_1ClientChannel.html#294dc8e662984f93e79379a191b7c59a">lookup</a> (const char *notif, int def=Unknown)</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_1ClientChannel.html#b98ec4f7e0512f1c67b39dd43d47ccac">lookup</a> (int notif, const char *def=0)</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="structTelEngine_1_1TokenDict.html">TokenDict</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientChannel.html#19db15d8bcb6bcc97aabfcc97c799511">s_notification</a> []</td></tr>
<tr><td colspan="2"><br><h2>Protected 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_1ClientChannel.html#29e169c1327513d2db6127ddb301dc19">destroyed</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientChannel.html#f8eecda3d9df4ea9382b7faf58cb14c1">disconnected</a> (bool final, const char *reason)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9ee1547ca9bccf495cc85b5390256d8a"></a><!-- doxytag: member="TelEngine::ClientChannel::peerHasSource" ref="9ee1547ca9bccf495cc85b5390256d8a" args="(Message &msg)" -->
bool </td><td class="memItemRight" valign="bottom"><b>peerHasSource</b> (<a class="el" href="classTelEngine_1_1Message.html">Message</a> &msg)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="03f7a6f998e6e34ac27e3563b7114b93"></a><!-- doxytag: member="TelEngine::ClientChannel::checkSilence" ref="03f7a6f998e6e34ac27e3563b7114b93" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>checkSilence</b> ()</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="5aeb0201faab3427bcc523e53a497ef5"></a><!-- doxytag: member="TelEngine::ClientChannel::m_party" ref="5aeb0201faab3427bcc523e53a497ef5" args="" -->
<a class="el" href="classTelEngine_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><b>m_party</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1f2379d5c55fcac10f852c281d5232b0"></a><!-- doxytag: member="TelEngine::ClientChannel::m_peerOutFormat" ref="1f2379d5c55fcac10f852c281d5232b0" args="" -->
<a class="el" href="classTelEngine_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><b>m_peerOutFormat</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="67571a37a644f0c1aade13ed3223e0d6"></a><!-- doxytag: member="TelEngine::ClientChannel::m_peerInFormat" ref="67571a37a644f0c1aade13ed3223e0d6" args="" -->
<a class="el" href="classTelEngine_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><b>m_peerInFormat</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3db36cc7ab3a2e9ba908f856124ee607"></a><!-- doxytag: member="TelEngine::ClientChannel::m_reason" ref="3db36cc7ab3a2e9ba908f856124ee607" args="" -->
<a class="el" href="classTelEngine_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><b>m_reason</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="01e1b9c9d99ff20928c45a9189faced4"></a><!-- doxytag: member="TelEngine::ClientChannel::m_peerId" ref="01e1b9c9d99ff20928c45a9189faced4" args="" -->
<a class="el" href="classTelEngine_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><b>m_peerId</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ac257fb102b88b8ce4b1473b563dae27"></a><!-- doxytag: member="TelEngine::ClientChannel::m_noticed" ref="ac257fb102b88b8ce4b1473b563dae27" args="" -->
bool </td><td class="memItemRight" valign="bottom"><b>m_noticed</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="434474dfe11c603cd3512231cdaa8baa"></a><!-- doxytag: member="TelEngine::ClientChannel::m_line" ref="434474dfe11c603cd3512231cdaa8baa" args="" -->
int </td><td class="memItemRight" valign="bottom"><b>m_line</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="818d3d256cbba4f85b3a463e740f104d"></a><!-- doxytag: member="TelEngine::ClientChannel::m_active" ref="818d3d256cbba4f85b3a463e740f104d" args="" -->
bool </td><td class="memItemRight" valign="bottom"><b>m_active</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4580e2f8d23a14283b9c2926b20b6f0d"></a><!-- doxytag: member="TelEngine::ClientChannel::m_silence" ref="4580e2f8d23a14283b9c2926b20b6f0d" args="" -->
bool </td><td class="memItemRight" valign="bottom"><b>m_silence</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f4829dcbe29cb21fc2354b84553f51ff"></a><!-- doxytag: member="TelEngine::ClientChannel::m_conference" ref="f4829dcbe29cb21fc2354b84553f51ff" args="" -->
bool </td><td class="memItemRight" valign="bottom"><b>m_conference</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5c1a5c03d3dbdb640e601f0396047e72"></a><!-- doxytag: member="TelEngine::ClientChannel::m_transferId" ref="5c1a5c03d3dbdb640e601f0396047e72" args="" -->
<a class="el" href="classTelEngine_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><b>m_transferId</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="db001bd967aab061db26f096c5840869"></a><!-- doxytag: member="TelEngine::ClientChannel::m_clientData" ref="db001bd967aab061db26f096c5840869" args="" -->
<a class="el" href="classTelEngine_1_1RefObject.html">RefObject</a> * </td><td class="memItemRight" valign="bottom"><b>m_clientData</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="8135fe2ad46436f869a8670efd33d993"></a><!-- doxytag: member="TelEngine::ClientChannel::ClientDriver" ref="8135fe2ad46436f869a8670efd33d993" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>ClientDriver</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classTelEngine_1_1Channel.html" title="An abstract communication channel.">Channel</a> used by client programs.
<p>
This class implements a <a class="el" href="classTelEngine_1_1Channel.html" title="An abstract communication channel.">Channel</a> used by client programs <hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="9b7018c6a58f6d63a9446fea1f12ad89"></a><!-- doxytag: member="TelEngine::ClientChannel::Notification" ref="9b7018c6a58f6d63a9446fea1f12ad89" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classTelEngine_1_1ClientChannel.html#9b7018c6a58f6d63a9446fea1f12ad89">Notification</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<a class="el" href="classTelEngine_1_1Channel.html" title="An abstract communication channel.">Channel</a> notifications
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="6fd1dc792a0b98e6530a7383d4ef3074"></a><!-- doxytag: member="TelEngine::ClientChannel::active" ref="6fd1dc792a0b98e6530a7383d4ef3074" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool active </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if this channel is the active one <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if this channel is the active one </dd></dl>
</div>
</div><p>
<a class="anchor" name="b6196c00a7b0597032e9f05c192d184a"></a><!-- doxytag: member="TelEngine::ClientChannel::callAccept" ref="b6196c00a7b0597032e9f05c192d184a" args="(Message &msg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void callAccept </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>
Notification on success of incoming call <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>Notification call.execute message just after being dispatched </td></tr>
</table>
</dl>
<p>Reimplemented from <a class="el" href="classTelEngine_1_1Channel.html#b6196c00a7b0597032e9f05c192d184a">Channel</a>.</p>
</div>
</div><p>
<a class="anchor" name="9017bd6ad7394096baea28d02bf61ca1"></a><!-- doxytag: member="TelEngine::ClientChannel::callAnswer" ref="9017bd6ad7394096baea28d02bf61ca1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void callAnswer </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Answer an incoming call. Set media channels. Enqueue a clientchan.update message
</div>
</div><p>
<a class="anchor" name="871ccaca4cba40444872853bacd99e3f"></a><!-- doxytag: member="TelEngine::ClientChannel::callRejected" ref="871ccaca4cba40444872853bacd99e3f" args="(const char *error, const char *reason, const Message *msg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void callRejected </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>error</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>reason</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1Message.html">Message</a> * </td>
<td class="paramname"> <em>msg</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>
Notification on failure of incoming call <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>error</em> </td><td>Standard error keyword </td></tr>
<tr><td valign="top"></td><td valign="top"><em>reason</em> </td><td>Textual failure reason </td></tr>
<tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>Pointer to message causing the rejection, if any </td></tr>
</table>
</dl>
<p>Reimplemented from <a class="el" href="classTelEngine_1_1Channel.html#a1ef480b0ae6f1e48080c1787c280bf2">Channel</a>.</p>
</div>
</div><p>
<a class="anchor" name="20af7b70238cd69c088a9a2c2f5e0117"></a><!-- doxytag: member="TelEngine::ClientChannel::callRouted" ref="20af7b70238cd69c088a9a2c2f5e0117" args="(Message &msg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool callRouted </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>
Notification on progress of routing incoming call <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>Notification call.route message just after being dispatched </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True to continue with the call, false to abort the route </dd></dl>
<p>Reimplemented from <a class="el" href="classTelEngine_1_1Channel.html#20af7b70238cd69c088a9a2c2f5e0117">Channel</a>.</p>
</div>
</div><p>
<a class="anchor" name="61560f68f3febaa92d4730dad84b8395"></a><!-- doxytag: member="TelEngine::ClientChannel::clientData" ref="61560f68f3febaa92d4730dad84b8395" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1RefObject.html">RefObject</a>* clientData </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the client data <dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="classTelEngine_1_1RefObject.html">RefObject</a> pointer or 0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="d340cb8fb9bd06a321e569e43af3e3b9"></a><!-- doxytag: member="TelEngine::ClientChannel::conference" ref="d340cb8fb9bd06a321e569e43af3e3b9" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool conference </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if this channel is in conference <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if this channel is in conference </dd></dl>
</div>
</div><p>
<a class="anchor" name="29e169c1327513d2db6127ddb301dc19"></a><!-- doxytag: member="TelEngine::ClientChannel::destroyed" ref="29e169c1327513d2db6127ddb301dc19" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void destroyed </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destruct notification, performs cleanups
<p>Reimplemented from <a class="el" href="classTelEngine_1_1CallEndpoint.html#29e169c1327513d2db6127ddb301dc19">CallEndpoint</a>.</p>
</div>
</div><p>
<a class="anchor" name="f8eecda3d9df4ea9382b7faf58cb14c1"></a><!-- doxytag: member="TelEngine::ClientChannel::disconnected" ref="f8eecda3d9df4ea9382b7faf58cb14c1" args="(bool final, const char *reason)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void disconnected </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>final</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>reason</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Disconnect notification method. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>final</em> </td><td>True if this disconnect was called from the destructor. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>reason</em> </td><td>Text that describes disconnect reason. </td></tr>
</table>
</dl>
<p>Reimplemented from <a class="el" href="classTelEngine_1_1Channel.html#f8eecda3d9df4ea9382b7faf58cb14c1">Channel</a>.</p>
</div>
</div><p>
<a class="anchor" name="f15ab718b20fdd39fb5dc43d1657b9c2"></a><!-- doxytag: member="TelEngine::ClientChannel::isNoticed" ref="f15ab718b20fdd39fb5dc43d1657b9c2" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool isNoticed </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if this channel was noticed <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if this channel was noticed </dd></dl>
</div>
</div><p>
<a class="anchor" name="e077c9ced45cd7b4bf959b0695a1c016"></a><!-- doxytag: member="TelEngine::ClientChannel::line" ref="e077c9ced45cd7b4bf959b0695a1c016" args="(int newLine)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void line </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>newLine</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set this channel's 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>newLine</em> </td><td>This channel's line </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="a6e2444d9f9eb15566a2c8cb42e45788"></a><!-- doxytag: member="TelEngine::ClientChannel::line" ref="a6e2444d9f9eb15566a2c8cb42e45788" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int line </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get this channel's line <dl class="return" compact><dt><b>Returns:</b></dt><dd>This channel's line </dd></dl>
</div>
</div><p>
<a class="anchor" name="b98ec4f7e0512f1c67b39dd43d47ccac"></a><!-- doxytag: member="TelEngine::ClientChannel::lookup" ref="b98ec4f7e0512f1c67b39dd43d47ccac" args="(int notif, const char *def=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const char* lookup </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>notif</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>def</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Lookup for a notification 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>notif</em> </td><td>The notification's id </td></tr>
<tr><td valign="top"></td><td valign="top"><em>def</em> </td><td>Default value to return if not found </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The result </dd></dl>
<p>References <a class="el" href="namespaceTelEngine.html#4668c9172c6ae5f59f5782ecc6e05516">TelEngine::lookup()</a>.</p>
</div>
</div><p>
<a class="anchor" name="294dc8e662984f93e79379a191b7c59a"></a><!-- doxytag: member="TelEngine::ClientChannel::lookup" ref="294dc8e662984f93e79379a191b7c59a" args="(const char *notif, int def=Unknown)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static int lookup </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>notif</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>def</em> = <code>Unknown</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Lookup for a notification 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>notif</em> </td><td>The notification's name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>def</em> </td><td>Default value to return if not found </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The result </dd></dl>
<p>References <a class="el" href="namespaceTelEngine.html#4668c9172c6ae5f59f5782ecc6e05516">TelEngine::lookup()</a>.</p>
</div>
</div><p>
<a class="anchor" name="60097ee73cb6411471467da98ff3c014"></a><!-- doxytag: member="TelEngine::ClientChannel::msgAnswered" ref="60097ee73cb6411471467da98ff3c014" args="(Message &msg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool msgAnswered </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>
Notification on remote answered. Note that the answered flag will be set <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>Notification message </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True to stop processing the message, false to let it flow </dd></dl>
<p>Reimplemented from <a class="el" href="classTelEngine_1_1Channel.html#60097ee73cb6411471467da98ff3c014">Channel</a>.</p>
</div>
</div><p>
<a class="anchor" name="4b96a8fd6c1dc96dbb7a3bcc31fef0ea"></a><!-- doxytag: member="TelEngine::ClientChannel::msgDrop" ref="4b96a8fd6c1dc96dbb7a3bcc31fef0ea" args="(Message &msg, const char *reason)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool msgDrop </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1Message.html">Message</a> & </td>
<td class="paramname"> <em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>reason</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>
Notification on current call drop request <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>Notification message </td></tr>
<tr><td valign="top"></td><td valign="top"><em>reason</em> </td><td>Pointer to drop reason text or NULL if none provided </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if initiated call drop, false if failed </dd></dl>
<p>Reimplemented from <a class="el" href="classTelEngine_1_1Channel.html#4b96a8fd6c1dc96dbb7a3bcc31fef0ea">Channel</a>.</p>
</div>
</div><p>
<a class="anchor" name="2245bcc7008090dfd5d201733f453847"></a><!-- doxytag: member="TelEngine::ClientChannel::msgProgress" ref="2245bcc7008090dfd5d201733f453847" args="(Message &msg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool msgProgress </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>
Notification on remote call making some progress, not enabled by default <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>Notification message </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True to stop processing the message, false to let it flow </dd></dl>
<p>Reimplemented from <a class="el" href="classTelEngine_1_1Channel.html#2245bcc7008090dfd5d201733f453847">Channel</a>.</p>
</div>
</div><p>
<a class="anchor" name="07f2ebd8defa68d0c320ae09337b184a"></a><!-- doxytag: member="TelEngine::ClientChannel::msgRinging" ref="07f2ebd8defa68d0c320ae09337b184a" args="(Message &msg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool msgRinging </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>
Notification on remote ringing <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>Notification message </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True to stop processing the message, false to let it flow </dd></dl>
<p>Reimplemented from <a class="el" href="classTelEngine_1_1Channel.html#07f2ebd8defa68d0c320ae09337b184a">Channel</a>.</p>
</div>
</div><p>
<a class="anchor" name="a04163d7d58d16a4f0f77f2fc6c63b60"></a><!-- doxytag: member="TelEngine::ClientChannel::noticed" ref="a04163d7d58d16a4f0f77f2fc6c63b60" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void noticed </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Notice this channel. Enqueue a clientchan.update message
</div>
</div><p>
<a class="anchor" name="bce72a4816d5d08dff32743ecce8e5ec"></a><!-- doxytag: member="TelEngine::ClientChannel::party" ref="bce72a4816d5d08dff32743ecce8e5ec" 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>& party </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the remote party of this channel <dl class="return" compact><dt><b>Returns:</b></dt><dd>The remote party of this channel </dd></dl>
</div>
</div><p>
<a class="anchor" name="e99741468e382e2b5c7db3765c9e9a9b"></a><!-- doxytag: member="TelEngine::ClientChannel::peerInFormat" ref="e99741468e382e2b5c7db3765c9e9a9b" 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>& peerInFormat </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the peer source's data format <dl class="return" compact><dt><b>Returns:</b></dt><dd>The peer source's data format </dd></dl>
</div>
</div><p>
<a class="anchor" name="91c623b01d4db316ba97aea7ea964b75"></a><!-- doxytag: member="TelEngine::ClientChannel::peerOutFormat" ref="91c623b01d4db316ba97aea7ea964b75" 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>& peerOutFormat </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the peer consumer's data format <dl class="return" compact><dt><b>Returns:</b></dt><dd>The peer consumer's data format </dd></dl>
</div>
</div><p>
<a class="anchor" name="91cfb394d8af5b3baef8bc6958a4a9f9"></a><!-- doxytag: member="TelEngine::ClientChannel::setActive" ref="91cfb394d8af5b3baef8bc6958a4a9f9" args="(bool active, bool update=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool setActive </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>active</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>update</em> = <code>true</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set/reset this channel's data 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>active</em> </td><td>True to set active, false to set inactive (mute) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>update</em> </td><td>True to enqueue an update message </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="9de437e14f039bee0d0e22d19bbd1218"></a><!-- doxytag: member="TelEngine::ClientChannel::setClientData" ref="9de437e14f039bee0d0e22d19bbd1218" args="(RefObject *obj=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setClientData </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1RefObject.html">RefObject</a> * </td>
<td class="paramname"> <em>obj</em> = <code>0</code> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set/reset the client data. If a new client data is set its reference counter is increased <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>obj</em> </td><td>The new client data </td></tr>
</table>
</dl>
<p>References <a class="el" href="yateclass_8h-source.html#l00650">TelEngine::destruct()</a>.</p>
</div>
</div><p>
<a class="anchor" name="d733fd7a4be12b24567da3eafebe9126"></a><!-- doxytag: member="TelEngine::ClientChannel::setConference" ref="d733fd7a4be12b24567da3eafebe9126" args="(const String &target=String::empty())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setConference </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>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set/reset the conference data. Enqueue clientchan.update if changed. Open media when reset if the channel is active and answered <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>target</em> </td><td>The confeernce room's name. Leave it blank to reset </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="95cca47cb8024cf7c3dd41c52ee522dc"></a><!-- doxytag: member="TelEngine::ClientChannel::setMedia" ref="95cca47cb8024cf7c3dd41c52ee522dc" args="(bool open=false, bool replace=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool setMedia </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>open</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>replace</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Attach/detach media 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>open</em> </td><td>True to open, false to close </td></tr>
<tr><td valign="top"></td><td valign="top"><em>replace</em> </td><td>True to replace media if already open. Ignored if open 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="71b903b5e887cfa766cd9277846be690"></a><!-- doxytag: member="TelEngine::ClientChannel::setTransfer" ref="71b903b5e887cfa766cd9277846be690" args="(const String &target=String::empty())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setTransfer </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>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set/reset the transferred peer's id. Enqueue clientchan.update if changed. Open media when reset if the channel is active and answered <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>target</em> </td><td>The transferred peer's id. Leave it blank to reset </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="c740a79f9964556107d91fa8cc922241"></a><!-- doxytag: member="TelEngine::ClientChannel::transferId" ref="c740a79f9964556107d91fa8cc922241" 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>& transferId </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the transferred peer's id <dl class="return" compact><dt><b>Returns:</b></dt><dd>The transferred peer's id </dd></dl>
</div>
</div><p>
<a class="anchor" name="b669c1a7946ecc220b7f930c0d973a1d"></a><!-- doxytag: member="TelEngine::ClientChannel::update" ref="b669c1a7946ecc220b7f930c0d973a1d" args="(int notif, bool chan=true, bool updatePeer=true, const char *engineMsg=0, bool minimal=false, bool data=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void update </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>notif</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>chan</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>updatePeer</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>engineMsg</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>minimal</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>data</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Update channel. Enqueue a clientchan.update message with the given operation. Enqueue other channel status messages if required <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>notif</em> </td><td>The value of the notify parameter </td></tr>
<tr><td valign="top"></td><td valign="top"><em>chan</em> </td><td>Set the channel as message's user data </td></tr>
<tr><td valign="top"></td><td valign="top"><em>updatePeer</em> </td><td>True to update peer's data formats </td></tr>
<tr><td valign="top"></td><td valign="top"><em>engineMsg</em> </td><td>Optional message to enqueue in the engine </td></tr>
<tr><td valign="top"></td><td valign="top"><em>minimal</em> </td><td>Set to true to fill in only a minimum of engine message's parameters </td></tr>
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>Set the channel as engine message's user data </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="19db15d8bcb6bcc97aabfcc97c799511"></a><!-- doxytag: member="TelEngine::ClientChannel::s_notification" ref="19db15d8bcb6bcc97aabfcc97c799511" args="[]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structTelEngine_1_1TokenDict.html">TokenDict</a> <a class="el" href="classTelEngine_1_1ClientChannel.html#19db15d8bcb6bcc97aabfcc97c799511">s_notification</a>[]<code> [static]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<a class="el" href="classTelEngine_1_1Channel.html" title="An abstract communication channel.">Channel</a> notifications dictionary
</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
>
61
