<!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: ThreadedSource 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_1ThreadedSource.html">ThreadedSource</a>
</div>
</div>
<div class="contents">
<h1>ThreadedSource Class Reference</h1><!-- doxytag: class="TelEngine::ThreadedSource" --><!-- doxytag: inherits="TelEngine::DataSource" --><code>#include <<a class="el" href="yatephone_8h-source.html">yatephone.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for ThreadedSource:</div>
<div class="dynsection">
<p><center><img src="classTelEngine_1_1ThreadedSource.png" usemap="#ThreadedSource_map" border="0" alt=""></center>
<map name="ThreadedSource_map">
<area href="classTelEngine_1_1DataSource.html" alt="DataSource" shape="rect" coords="0,168,107,192">
<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">
</map>
</div>
<p>
<a href="classTelEngine_1_1ThreadedSource-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ThreadedSource.html#29e169c1327513d2db6127ddb301dc19">destroyed</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ThreadedSource.html#2b547282cb554abcb8f166880396edaf">start</a> (const char *name="ThreadedSource", Thread::Priority prio=Thread::Normal)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ThreadedSource.html#8c528baf37154d347366083f0f816846">stop</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1Thread.html">Thread</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ThreadedSource.html#ba333fce9c92676419fd841a5cf192b1">thread</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_1ThreadedSource.html#93abe5af6984d9ff0e8c9128cdcd846f">running</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_1ThreadedSource.html#84f6021aed33675b7e51d42ef5228c0f">asyncDelete</a> () const </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_1ThreadedSource.html#ff3189716cd1cf9016c30028aa5dc3b9">ThreadedSource</a> (const char *format="slin")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ThreadedSource.html#0e609f84189373a80aee7e50a8a58a23">asyncDelete</a> (bool async)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ThreadedSource.html#ee04af7c3fd188248b6f127689f40fc0">clearThread</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_1ThreadedSource.html#18954417d3124a8095783ea13dc6d00b">run</a> ()=0</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_1ThreadedSource.html#09f4fe805fa9a54d4d68c5b29c1502e1">cleanup</a> ()</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_1ThreadedSource.html#928bb60a116c681cfb21402ceb2cf178">zeroRefsTest</a> ()</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="443658d02a6d50d710f380fc12f39cd7"></a><!-- doxytag: member="TelEngine::ThreadedSource::ThreadedSourcePrivate" ref="443658d02a6d50d710f380fc12f39cd7" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>ThreadedSourcePrivate</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A data source with a thread of its own <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="ff3189716cd1cf9016c30028aa5dc3b9"></a><!-- doxytag: member="TelEngine::ThreadedSource::ThreadedSource" ref="ff3189716cd1cf9016c30028aa5dc3b9" args="(const char *format="slin")" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1ThreadedSource.html">ThreadedSource</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, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Threaded 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="0e609f84189373a80aee7e50a8a58a23"></a><!-- doxytag: member="TelEngine::ThreadedSource::asyncDelete" ref="0e609f84189373a80aee7e50a8a58a23" args="(bool async)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void asyncDelete </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>async</em> </td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Derived classes should call this method to let the source to be destroyed asynchronously in the data thread
</div>
</div><p>
<a class="anchor" name="84f6021aed33675b7e51d42ef5228c0f"></a><!-- doxytag: member="TelEngine::ThreadedSource::asyncDelete" ref="84f6021aed33675b7e51d42ef5228c0f" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool asyncDelete </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the current status of the asynchronous deletion flag
</div>
</div><p>
<a class="anchor" name="09f4fe805fa9a54d4d68c5b29c1502e1"></a><!-- doxytag: member="TelEngine::ThreadedSource::cleanup" ref="09f4fe805fa9a54d4d68c5b29c1502e1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void cleanup </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The cleanup after thread method, deletes the source if already dereferenced and set for asynchronous deletion
</div>
</div><p>
<a class="anchor" name="ee04af7c3fd188248b6f127689f40fc0"></a><!-- doxytag: member="TelEngine::ThreadedSource::clearThread" ref="ee04af7c3fd188248b6f127689f40fc0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void clearThread </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Clear the worker thread pointer
</div>
</div><p>
<a class="anchor" name="29e169c1327513d2db6127ddb301dc19"></a><!-- doxytag: member="TelEngine::ThreadedSource::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>
The destruction notification, stops the thread
<p>Reimplemented from <a class="el" href="classTelEngine_1_1DataSource.html#29e169c1327513d2db6127ddb301dc19">DataSource</a>.</p>
</div>
</div><p>
<a class="anchor" name="18954417d3124a8095783ea13dc6d00b"></a><!-- doxytag: member="TelEngine::ThreadedSource::run" ref="18954417d3124a8095783ea13dc6d00b" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void run </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected, pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The worker method. You have to reimplement it as you need
</div>
</div><p>
<a class="anchor" name="93abe5af6984d9ff0e8c9128cdcd846f"></a><!-- doxytag: member="TelEngine::ThreadedSource::running" ref="93abe5af6984d9ff0e8c9128cdcd846f" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool running </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if the data thread is running <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the data thread was started and is running </dd></dl>
</div>
</div><p>
<a class="anchor" name="2b547282cb554abcb8f166880396edaf"></a><!-- doxytag: member="TelEngine::ThreadedSource::start" ref="2b547282cb554abcb8f166880396edaf" args="(const char *name="ThreadedSource", Thread::Priority prio=Thread::Normal)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool start </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> = <code>"ThreadedSource"</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1Thread.html#315655b1bb5848c063491adffde62b15">Thread::Priority</a> </td>
<td class="paramname"> <em>prio</em> = <code>Thread::Normal</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Starts the worker thread <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>Static name of this thread </td></tr>
<tr><td valign="top"></td><td valign="top"><em>prio</em> </td><td>Thread's priority </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if started, false if an error occured </dd></dl>
</div>
</div><p>
<a class="anchor" name="8c528baf37154d347366083f0f816846"></a><!-- doxytag: member="TelEngine::ThreadedSource::stop" ref="8c528baf37154d347366083f0f816846" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stop </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Stops and destroys the worker thread if running
</div>
</div><p>
<a class="anchor" name="ba333fce9c92676419fd841a5cf192b1"></a><!-- doxytag: member="TelEngine::ThreadedSource::thread" ref="ba333fce9c92676419fd841a5cf192b1" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1Thread.html">Thread</a>* thread </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return a pointer to the worker thread <dl class="return" compact><dt><b>Returns:</b></dt><dd>Pointer to running worker thread or NULL </dd></dl>
</div>
</div><p>
<a class="anchor" name="928bb60a116c681cfb21402ceb2cf178"></a><!-- doxytag: member="TelEngine::ThreadedSource::zeroRefsTest" ref="928bb60a116c681cfb21402ceb2cf178" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool zeroRefsTest </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Override so destruction can be delayed after all references were lost to let the data pumping thread end normally <dl class="return" compact><dt><b>Returns:</b></dt><dd>True to delete the source right away, false to defer </dd></dl>
<p>Reimplemented from <a class="el" href="classTelEngine_1_1RefObject.html#928bb60a116c681cfb21402ceb2cf178">RefObject</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
>
604
