<!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: ChanAssist 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_1ChanAssist.html">ChanAssist</a>
</div>
</div>
<div class="contents">
<h1>ChanAssist Class Reference</h1><!-- doxytag: class="TelEngine::ChanAssist" --><!-- doxytag: inherits="TelEngine::RefObject" --><code>#include <<a class="el" href="yatepbx_8h-source.html">yatepbx.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for ChanAssist:</div>
<div class="dynsection">
<p><center><img src="classTelEngine_1_1ChanAssist.png" usemap="#ChanAssist_map" border="0" alt=""></center>
<map name="ChanAssist_map">
<area href="classTelEngine_1_1RefObject.html" alt="RefObject" shape="rect" coords="0,56,75,80">
<area href="classTelEngine_1_1GenObject.html" alt="GenObject" shape="rect" coords="0,0,75,24">
</map>
</div>
<p>
<a href="classTelEngine_1_1ChanAssist-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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ChanAssist.html#5b5da68bb42055ab8881da0b038d9e3a">~ChanAssist</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ChanAssist.html#4a7bd56fb99593ace9379ed699f2719c">toString</a> () const </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_1ChanAssist.html#08a8661e6a6592f8d0f931851a1efa52">msgStartup</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_1ChanAssist.html#7d267a9678db455fb73d8dc0dd92b7d6">msgHangup</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_1ChanAssist.html#b5892a78eb432a355e4041789812c428">msgExecute</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_1ChanAssist.html#469683ef7be42adf37962b4c49993371">msgDisconnect</a> (<a class="el" href="classTelEngine_1_1Message.html">Message</a> &msg, const <a class="el" href="classTelEngine_1_1String.html">String</a> &reason)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1ChanAssistList.html">ChanAssistList</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ChanAssist.html#8796aeecc0233bd722d0bf6a78eb9d5c">list</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_1ChanAssist.html#e537a056a2d8316444575696aa701bbd">id</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1RefPointer.html">RefPointer</a>< <a class="el" href="classTelEngine_1_1CallEndpoint.html">CallEndpoint</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ChanAssist.html#214dd268af691f4daa3c48f0ff9bb412">locate</a> () const </td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classTelEngine_1_1RefPointer.html">RefPointer</a>< <a class="el" href="classTelEngine_1_1CallEndpoint.html">CallEndpoint</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ChanAssist.html#620c64e6d6b5de98c7360d1253c8e3fc">locate</a> (const <a class="el" href="classTelEngine_1_1String.html">String</a> &id)</td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ChanAssist.html#9d2643edcf62c46edd920395380e6c85">ChanAssist</a> (<a class="el" href="classTelEngine_1_1ChanAssistList.html">ChanAssistList</a> *list, const <a class="el" href="classTelEngine_1_1String.html">String</a> &id)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Object that assists a channel <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="5b5da68bb42055ab8881da0b038d9e3a"></a><!-- doxytag: member="TelEngine::ChanAssist::~ChanAssist" ref="5b5da68bb42055ab8881da0b038d9e3a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ~<a class="el" href="classTelEngine_1_1ChanAssist.html">ChanAssist</a> </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor
</div>
</div><p>
<a class="anchor" name="9d2643edcf62c46edd920395380e6c85"></a><!-- doxytag: member="TelEngine::ChanAssist::ChanAssist" ref="9d2643edcf62c46edd920395380e6c85" args="(ChanAssistList *list, const String &id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1ChanAssist.html">ChanAssist</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1ChanAssistList.html">ChanAssistList</a> * </td>
<td class="paramname"> <em>list</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>id</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor of base class <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>list</em> </td><td><a class="el" href="classTelEngine_1_1ChanAssistList.html">ChanAssistList</a> that owns this object </td></tr>
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>Identifier of the assisted channel </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e537a056a2d8316444575696aa701bbd"></a><!-- doxytag: member="TelEngine::ChanAssist::id" ref="e537a056a2d8316444575696aa701bbd" 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>& id </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the name of the assisted channel <dl class="return" compact><dt><b>Returns:</b></dt><dd>Identifier of the channel </dd></dl>
</div>
</div><p>
<a class="anchor" name="8796aeecc0233bd722d0bf6a78eb9d5c"></a><!-- doxytag: member="TelEngine::ChanAssist::list" ref="8796aeecc0233bd722d0bf6a78eb9d5c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1ChanAssistList.html">ChanAssistList</a>* list </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrive the list that owns this object <dl class="return" compact><dt><b>Returns:</b></dt><dd>Pointer to the owner list </dd></dl>
</div>
</div><p>
<a class="anchor" name="214dd268af691f4daa3c48f0ff9bb412"></a><!-- doxytag: member="TelEngine::ChanAssist::locate" ref="214dd268af691f4daa3c48f0ff9bb412" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1RefPointer.html">RefPointer</a><<a class="el" href="classTelEngine_1_1CallEndpoint.html">CallEndpoint</a>> locate </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrive a smart pointer to the assisted channel <dl class="return" compact><dt><b>Returns:</b></dt><dd>Smart pointer to the channel or NULL if not found or dead </dd></dl>
<p>References <a class="el" href="yatepbx_8h-source.html#l00199">ChanAssist::locate()</a>.</p>
<p>Referenced by <a class="el" href="yatepbx_8h-source.html#l00199">ChanAssist::locate()</a>.</p>
</div>
</div><p>
<a class="anchor" name="620c64e6d6b5de98c7360d1253c8e3fc"></a><!-- doxytag: member="TelEngine::ChanAssist::locate" ref="620c64e6d6b5de98c7360d1253c8e3fc" args="(const String &id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classTelEngine_1_1RefPointer.html">RefPointer</a><<a class="el" href="classTelEngine_1_1CallEndpoint.html">CallEndpoint</a>> locate </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>
Retrive a smart pointer to an arbitrary 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>Identifier of the channel to locate </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Smart pointer to the channel or NULL if not found or dead </dd></dl>
</div>
</div><p>
<a class="anchor" name="469683ef7be42adf37962b4c49993371"></a><!-- doxytag: member="TelEngine::ChanAssist::msgDisconnect" ref="469683ef7be42adf37962b4c49993371" args="(Message &msg, const String &reason)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool msgDisconnect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1Message.html">Message</a> & </td>
<td class="paramname"> <em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>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>
Process the channel disconnect message, may connect to something else <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 chan.disconnected message </td></tr>
<tr><td valign="top"></td><td valign="top"><em>reason</em> </td><td>The disconnection reason </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="b5892a78eb432a355e4041789812c428"></a><!-- doxytag: member="TelEngine::ChanAssist::msgExecute" ref="b5892a78eb432a355e4041789812c428" args="(Message &msg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void 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>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Process the call.execute message, copy any parameters needed later <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, may be received before chan.startup </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="7d267a9678db455fb73d8dc0dd92b7d6"></a><!-- doxytag: member="TelEngine::ChanAssist::msgHangup" ref="7d267a9678db455fb73d8dc0dd92b7d6" args="(Message &msg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void msgHangup </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>
Process the chan.hangup message <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>Last channel message </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="08a8661e6a6592f8d0f931851a1efa52"></a><!-- doxytag: member="TelEngine::ChanAssist::msgStartup" ref="08a8661e6a6592f8d0f931851a1efa52" args="(Message &msg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void msgStartup </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>
Process the chan.startup message <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>First channel message, may be received after call.execute </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="4a7bd56fb99593ace9379ed699f2719c"></a><!-- doxytag: member="TelEngine::ChanAssist::toString" ref="4a7bd56fb99593ace9379ed699f2719c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classTelEngine_1_1String.html">String</a>& toString </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the <a class="el" href="classTelEngine_1_1String.html" title="A C-style string handling class.">String</a> value of this object <dl class="return" compact><dt><b>Returns:</b></dt><dd>ID of the assisted channel </dd></dl>
<p>Reimplemented from <a class="el" href="classTelEngine_1_1GenObject.html#4a7bd56fb99593ace9379ed699f2719c">GenObject</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="yatepbx_8h-source.html">yatepbx.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Dec 7 21:36:13 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
>
43
