Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > eeacaa4eb55fa544d622989e42fc27b1 > files > 224

libyate-devel-2.0.0-2mdv2009.1.i586.rpm

<!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: JBEngine 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&nbsp;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&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="namespaceTelEngine.html">TelEngine</a>::<a class="el" href="classTelEngine_1_1JBEngine.html">JBEngine</a>
  </div>
</div>
<div class="contents">
<h1>JBEngine Class Reference</h1><!-- doxytag: class="TelEngine::JBEngine" --><!-- doxytag: inherits="TelEngine::DebugEnabler,TelEngine::Mutex,TelEngine::GenObject,TelEngine::JBThreadList" -->A Jabber engine.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="yatejabber_8h-source.html">yatejabber.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for JBEngine:</div>
<div class="dynsection">

<p><center><img src="classTelEngine_1_1JBEngine.png" usemap="#JBEngine_map" border="0" alt=""></center>
<map name="JBEngine_map">
<area href="classTelEngine_1_1DebugEnabler.html" alt="DebugEnabler" shape="rect" coords="0,0,93,24">
<area href="classTelEngine_1_1Mutex.html" alt="Mutex" shape="rect" coords="103,0,196,24">
<area href="classTelEngine_1_1GenObject.html" alt="GenObject" shape="rect" coords="206,0,299,24">
<area href="classTelEngine_1_1JBThreadList.html" alt="JBThreadList" shape="rect" coords="309,0,402,24">
</map>
</div>

<p>
<a href="classTelEngine_1_1JBEngine-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 Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBEngine.html#ac39b55be6469395f55ff0292ad8184c">Protocol</a> { <b>Component</b> =  1, 
<b>Client</b> =  2
 }</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBEngine.html#5b06c272042eb9a41fa774ec00171c0f">Service</a> { <br>
&nbsp;&nbsp;<b>ServiceJingle</b> =  0, 
<b>ServiceIq</b> =  1, 
<b>ServiceMessage</b> =  2, 
<b>ServicePresence</b> =  3, 
<br>
&nbsp;&nbsp;<b>ServiceCommand</b> =  4, 
<b>ServiceDisco</b> =  5, 
<b>ServiceStream</b> =  6, 
<b>ServiceWriteFail</b> =  7, 
<br>
&nbsp;&nbsp;<b>ServiceRoster</b> =  8, 
<b>ServiceCount</b> =  9
<br>
 }</td></tr>

<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBEngine.html#9ee4b0a9d12f67fbe4c850f650183c89">JBEngine</a> (<a class="el" href="classTelEngine_1_1JBEngine.html#ac39b55be6469395f55ff0292ad8184c">Protocol</a> proto)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBEngine.html#c6e2e21c30a45b5e2565382b9b8f7299">~JBEngine</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1JBEngine.html#ac39b55be6469395f55ff0292ad8184c">Protocol</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBEngine.html#892a53d0ff150377ce8ff6f4fa5b3370">protocol</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classTelEngine_1_1JabberID.html">JabberID</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBEngine.html#4ca1a9610a129754f96cec4c0465ae7f">componentServer</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBEngine.html#1ce8a139871d81eea7522fe417302698">setAlternateDomain</a> (const char *domain=0)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classTelEngine_1_1JabberID.html">JabberID</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBEngine.html#5b626c020d22d0b4fdf24eba7a7a4561">getAlternateDomain</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classTelEngine_1_1String.html">String</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBEngine.html#8edc2dd8faf4d78e95a2562ce6b481af">defaultResource</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classTelEngine_1_1ObjList.html">ObjList</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBEngine.html#0b1c871dc0071b5e6889e3c7fa62f1c7">streams</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBEngine.html#757ca89703a72ac56715edb379958716">destruct</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBEngine.html#c391e1e7a016b4064486b5994fc1fed7">initialize</a> (const <a class="el" href="classTelEngine_1_1NamedList.html">NamedList</a> &amp;params)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBEngine.html#4b66d5e31b5dc18b314c8a68163263bd">cleanup</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBEngine.html#6d0360bd30d59e39fcf5c051c8a49284">setComponentServer</a> (const char *domain)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1JBStream.html">JBStream</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBEngine.html#5d93f1e50b3017d612365aeede30b5a5">findStream</a> (const <a class="el" href="classTelEngine_1_1String.html">String</a> &amp;name)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1JBStream.html">JBStream</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBEngine.html#53ce02a29b52a1d6ce505ab2d59701d4">getStream</a> (const <a class="el" href="classTelEngine_1_1JabberID.html">JabberID</a> *jid=0, bool create=true)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBEngine.html#a69bcfc5f02686baf7d5df1e02429697">getStream</a> (<a class="el" href="classTelEngine_1_1JBStream.html">JBStream</a> *&amp;stream, bool &amp;release)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1JBClientStream.html">JBClientStream</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBEngine.html#6adb228dee15dd7a95a3ce1651708641">createClientStream</a> (<a class="el" href="classTelEngine_1_1NamedList.html">NamedList</a> &amp;params)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBEngine.html#562369ec2e4ebdf923646b9b261f0f96">receive</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBEngine.html#83cb8306eb651716d5a583690eb9f80f">process</a> (u_int64_t time)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBEngine.html#198b0d70c30dfcbccb0a0574ac4cf835">checkDupId</a> (const <a class="el" href="classTelEngine_1_1JBStream.html">JBStream</a> *stream)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBEngine.html#1bb764c326ae9f4e6c739107246c863a">checkComponentFrom</a> (<a class="el" href="classTelEngine_1_1JBComponentStream.html">JBComponentStream</a> *stream, const char *from)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBEngine.html#13649144f6987ba13dba0e16af9bd26d">connect</a> (<a class="el" href="classTelEngine_1_1JBStream.html">JBStream</a> *stream)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBEngine.html#8b00783f72e7cd9a1ceb96f23572d0bc">exiting</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBEngine.html#d8e9de233300739d69d7e86b1bdc9eee">encryptStream</a> (<a class="el" href="classTelEngine_1_1JBStream.html">JBStream</a> *stream)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBEngine.html#59375dd90a272a5ad08ddbc754f4ff2b">appendServer</a> (<a class="el" href="classTelEngine_1_1XMPPServerInfo.html">XMPPServerInfo</a> *server, bool open)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBEngine.html#23360ceceac1b440b65704e84ade3125">getServerIdentity</a> (<a class="el" href="classTelEngine_1_1String.html">String</a> &amp;destination, bool full, const char *token=0, bool domain=true)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1XMPPServerInfo.html">XMPPServerInfo</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBEngine.html#132dd89965addf926710e9ce9563c475">findServerInfo</a> (const char *token, bool domain)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBEngine.html#cc0c02a4a7f26dc61881f47e94176844">attachService</a> (<a class="el" href="classTelEngine_1_1JBService.html">JBService</a> *service, <a class="el" href="classTelEngine_1_1JBEngine.html#5b06c272042eb9a41fa774ec00171c0f">Service</a> type, int prio=-1)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBEngine.html#6ef343cbc1f6d69a9ea5f3ae0bcb1213">detachService</a> (<a class="el" href="classTelEngine_1_1JBService.html">JBService</a> *service)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBEngine.html#9329bd66d7d6a4af995dbbddcf25791e">printXml</a> (const <a class="el" href="classTelEngine_1_1XMLElement.html">XMLElement</a> &amp;xml, const <a class="el" href="classTelEngine_1_1JBStream.html">JBStream</a> *stream, bool send) 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 const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBEngine.html#5bef94a97c415b3d98d2dc046fafdce1">lookupProto</a> (int proto, const char *def=0)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBEngine.html#7a3c7e7dc7c991c341feaf027eb44714">lookupProto</a> (const char *proto, int def=0)</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="c67873bce9410a135bf268db1073612e"></a><!-- doxytag: member="TelEngine::JBEngine::JBStream" ref="c67873bce9410a135bf268db1073612e" args="" -->
class&nbsp;</td><td class="memItemRight" valign="bottom"><b>JBStream</b></td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A Jabber engine. 
<p>
This class holds a Jabber engine <hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="ac39b55be6469395f55ff0292ad8184c"></a><!-- doxytag: member="TelEngine::JBEngine::Protocol" ref="ac39b55be6469395f55ff0292ad8184c" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="classTelEngine_1_1JBEngine.html#ac39b55be6469395f55ff0292ad8184c">Protocol</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Jabber protocol type 
</div>
</div><p>
<a class="anchor" name="5b06c272042eb9a41fa774ec00171c0f"></a><!-- doxytag: member="TelEngine::JBEngine::Service" ref="5b06c272042eb9a41fa774ec00171c0f" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="classTelEngine_1_1JBEngine.html#5b06c272042eb9a41fa774ec00171c0f">Service</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Service type enumeration 
</div>
</div><p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="9ee4b0a9d12f67fbe4c850f650183c89"></a><!-- doxytag: member="TelEngine::JBEngine::JBEngine" ref="9ee4b0a9d12f67fbe4c850f650183c89" args="(Protocol proto)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTelEngine_1_1JBEngine.html">JBEngine</a>           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classTelEngine_1_1JBEngine.html#ac39b55be6469395f55ff0292ad8184c">Protocol</a>&nbsp;</td>
          <td class="paramname"> <em>proto</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
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>proto</em>&nbsp;</td><td>The protocol used by the streams belonging to this engine </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="c6e2e21c30a45b5e2565382b9b8f7299"></a><!-- doxytag: member="TelEngine::JBEngine::~JBEngine" ref="c6e2e21c30a45b5e2565382b9b8f7299" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual ~<a class="el" href="classTelEngine_1_1JBEngine.html">JBEngine</a>           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Destructor 
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="59375dd90a272a5ad08ddbc754f4ff2b"></a><!-- doxytag: member="TelEngine::JBEngine::appendServer" ref="59375dd90a272a5ad08ddbc754f4ff2b" args="(XMPPServerInfo *server, bool open)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void appendServer           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classTelEngine_1_1XMPPServerInfo.html">XMPPServerInfo</a> *&nbsp;</td>
          <td class="paramname"> <em>server</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>open</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Append a server info element to the list <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>server</em>&nbsp;</td><td>The object to add </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>open</em>&nbsp;</td><td>True to open the stream, if in component mode </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="cc0c02a4a7f26dc61881f47e94176844"></a><!-- doxytag: member="TelEngine::JBEngine::attachService" ref="cc0c02a4a7f26dc61881f47e94176844" args="(JBService *service, Service type, int prio=&#45;1)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void attachService           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classTelEngine_1_1JBService.html">JBService</a> *&nbsp;</td>
          <td class="paramname"> <em>service</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classTelEngine_1_1JBEngine.html#5b06c272042eb9a41fa774ec00171c0f">Service</a>&nbsp;</td>
          <td class="paramname"> <em>type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>prio</em> = <code>-1</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Attach a service to this engine. This method is thread safe <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>service</em>&nbsp;</td><td>The service to attach </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>Service type </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>prio</em>&nbsp;</td><td>Service priority. Set to -1 to use the givent service's priority. A lower values indicates a service with higher priority </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="1bb764c326ae9f4e6c739107246c863a"></a><!-- doxytag: member="TelEngine::JBEngine::checkComponentFrom" ref="1bb764c326ae9f4e6c739107246c863a" args="(JBComponentStream *stream, const char *from)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool checkComponentFrom           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classTelEngine_1_1JBComponentStream.html">JBComponentStream</a> *&nbsp;</td>
          <td class="paramname"> <em>stream</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>from</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Check the 'from' attribute received by a Component stream at startup <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>stream</em>&nbsp;</td><td>The calling stream </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>from</em>&nbsp;</td><td>The from attribute to check </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if valid </dd></dl>

</div>
</div><p>
<a class="anchor" name="198b0d70c30dfcbccb0a0574ac4cf835"></a><!-- doxytag: member="TelEngine::JBEngine::checkDupId" ref="198b0d70c30dfcbccb0a0574ac4cf835" args="(const JBStream *stream)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool checkDupId           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classTelEngine_1_1JBStream.html">JBStream</a> *&nbsp;</td>
          <td class="paramname"> <em>stream</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Check if an outgoing stream exists with the same id and remote 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>stream</em>&nbsp;</td><td>The calling stream </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if found </dd></dl>

</div>
</div><p>
<a class="anchor" name="4b66d5e31b5dc18b314c8a68163263bd"></a><!-- doxytag: member="TelEngine::JBEngine::cleanup" ref="4b66d5e31b5dc18b314c8a68163263bd" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void cleanup           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Terminate all streams 
</div>
</div><p>
<a class="anchor" name="4ca1a9610a129754f96cec4c0465ae7f"></a><!-- doxytag: member="TelEngine::JBEngine::componentServer" ref="4ca1a9610a129754f96cec4c0465ae7f" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="classTelEngine_1_1JabberID.html">JabberID</a>&amp; componentServer           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the default component server <dl class="return" compact><dt><b>Returns:</b></dt><dd>The default component server </dd></dl>

</div>
</div><p>
<a class="anchor" name="13649144f6987ba13dba0e16af9bd26d"></a><!-- doxytag: member="TelEngine::JBEngine::connect" ref="13649144f6987ba13dba0e16af9bd26d" args="(JBStream *stream)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void connect           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classTelEngine_1_1JBStream.html">JBStream</a> *&nbsp;</td>
          <td class="paramname"> <em>stream</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Asynchronously call the connect method of the given stream if the stream is idle <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>stream</em>&nbsp;</td><td>The stream to connect </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="6adb228dee15dd7a95a3ce1651708641"></a><!-- doxytag: member="TelEngine::JBEngine::createClientStream" ref="6adb228dee15dd7a95a3ce1651708641" args="(NamedList &amp;params)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTelEngine_1_1JBClientStream.html">JBClientStream</a>* createClientStream           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classTelEngine_1_1NamedList.html">NamedList</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>params</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create a new client stream. This method is thread safe <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>&nbsp;</td><td><a class="el" href="classTelEngine_1_1Stream.html" title="An abstract stream class capable of reading and writing.">Stream</a> parameters </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Referenced <a class="el" href="classTelEngine_1_1JBClientStream.html" title="A Jabber client to server stream.">JBClientStream</a> pointer or 0 </dd></dl>

</div>
</div><p>
<a class="anchor" name="8edc2dd8faf4d78e95a2562ce6b481af"></a><!-- doxytag: member="TelEngine::JBEngine::defaultResource" ref="8edc2dd8faf4d78e95a2562ce6b481af" 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>&amp; defaultResource           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the default resource name. <dl class="return" compact><dt><b>Returns:</b></dt><dd>The default resource name. </dd></dl>

</div>
</div><p>
<a class="anchor" name="757ca89703a72ac56715edb379958716"></a><!-- doxytag: member="TelEngine::JBEngine::destruct" ref="757ca89703a72ac56715edb379958716" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void destruct           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Cleanup streams. Stop all threads owned by this engine. Release memory 
<p>Reimplemented from <a class="el" href="classTelEngine_1_1GenObject.html#757ca89703a72ac56715edb379958716">GenObject</a>.</p>

</div>
</div><p>
<a class="anchor" name="6ef343cbc1f6d69a9ea5f3ae0bcb1213"></a><!-- doxytag: member="TelEngine::JBEngine::detachService" ref="6ef343cbc1f6d69a9ea5f3ae0bcb1213" args="(JBService *service)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void detachService           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classTelEngine_1_1JBService.html">JBService</a> *&nbsp;</td>
          <td class="paramname"> <em>service</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Remove a service from all event handlers of this engine. This method is thread safe <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>service</em>&nbsp;</td><td>The service to detach </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="d8e9de233300739d69d7e86b1bdc9eee"></a><!-- doxytag: member="TelEngine::JBEngine::encryptStream" ref="d8e9de233300739d69d7e86b1bdc9eee" args="(JBStream *stream)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool encryptStream           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classTelEngine_1_1JBStream.html">JBStream</a> *&nbsp;</td>
          <td class="paramname"> <em>stream</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Setup the transport layer security for a stream <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>stream</em>&nbsp;</td><td>The stream requesting the operation </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if stream securing started, false on failure. </dd></dl>

</div>
</div><p>
<a class="anchor" name="8b00783f72e7cd9a1ceb96f23572d0bc"></a><!-- doxytag: member="TelEngine::JBEngine::exiting" ref="8b00783f72e7cd9a1ceb96f23572d0bc" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool exiting           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Check if this engine is exiting <dl class="return" compact><dt><b>Returns:</b></dt><dd>True is terminating </dd></dl>

</div>
</div><p>
<a class="anchor" name="132dd89965addf926710e9ce9563c475"></a><!-- doxytag: member="TelEngine::JBEngine::findServerInfo" ref="132dd89965addf926710e9ce9563c475" args="(const char *token, bool domain)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTelEngine_1_1XMPPServerInfo.html">XMPPServerInfo</a>* findServerInfo           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>token</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>domain</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Find server info 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>token</em>&nbsp;</td><td>The search string. If 0 and the Component protocol is used, the default component server will be used </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>domain</em>&nbsp;</td><td>True to find by domain name. False to find by address </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="classTelEngine_1_1XMPPServerInfo.html" title="Server info class.">XMPPServerInfo</a> pointer or 0 if not found </dd></dl>

</div>
</div><p>
<a class="anchor" name="5d93f1e50b3017d612365aeede30b5a5"></a><!-- doxytag: member="TelEngine::JBEngine::findStream" ref="5d93f1e50b3017d612365aeede30b5a5" args="(const String &amp;name)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTelEngine_1_1JBStream.html">JBStream</a>* findStream           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>name</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Find a stream by its name. This method is thread safe <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>&nbsp;</td><td>The name of the stream to find </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Referenced <a class="el" href="classTelEngine_1_1JBStream.html" title="A Jabber stream.">JBStream</a> pointer or 0 </dd></dl>

</div>
</div><p>
<a class="anchor" name="5b626c020d22d0b4fdf24eba7a7a4561"></a><!-- doxytag: member="TelEngine::JBEngine::getAlternateDomain" ref="5b626c020d22d0b4fdf24eba7a7a4561" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="classTelEngine_1_1JabberID.html">JabberID</a>&amp; getAlternateDomain           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the alternate domain name <dl class="return" compact><dt><b>Returns:</b></dt><dd>the alternate domain name </dd></dl>

</div>
</div><p>
<a class="anchor" name="23360ceceac1b440b65704e84ade3125"></a><!-- doxytag: member="TelEngine::JBEngine::getServerIdentity" ref="23360ceceac1b440b65704e84ade3125" args="(String &amp;destination, bool full, const char *token=0, bool domain=true)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool getServerIdentity           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classTelEngine_1_1String.html">String</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>destination</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>full</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>token</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>domain</em> = <code>true</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the identity of the given server <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>destination</em>&nbsp;</td><td>The destination buffer </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>full</em>&nbsp;</td><td>True to get the full identity </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>token</em>&nbsp;</td><td>The search string. If 0 and the component protocol is used, the default server will be used </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>domain</em>&nbsp;</td><td>True to find by domain name. False to find by address </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>False if server doesn't exists </dd></dl>

</div>
</div><p>
<a class="anchor" name="a69bcfc5f02686baf7d5df1e02429697"></a><!-- doxytag: member="TelEngine::JBEngine::getStream" ref="a69bcfc5f02686baf7d5df1e02429697" args="(JBStream *&amp;stream, bool &amp;release)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool getStream           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classTelEngine_1_1JBStream.html">JBStream</a> *&amp;&nbsp;</td>
          <td class="paramname"> <em>stream</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool &amp;&nbsp;</td>
          <td class="paramname"> <em>release</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Try to get a stream if stream parameter is 0 <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>stream</em>&nbsp;</td><td><a class="el" href="classTelEngine_1_1Stream.html" title="An abstract stream class capable of reading and writing.">Stream</a> to check </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>release</em>&nbsp;</td><td>Set to true on exit if the caller must deref the stream </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if stream is valid </dd></dl>

</div>
</div><p>
<a class="anchor" name="53ce02a29b52a1d6ce505ab2d59701d4"></a><!-- doxytag: member="TelEngine::JBEngine::getStream" ref="53ce02a29b52a1d6ce505ab2d59701d4" args="(const JabberID *jid=0, bool create=true)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTelEngine_1_1JBStream.html">JBStream</a>* getStream           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classTelEngine_1_1JabberID.html">JabberID</a> *&nbsp;</td>
          <td class="paramname"> <em>jid</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>create</em> = <code>true</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get a stream. Create it not found and requested. For the component protocol, the jid parameter may contain the domain to find, otherwise, the default component will be used. This method won't create a client stream. Use <a class="el" href="classTelEngine_1_1JBEngine.html#6adb228dee15dd7a95a3ce1651708641">createClientStream()</a>. This method is thread safe <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>jid</em>&nbsp;</td><td>Optional jid to use to find or create the stream </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>create</em>&nbsp;</td><td>True to create a stream if don't exist. Ignored if the engine's protocol is <a class="el" href="classTelEngine_1_1Client.html" title="Thread that runs the User Interface.">Client</a> </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Referenced <a class="el" href="classTelEngine_1_1JBStream.html" title="A Jabber stream.">JBStream</a> pointer or 0 </dd></dl>

</div>
</div><p>
<a class="anchor" name="c391e1e7a016b4064486b5994fc1fed7"></a><!-- doxytag: member="TelEngine::JBEngine::initialize" ref="c391e1e7a016b4064486b5994fc1fed7" args="(const NamedList &amp;params)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void initialize           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classTelEngine_1_1NamedList.html">NamedList</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>params</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Initialize the engine's parameters. Start private streams if requested <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>&nbsp;</td><td>Engine's parameters </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="7a3c7e7dc7c991c341feaf027eb44714"></a><!-- doxytag: member="TelEngine::JBEngine::lookupProto" ref="7a3c7e7dc7c991c341feaf027eb44714" args="(const char *proto, int def=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static int lookupProto           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>proto</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>def</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the value associated with a protocol name <dl class="return" compact><dt><b>Returns:</b></dt><dd>The value associated with a protocol name </dd></dl>

<p>References <a class="el" href="namespaceTelEngine.html#4668c9172c6ae5f59f5782ecc6e05516">TelEngine::lookup()</a>.</p>

</div>
</div><p>
<a class="anchor" name="5bef94a97c415b3d98d2dc046fafdce1"></a><!-- doxytag: member="TelEngine::JBEngine::lookupProto" ref="5bef94a97c415b3d98d2dc046fafdce1" args="(int proto, const char *def=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static const char* lookupProto           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>proto</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>def</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the name of a protocol <dl class="return" compact><dt><b>Returns:</b></dt><dd>The name of the requested protocol or the default value </dd></dl>

<p>References <a class="el" href="namespaceTelEngine.html#4668c9172c6ae5f59f5782ecc6e05516">TelEngine::lookup()</a>.</p>

</div>
</div><p>
<a class="anchor" name="9329bd66d7d6a4af995dbbddcf25791e"></a><!-- doxytag: member="TelEngine::JBEngine::printXml" ref="9329bd66d7d6a4af995dbbddcf25791e" args="(const XMLElement &amp;xml, const JBStream *stream, bool send) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void printXml           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classTelEngine_1_1XMLElement.html">XMLElement</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>xml</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classTelEngine_1_1JBStream.html">JBStream</a> *&nbsp;</td>
          <td class="paramname"> <em>stream</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>send</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Print an XML element to output <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>xml</em>&nbsp;</td><td>Element to print </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>stream</em>&nbsp;</td><td><a class="el" href="classTelEngine_1_1Stream.html" title="An abstract stream class capable of reading and writing.">Stream</a> requesting the operation </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>send</em>&nbsp;</td><td>True if sending, false if receiving </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="83cb8306eb651716d5a583690eb9f80f"></a><!-- doxytag: member="TelEngine::JBEngine::process" ref="83cb8306eb651716d5a583690eb9f80f" args="(u_int64_t time)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool process           </td>
          <td>(</td>
          <td class="paramtype">u_int64_t&nbsp;</td>
          <td class="paramname"> <em>time</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get events from the streams owned by this engine and send them to a service. Delete them if not processed by a service <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>time</em>&nbsp;</td><td>Current time </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if an event was generated by any stream </dd></dl>

</div>
</div><p>
<a class="anchor" name="892a53d0ff150377ce8ff6f4fa5b3370"></a><!-- doxytag: member="TelEngine::JBEngine::protocol" ref="892a53d0ff150377ce8ff6f4fa5b3370" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTelEngine_1_1JBEngine.html#ac39b55be6469395f55ff0292ad8184c">Protocol</a> protocol           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the Jabber protocol this engine is using <dl class="return" compact><dt><b>Returns:</b></dt><dd>The Jabber protocol as enumeration </dd></dl>

</div>
</div><p>
<a class="anchor" name="562369ec2e4ebdf923646b9b261f0f96"></a><!-- doxytag: member="TelEngine::JBEngine::receive" ref="562369ec2e4ebdf923646b9b261f0f96" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool receive           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Keep calling <a class="el" href="classTelEngine_1_1JBEngine.html#562369ec2e4ebdf923646b9b261f0f96">receive()</a> for each stream until no data is received or the thread is terminated <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if data was received </dd></dl>

</div>
</div><p>
<a class="anchor" name="1ce8a139871d81eea7522fe417302698"></a><!-- doxytag: member="TelEngine::JBEngine::setAlternateDomain" ref="1ce8a139871d81eea7522fe417302698" args="(const char *domain=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void setAlternateDomain           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>domain</em> = <code>0</code>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the alternate domain 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>domain</em>&nbsp;</td><td>Name of an acceptable alternate domain </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="6d0360bd30d59e39fcf5c051c8a49284"></a><!-- doxytag: member="TelEngine::JBEngine::setComponentServer" ref="6d0360bd30d59e39fcf5c051c8a49284" args="(const char *domain)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void setComponentServer           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>domain</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the default component server to use. The domain must be in the server list. Choose the first one from the server list if the given one doesn't exists. Do nothing if the protocol is not Component <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>domain</em>&nbsp;</td><td>Domain name of the server </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="0b1c871dc0071b5e6889e3c7fa62f1c7"></a><!-- doxytag: member="TelEngine::JBEngine::streams" ref="0b1c871dc0071b5e6889e3c7fa62f1c7" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="classTelEngine_1_1ObjList.html">ObjList</a>&amp; streams           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the stream list <dl class="return" compact><dt><b>Returns:</b></dt><dd>The list of streams belonging to this engine </dd></dl>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="yatejabber_8h-source.html">yatejabber.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&nbsp;
<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>