<!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: DataSource 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_1DataSource.html">DataSource</a>
</div>
</div>
<div class="contents">
<h1>DataSource Class Reference</h1><!-- doxytag: class="TelEngine::DataSource" --><!-- doxytag: inherits="TelEngine::DataNode" --><code>#include <<a class="el" href="yatephone_8h-source.html">yatephone.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for DataSource:</div>
<div class="dynsection">
<p><center><img src="classTelEngine_1_1DataSource.png" usemap="#DataSource_map" border="0" alt=""></center>
<map name="DataSource_map">
<area href="classTelEngine_1_1DataNode.html" alt="DataNode" shape="rect" coords="0,112,107,136">
<area href="classTelEngine_1_1RefObject.html" alt="RefObject" shape="rect" coords="0,56,107,80">
<area href="classTelEngine_1_1GenObject.html" alt="GenObject" shape="rect" coords="0,0,107,24">
<area href="classTelEngine_1_1ThreadedSource.html" alt="ThreadedSource" shape="rect" coords="0,224,107,248">
</map>
</div>
<p>
<a href="classTelEngine_1_1DataSource-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_1DataSource.html#f2146e0685f5f9fe701dc6cf5e0c87f5">DataSource</a> (const char *format="slin")</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_1DataSource.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_1DataSource.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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DataSource.html#eaa1bd2b8392f55c96875aaa0782ef75">Forward</a> (const <a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> &data, unsigned long tStamp=invalidStamp())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DataSource.html#831006b73708c7cba08800e8b34c495f">attach</a> (<a class="el" href="classTelEngine_1_1DataConsumer.html">DataConsumer</a> *consumer, bool override=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_1DataSource.html#93d96b2fea4e3010e7e794bb991a2909">detach</a> (<a class="el" href="classTelEngine_1_1DataConsumer.html">DataConsumer</a> *consumer)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DataSource.html#c8bb3912a3ce86b15842e79d0b421204">clear</a> ()</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_1DataSource.html#aa3ff3c344379ebab5b3160a479aba57">mutex</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1DataTranslator.html">DataTranslator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DataSource.html#9b44a68bf863a4928bc10cd31a3b7c65">getTranslator</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_1DataSource.html#021b1ec5c495c746eb818c97926e2978">synchronize</a> (unsigned long tStamp)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DataSource.html#ce88fc8124ca6af0ebd6abca18ae2ce4">nextStamp</a> () const </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="511871998ef4e5d0c36e1c68bb0565c3"></a><!-- doxytag: member="TelEngine::DataSource::m_nextStamp" ref="511871998ef4e5d0c36e1c68bb0565c3" args="" -->
unsigned long </td><td class="memItemRight" valign="bottom"><b>m_nextStamp</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ee6cedd1c092853ee2509314f36c789e"></a><!-- doxytag: member="TelEngine::DataSource::m_translator" ref="ee6cedd1c092853ee2509314f36c789e" args="" -->
<a class="el" href="classTelEngine_1_1DataTranslator.html">DataTranslator</a> * </td><td class="memItemRight" valign="bottom"><b>m_translator</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d10d34cbaa7bca76992441d229e191c3"></a><!-- doxytag: member="TelEngine::DataSource::m_consumers" ref="d10d34cbaa7bca76992441d229e191c3" args="" -->
<a class="el" href="classTelEngine_1_1ObjList.html">ObjList</a> </td><td class="memItemRight" valign="bottom"><b>m_consumers</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="71aaf23d91d7b7a5611738c4f06e3577"></a><!-- doxytag: member="TelEngine::DataSource::m_mutex" ref="71aaf23d91d7b7a5611738c4f06e3577" args="" -->
<a class="el" href="classTelEngine_1_1Mutex.html">Mutex</a> </td><td class="memItemRight" valign="bottom"><b>m_mutex</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="85a76bca8f319d6890311c7ef97be0ba"></a><!-- doxytag: member="TelEngine::DataSource::DataTranslator" ref="85a76bca8f319d6890311c7ef97be0ba" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>DataTranslator</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A data source <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="f2146e0685f5f9fe701dc6cf5e0c87f5"></a><!-- doxytag: member="TelEngine::DataSource::DataSource" ref="f2146e0685f5f9fe701dc6cf5e0c87f5" args="(const char *format="slin")" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1DataSource.html">DataSource</a> </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>format</em> = <code>"slin"</code> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Source constructor <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>format</em> </td><td>Name of the data format, default "slin" (Signed Linear) </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="831006b73708c7cba08800e8b34c495f"></a><!-- doxytag: member="TelEngine::DataSource::attach" ref="831006b73708c7cba08800e8b34c495f" args="(DataConsumer *consumer, bool override=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool attach </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1DataConsumer.html">DataConsumer</a> * </td>
<td class="paramname"> <em>consumer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>override</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 a data 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>consumer</em> </td><td>Data consumer to attach </td></tr>
<tr><td valign="top"></td><td valign="top"><em>override</em> </td><td>Attach as temporary source override </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True on success, false on failure </dd></dl>
</div>
</div><p>
<a class="anchor" name="c8bb3912a3ce86b15842e79d0b421204"></a><!-- doxytag: member="TelEngine::DataSource::clear" ref="c8bb3912a3ce86b15842e79d0b421204" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void clear </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Detach all data consumers
</div>
</div><p>
<a class="anchor" name="29e169c1327513d2db6127ddb301dc19"></a><!-- doxytag: member="TelEngine::DataSource::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>
Source's destruct notification - detaches all consumers
<p>Reimplemented from <a class="el" href="classTelEngine_1_1RefObject.html#29e169c1327513d2db6127ddb301dc19">RefObject</a>.</p>
<p>Reimplemented in <a class="el" href="classTelEngine_1_1ThreadedSource.html#29e169c1327513d2db6127ddb301dc19">ThreadedSource</a>.</p>
</div>
</div><p>
<a class="anchor" name="93d96b2fea4e3010e7e794bb991a2909"></a><!-- doxytag: member="TelEngine::DataSource::detach" ref="93d96b2fea4e3010e7e794bb991a2909" args="(DataConsumer *consumer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool detach </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1DataConsumer.html">DataConsumer</a> * </td>
<td class="paramname"> <em>consumer</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Detach a data 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>consumer</em> </td><td>Data consumer to detach </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True on success, false on failure </dd></dl>
</div>
</div><p>
<a class="anchor" name="eaa1bd2b8392f55c96875aaa0782ef75"></a><!-- doxytag: member="TelEngine::DataSource::Forward" ref="eaa1bd2b8392f55c96875aaa0782ef75" args="(const DataBlock &data, unsigned long tStamp=invalidStamp())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Forward </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> & </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"> <em>tStamp</em> = <code>invalidStamp()</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Forwards the data to its consumers <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>The raw data block to forward; an empty block ends data </td></tr>
<tr><td valign="top"></td><td valign="top"><em>tStamp</em> </td><td>Timestamp of data - typically samples </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="aa71c3294b1a073c3ad0b64a2ed6325a"></a><!-- doxytag: member="TelEngine::DataSource::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="9b44a68bf863a4928bc10cd31a3b7c65"></a><!-- doxytag: member="TelEngine::DataSource::getTranslator" ref="9b44a68bf863a4928bc10cd31a3b7c65" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1DataTranslator.html">DataTranslator</a>* getTranslator </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the master translator object if this source is part of a translator <dl class="return" compact><dt><b>Returns:</b></dt><dd>A pointer to the <a class="el" href="classTelEngine_1_1DataTranslator.html" title="An unidirectional data translator (codec).">DataTranslator</a> object or NULL </dd></dl>
</div>
</div><p>
<a class="anchor" name="aa3ff3c344379ebab5b3160a479aba57"></a><!-- doxytag: member="TelEngine::DataSource::mutex" ref="aa3ff3c344379ebab5b3160a479aba57" args="()" -->
<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><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the mutex that serializes access to this data source <dl class="return" compact><dt><b>Returns:</b></dt><dd>Pointer to DataSource's mutex object </dd></dl>
</div>
</div><p>
<a class="anchor" name="ce88fc8124ca6af0ebd6abca18ae2ce4"></a><!-- doxytag: member="TelEngine::DataSource::nextStamp" ref="ce88fc8124ca6af0ebd6abca18ae2ce4" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned long nextStamp </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the next expected position in the data stream <dl class="return" compact><dt><b>Returns:</b></dt><dd>Timestamp of next expected data position, may be invalid/unknown </dd></dl>
</div>
</div><p>
<a class="anchor" name="021b1ec5c495c746eb818c97926e2978"></a><!-- doxytag: member="TelEngine::DataSource::synchronize" ref="021b1ec5c495c746eb818c97926e2978" args="(unsigned long tStamp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void synchronize </td>
<td>(</td>
<td class="paramtype">unsigned long </td>
<td class="paramname"> <em>tStamp</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Synchronize the source and attached consumers with another timestamp <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>tStamp</em> </td><td>New timestamp of data - typically samples </td></tr>
</table>
</dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="yatephone_8h-source.html">yatephone.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Dec 7 21:36:12 2008 for Yate by
<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
>
97
