<!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: Router 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_1Router.html">Router</a>
</div>
</div>
<div class="contents">
<h1>Router Class Reference</h1><!-- doxytag: class="TelEngine::Router" --><!-- doxytag: inherits="TelEngine::Thread" -->Call routing thread.
<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 Router:</div>
<div class="dynsection">
<p><center><img src="classTelEngine_1_1Router.png" usemap="#Router_map" border="0" alt=""></center>
<map name="Router_map">
<area href="classTelEngine_1_1Thread.html" alt="Thread" shape="rect" coords="0,56,65,80">
<area href="classTelEngine_1_1Runnable.html" alt="Runnable" shape="rect" coords="0,0,65,24">
</map>
</div>
<p>
<a href="classTelEngine_1_1Router-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_1Router.html#80693483a08500e2e860b1ed254f3ad2">Router</a> (<a class="el" href="classTelEngine_1_1Driver.html">Driver</a> *driver, const char *id, <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_1Router.html#72fcb26a14f6beb1c3fbace9ab3e7dbb">run</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_1Router.html#001a86bd4538de67471ec4965f845aa9">route</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_1Router.html#09f4fe805fa9a54d4d68c5b29c1502e1">cleanup</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></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_1Router.html#e537a056a2d8316444575696aa701bbd">id</a> () const </td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Call routing thread.
<p>
Asynchronous call routing thread <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="80693483a08500e2e860b1ed254f3ad2"></a><!-- doxytag: member="TelEngine::Router::Router" ref="80693483a08500e2e860b1ed254f3ad2" args="(Driver *driver, const char *id, Message *msg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1Router.html">Router</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1Driver.html">Driver</a> * </td>
<td class="paramname"> <em>driver</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></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>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor - creates a new routing 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>driver</em> </td><td>Pointer to the driver that asked for routing </td></tr>
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>Unique identifier of the channel being routed </td></tr>
<tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>Pointer to an already filled message </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="09f4fe805fa9a54d4d68c5b29c1502e1"></a><!-- doxytag: member="TelEngine::Router::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> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<a class="el" href="classTelEngine_1_1Thread.html" title="Thread support class.">Thread</a> cleanup handler
<p>Reimplemented from <a class="el" href="classTelEngine_1_1Thread.html#09f4fe805fa9a54d4d68c5b29c1502e1">Thread</a>.</p>
</div>
</div><p>
<a class="anchor" name="e537a056a2d8316444575696aa701bbd"></a><!-- doxytag: member="TelEngine::Router::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, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the routed channel identifier <dl class="return" compact><dt><b>Returns:</b></dt><dd>Unique id of the channel being routed </dd></dl>
</div>
</div><p>
<a class="anchor" name="001a86bd4538de67471ec4965f845aa9"></a><!-- doxytag: member="TelEngine::Router::route" ref="001a86bd4538de67471ec4965f845aa9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool route </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Actual routing method <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if call was successfully routed </dd></dl>
</div>
</div><p>
<a class="anchor" name="72fcb26a14f6beb1c3fbace9ab3e7dbb"></a><!-- doxytag: member="TelEngine::Router::run" ref="72fcb26a14f6beb1c3fbace9ab3e7dbb" args="()" -->
<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> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Main thread running method
<p>Implements <a class="el" href="classTelEngine_1_1Runnable.html#18954417d3124a8095783ea13dc6d00b">Runnable</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
>
420
