<!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: DataEndpoint 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_1DataEndpoint.html">DataEndpoint</a>
</div>
</div>
<div class="contents">
<h1>DataEndpoint Class Reference</h1><!-- doxytag: class="TelEngine::DataEndpoint" --><!-- doxytag: inherits="TelEngine::RefObject" -->A data transfer endpoint capable of sending and/or receiving data.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="yatephone_8h-source.html">yatephone.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for DataEndpoint:</div>
<div class="dynsection">
<p><center><img src="classTelEngine_1_1DataEndpoint.png" usemap="#DataEndpoint_map" border="0" alt=""></center>
<map name="DataEndpoint_map">
<area href="classTelEngine_1_1RefObject.html" alt="RefObject" shape="rect" coords="0,56,87,80">
<area href="classTelEngine_1_1GenObject.html" alt="GenObject" shape="rect" coords="0,0,87,24">
</map>
</div>
<p>
<a href="classTelEngine_1_1DataEndpoint-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DataEndpoint.html#a9ecc3d7fcd5ea2db40b47a44e16e68e">DataEndpoint</a> (<a class="el" href="classTelEngine_1_1CallEndpoint.html">CallEndpoint</a> *call=0, const char *name="audio")</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_1DataEndpoint.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_1DataEndpoint.html#aa71c3294b1a073c3ad0b64a2ed6325a">getObject</a> (const <a class="el" href="classTelEngine_1_1String.html">String</a> &name) const </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_1DataEndpoint.html#4a7bd56fb99593ace9379ed699f2719c">toString</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1Mutex.html">Mutex</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DataEndpoint.html#3d26fc896be392fd5960ea007801daaf">mutex</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_1DataEndpoint.html#fe2c7fbc2e5c3f400dcfd88b9e1038b4">connect</a> (<a class="el" href="classTelEngine_1_1DataEndpoint.html">DataEndpoint</a> *peer)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DataEndpoint.html#12db172f74059f7eceb63714f4589aa0">disconnect</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DataEndpoint.html#9fe4c3ac423f0ef339824b04642c5b31">setSource</a> (<a class="el" href="classTelEngine_1_1DataSource.html">DataSource</a> *source=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1DataSource.html">DataSource</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DataEndpoint.html#919df595113c1641fc18bf4834d54829">getSource</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_1DataEndpoint.html#3e0400819612c63f5f7c230b07aacba3">setConsumer</a> (<a class="el" href="classTelEngine_1_1DataConsumer.html">DataConsumer</a> *consumer=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1DataConsumer.html">DataConsumer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DataEndpoint.html#065a6e75b080e50835cc28b75285529e">getConsumer</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_1DataEndpoint.html#c614f928f268238e861483890b82a638">setPeerRecord</a> (<a class="el" href="classTelEngine_1_1DataConsumer.html">DataConsumer</a> *consumer=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1DataConsumer.html">DataConsumer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DataEndpoint.html#fdd4f65f3c22466ae4c89fd905645084">getPeerRecord</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_1DataEndpoint.html#5fc11bcd2d359aa0ec5a7adc4ec8893e">setCallRecord</a> (<a class="el" href="classTelEngine_1_1DataConsumer.html">DataConsumer</a> *consumer=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1DataConsumer.html">DataConsumer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DataEndpoint.html#f558f072157b47ea864984c372b14289">getCallRecord</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_1DataEndpoint.html#2027e61461126a21e78128edcd77110a">addSniffer</a> (<a class="el" href="classTelEngine_1_1DataConsumer.html">DataConsumer</a> *sniffer)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DataEndpoint.html#0faeefdee7e4b233d5854b3ddff6be8a">delSniffer</a> (<a class="el" href="classTelEngine_1_1DataConsumer.html">DataConsumer</a> *sniffer)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1DataConsumer.html">DataConsumer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DataEndpoint.html#b4856d98ec1cee083b727e868f0c4d06">getSniffer</a> (const <a class="el" href="classTelEngine_1_1String.html">String</a> &name)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DataEndpoint.html#63626927ac903c1bfdfb09037cfa6cd9">clearSniffers</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1DataEndpoint.html">DataEndpoint</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DataEndpoint.html#19838176eb68d1347182e02b2d2faa29">getPeer</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1CallEndpoint.html">CallEndpoint</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DataEndpoint.html#fdcf554cb55d9d25dd45edba3e05777d">getCall</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_1DataEndpoint.html#b31e7357671cfe484e3c3ed3cd6258e4">name</a> () const </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_1DataEndpoint.html#fc0eec9fbf964c2e6f5ed69ff77fdb52">control</a> (<a class="el" href="classTelEngine_1_1NamedList.html">NamedList</a> &params)</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_1Mutex.html">Mutex</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DataEndpoint.html#93caa25821e4b7c87e73ad808f31b9ac">commonMutex</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 bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DataEndpoint.html#4eb6fb0e79eca2b38264802ce0e59073">nativeConnect</a> (<a class="el" href="classTelEngine_1_1DataEndpoint.html">DataEndpoint</a> *peer)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A data transfer endpoint capable of sending and/or receiving data.
<p>
The <a class="el" href="classTelEngine_1_1DataEndpoint.html" title="A data transfer endpoint capable of sending and/or receiving data.">DataEndpoint</a> holds an endpoint capable of performing unidirectional or bidirectional data transfers <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="a9ecc3d7fcd5ea2db40b47a44e16e68e"></a><!-- doxytag: member="TelEngine::DataEndpoint::DataEndpoint" ref="a9ecc3d7fcd5ea2db40b47a44e16e68e" args="(CallEndpoint *call=0, const char *name="audio")" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1DataEndpoint.html">DataEndpoint</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1CallEndpoint.html">CallEndpoint</a> * </td>
<td class="paramname"> <em>call</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> = <code>"audio"</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates an empty data endpoint
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="2027e61461126a21e78128edcd77110a"></a><!-- doxytag: member="TelEngine::DataEndpoint::addSniffer" ref="2027e61461126a21e78128edcd77110a" args="(DataConsumer *sniffer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool addSniffer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1DataConsumer.html">DataConsumer</a> * </td>
<td class="paramname"> <em>sniffer</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Adds a data consumer to the list of sniffers of the local call data <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>sniffer</em> </td><td>Pointer to the <a class="el" href="classTelEngine_1_1DataConsumer.html">DataConsumer</a> to add to sniffer list </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the sniffer was added to list, false if NULL or already added </dd></dl>
</div>
</div><p>
<a class="anchor" name="63626927ac903c1bfdfb09037cfa6cd9"></a><!-- doxytag: member="TelEngine::DataEndpoint::clearSniffers" ref="63626927ac903c1bfdfb09037cfa6cd9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void clearSniffers </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Removes all sniffers from the list and dereferences them
</div>
</div><p>
<a class="anchor" name="93caa25821e4b7c87e73ad808f31b9ac"></a><!-- doxytag: member="TelEngine::DataEndpoint::commonMutex" ref="93caa25821e4b7c87e73ad808f31b9ac" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classTelEngine_1_1Mutex.html">Mutex</a>& commonMutex </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the big mutex that serializes access to all data endpoints <dl class="return" compact><dt><b>Returns:</b></dt><dd>A reference to the mutex </dd></dl>
</div>
</div><p>
<a class="anchor" name="fe2c7fbc2e5c3f400dcfd88b9e1038b4"></a><!-- doxytag: member="TelEngine::DataEndpoint::connect" ref="fe2c7fbc2e5c3f400dcfd88b9e1038b4" args="(DataEndpoint *peer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool connect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1DataEndpoint.html">DataEndpoint</a> * </td>
<td class="paramname"> <em>peer</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Connect the source and consumer of the endpoint to a peer <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>Pointer to the peer data endpoint </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if connected, false if incompatible source/consumer </dd></dl>
</div>
</div><p>
<a class="anchor" name="fc0eec9fbf964c2e6f5ed69ff77fdb52"></a><!-- doxytag: member="TelEngine::DataEndpoint::control" ref="fc0eec9fbf964c2e6f5ed69ff77fdb52" args="(NamedList &params)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool control </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1NamedList.html">NamedList</a> & </td>
<td class="paramname"> <em>params</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Modify data parameters <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>params</em> </td><td>The list of parameters to change </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if processed </dd></dl>
</div>
</div><p>
<a class="anchor" name="0faeefdee7e4b233d5854b3ddff6be8a"></a><!-- doxytag: member="TelEngine::DataEndpoint::delSniffer" ref="0faeefdee7e4b233d5854b3ddff6be8a" args="(DataConsumer *sniffer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool delSniffer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1DataConsumer.html">DataConsumer</a> * </td>
<td class="paramname"> <em>sniffer</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove a data consumer from the list of sniffers of the local call data <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>sniffer</em> </td><td>Pointer to the <a class="el" href="classTelEngine_1_1DataConsumer.html">DataConsumer</a> to remove from sniffer list </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the sniffer was removed from list </dd></dl>
</div>
</div><p>
<a class="anchor" name="29e169c1327513d2db6127ddb301dc19"></a><!-- doxytag: member="TelEngine::DataEndpoint::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> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Endpoint destruct notification, clears source and consumer
<p>Reimplemented from <a class="el" href="classTelEngine_1_1RefObject.html#29e169c1327513d2db6127ddb301dc19">RefObject</a>.</p>
</div>
</div><p>
<a class="anchor" name="12db172f74059f7eceb63714f4589aa0"></a><!-- doxytag: member="TelEngine::DataEndpoint::disconnect" ref="12db172f74059f7eceb63714f4589aa0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool disconnect </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Disconnect from the connected endpoint <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the object was deleted, false if it still exists </dd></dl>
</div>
</div><p>
<a class="anchor" name="fdcf554cb55d9d25dd45edba3e05777d"></a><!-- doxytag: member="TelEngine::DataEndpoint::getCall" ref="fdcf554cb55d9d25dd45edba3e05777d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1CallEndpoint.html">CallEndpoint</a>* getCall </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a pointer to the owner call <dl class="return" compact><dt><b>Returns:</b></dt><dd>A pointer to the owner call or NULL </dd></dl>
</div>
</div><p>
<a class="anchor" name="f558f072157b47ea864984c372b14289"></a><!-- doxytag: member="TelEngine::DataEndpoint::getCallRecord" ref="f558f072157b47ea864984c372b14289" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1DataConsumer.html">DataConsumer</a>* getCallRecord </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the data consumer used for recording local call generated data. <dl class="return" compact><dt><b>Returns:</b></dt><dd>A pointer to the <a class="el" href="classTelEngine_1_1DataConsumer.html">DataConsumer</a> object or NULL </dd></dl>
</div>
</div><p>
<a class="anchor" name="065a6e75b080e50835cc28b75285529e"></a><!-- doxytag: member="TelEngine::DataEndpoint::getConsumer" ref="065a6e75b080e50835cc28b75285529e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1DataConsumer.html">DataConsumer</a>* getConsumer </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the data consumer of this object <dl class="return" compact><dt><b>Returns:</b></dt><dd>A pointer to the <a class="el" href="classTelEngine_1_1DataConsumer.html">DataConsumer</a> object or NULL </dd></dl>
</div>
</div><p>
<a class="anchor" name="aa71c3294b1a073c3ad0b64a2ed6325a"></a><!-- doxytag: member="TelEngine::DataEndpoint::getObject" ref="aa71c3294b1a073c3ad0b64a2ed6325a" args="(const String &name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void* getObject </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a pointer to a derived class given that class name <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name of the class we are asking for </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Pointer to the requested class or NULL if this object doesn't implement it </dd></dl>
<p>Reimplemented from <a class="el" href="classTelEngine_1_1GenObject.html#aa71c3294b1a073c3ad0b64a2ed6325a">GenObject</a>.</p>
</div>
</div><p>
<a class="anchor" name="19838176eb68d1347182e02b2d2faa29"></a><!-- doxytag: member="TelEngine::DataEndpoint::getPeer" ref="19838176eb68d1347182e02b2d2faa29" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1DataEndpoint.html">DataEndpoint</a>* getPeer </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a pointer to the peer endpoint <dl class="return" compact><dt><b>Returns:</b></dt><dd>A pointer to the peer endpoint or NULL </dd></dl>
</div>
</div><p>
<a class="anchor" name="fdd4f65f3c22466ae4c89fd905645084"></a><!-- doxytag: member="TelEngine::DataEndpoint::getPeerRecord" ref="fdd4f65f3c22466ae4c89fd905645084" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1DataConsumer.html">DataConsumer</a>* getPeerRecord </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the data consumer used for recording peer generated data. <dl class="return" compact><dt><b>Returns:</b></dt><dd>A pointer to the <a class="el" href="classTelEngine_1_1DataConsumer.html">DataConsumer</a> object or NULL </dd></dl>
</div>
</div><p>
<a class="anchor" name="b4856d98ec1cee083b727e868f0c4d06"></a><!-- doxytag: member="TelEngine::DataEndpoint::getSniffer" ref="b4856d98ec1cee083b727e868f0c4d06" args="(const String &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1DataConsumer.html">DataConsumer</a>* getSniffer </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Find a sniffer by name <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name of the sniffer to find </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Pointer to <a class="el" href="classTelEngine_1_1DataConsumer.html">DataConsumer</a> or NULL if not found </dd></dl>
</div>
</div><p>
<a class="anchor" name="919df595113c1641fc18bf4834d54829"></a><!-- doxytag: member="TelEngine::DataEndpoint::getSource" ref="919df595113c1641fc18bf4834d54829" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1DataSource.html">DataSource</a>* getSource </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the data source of this object <dl class="return" compact><dt><b>Returns:</b></dt><dd>A pointer to the <a class="el" href="classTelEngine_1_1DataSource.html">DataSource</a> object or NULL </dd></dl>
</div>
</div><p>
<a class="anchor" name="3d26fc896be392fd5960ea007801daaf"></a><!-- doxytag: member="TelEngine::DataEndpoint::mutex" ref="3d26fc896be392fd5960ea007801daaf" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1Mutex.html">Mutex</a>* mutex </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the mutex that serializes access to this data endpoint, if any <dl class="return" compact><dt><b>Returns:</b></dt><dd>Pointer to the call's mutex object or NULL </dd></dl>
</div>
</div><p>
<a class="anchor" name="b31e7357671cfe484e3c3ed3cd6258e4"></a><!-- doxytag: member="TelEngine::DataEndpoint::name" ref="b31e7357671cfe484e3c3ed3cd6258e4" 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>& name </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 set in constructor <dl class="return" compact><dt><b>Returns:</b></dt><dd>A reference to the name as hashed string </dd></dl>
</div>
</div><p>
<a class="anchor" name="4eb6fb0e79eca2b38264802ce0e59073"></a><!-- doxytag: member="TelEngine::DataEndpoint::nativeConnect" ref="4eb6fb0e79eca2b38264802ce0e59073" args="(DataEndpoint *peer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool nativeConnect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1DataEndpoint.html">DataEndpoint</a> * </td>
<td class="paramname"> <em>peer</em> </td>
<td> ) </td>
<td><code> [inline, protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Attempt to connect the endpoint to a peer of the same type <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>Pointer to the endpoint data driver </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if connected, false if failed native connection </dd></dl>
</div>
</div><p>
<a class="anchor" name="5fc11bcd2d359aa0ec5a7adc4ec8893e"></a><!-- doxytag: member="TelEngine::DataEndpoint::setCallRecord" ref="5fc11bcd2d359aa0ec5a7adc4ec8893e" args="(DataConsumer *consumer=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setCallRecord </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1DataConsumer.html">DataConsumer</a> * </td>
<td class="paramname"> <em>consumer</em> = <code>0</code> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the data consumer for recording local call generated data This will be connected to the local data source. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>consumer</em> </td><td>A pointer to the new consumer or NULL </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="3e0400819612c63f5f7c230b07aacba3"></a><!-- doxytag: member="TelEngine::DataEndpoint::setConsumer" ref="3e0400819612c63f5f7c230b07aacba3" args="(DataConsumer *consumer=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setConsumer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1DataConsumer.html">DataConsumer</a> * </td>
<td class="paramname"> <em>consumer</em> = <code>0</code> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the data consumer of this object <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>consumer</em> </td><td>A pointer to the new consumer or NULL </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="c614f928f268238e861483890b82a638"></a><!-- doxytag: member="TelEngine::DataEndpoint::setPeerRecord" ref="c614f928f268238e861483890b82a638" args="(DataConsumer *consumer=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setPeerRecord </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1DataConsumer.html">DataConsumer</a> * </td>
<td class="paramname"> <em>consumer</em> = <code>0</code> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the data consumer for recording peer generated data. This will be connected to the peer data source. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>consumer</em> </td><td>A pointer to the new consumer or NULL </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="9fe4c3ac423f0ef339824b04642c5b31"></a><!-- doxytag: member="TelEngine::DataEndpoint::setSource" ref="9fe4c3ac423f0ef339824b04642c5b31" args="(DataSource *source=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setSource </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1DataSource.html">DataSource</a> * </td>
<td class="paramname"> <em>source</em> = <code>0</code> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the data source of this object <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>A pointer to the new source or NULL </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="4a7bd56fb99593ace9379ed699f2719c"></a><!-- doxytag: member="TelEngine::DataEndpoint::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> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a string identification of the endpoint <dl class="return" compact><dt><b>Returns:</b></dt><dd>A reference to this endpoint's name </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="yatephone_8h-source.html">yatephone.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Dec 7 21:36:12 2008 for Yate by
<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
>
88
