<!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: JBComponentStream 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_1JBComponentStream.html">JBComponentStream</a>
</div>
</div>
<div class="contents">
<h1>JBComponentStream Class Reference</h1><!-- doxytag: class="TelEngine::JBComponentStream" --><!-- doxytag: inherits="TelEngine::JBStream" -->A Jabber Component stream.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="yatejabber_8h-source.html">yatejabber.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for JBComponentStream:</div>
<div class="dynsection">
<p><center><img src="classTelEngine_1_1JBComponentStream.png" usemap="#JBComponentStream_map" border="0" alt=""></center>
<map name="JBComponentStream_map">
<area href="classTelEngine_1_1JBStream.html" alt="JBStream" shape="rect" coords="0,112,129,136">
<area href="classTelEngine_1_1RefObject.html" alt="RefObject" shape="rect" coords="0,56,129,80">
<area href="classTelEngine_1_1GenObject.html" alt="GenObject" shape="rect" coords="0,0,129,24">
</map>
</div>
<p>
<a href="classTelEngine_1_1JBComponentStream-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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBComponentStream.html#cad19d5b413bcc10a441be47594e86bc">~JBComponentStream</a> ()</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_1JBComponentStream.html#3325b35f757f0ea6154f6ef668ff0308">JBComponentStream</a> (<a class="el" href="classTelEngine_1_1JBEngine.html">JBEngine</a> *engine, <a class="el" href="classTelEngine_1_1XMPPServerInfo.html">XMPPServerInfo</a> &info, const <a class="el" href="classTelEngine_1_1JabberID.html">JabberID</a> &localJid, const <a class="el" href="classTelEngine_1_1JabberID.html">JabberID</a> &remoteJid)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classTelEngine_1_1XMLElement.html">XMLElement</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBComponentStream.html#2fb2d3eb7cf42783be6faa11a7059cef">getStreamStart</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classTelEngine_1_1XMLElement.html">XMLElement</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBComponentStream.html#5d9bfc3b6a393e653e5083908e9d38b8">getAuthStart</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_1JBComponentStream.html#4ffa4b2ca0aa99e02b2de6ae084a534f">processAuth</a> (<a class="el" href="classTelEngine_1_1XMLElement.html">XMLElement</a> *xml)</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_1JBComponentStream.html#43ffe0bd8fc6ece8a03826432621d15a">processStarted</a> (<a class="el" href="classTelEngine_1_1XMLElement.html">XMLElement</a> *xml)</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="238c86427fe073d75f7030dcbd111b42"></a><!-- doxytag: member="TelEngine::JBComponentStream::JBEngine" ref="238c86427fe073d75f7030dcbd111b42" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>JBEngine</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A Jabber Component stream.
<p>
This class holds a Jabber Component stream (implements the Jabber Component Protocol). <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="cad19d5b413bcc10a441be47594e86bc"></a><!-- doxytag: member="TelEngine::JBComponentStream::~JBComponentStream" ref="cad19d5b413bcc10a441be47594e86bc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ~<a class="el" href="classTelEngine_1_1JBComponentStream.html">JBComponentStream</a> </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor
</div>
</div><p>
<a class="anchor" name="3325b35f757f0ea6154f6ef668ff0308"></a><!-- doxytag: member="TelEngine::JBComponentStream::JBComponentStream" ref="3325b35f757f0ea6154f6ef668ff0308" args="(JBEngine *engine, XMPPServerInfo &info, const JabberID &localJid, const JabberID &remoteJid)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1JBComponentStream.html">JBComponentStream</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1JBEngine.html">JBEngine</a> * </td>
<td class="paramname"> <em>engine</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1XMPPServerInfo.html">XMPPServerInfo</a> & </td>
<td class="paramname"> <em>info</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1JabberID.html">JabberID</a> & </td>
<td class="paramname"> <em>localJid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1JabberID.html">JabberID</a> & </td>
<td class="paramname"> <em>remoteJid</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor. Build an outgoing 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>engine</em> </td><td>The engine that owns this stream </td></tr>
<tr><td valign="top"></td><td valign="top"><em>info</em> </td><td>Structure containing data used to connect to remote server </td></tr>
<tr><td valign="top"></td><td valign="top"><em>localJid</em> </td><td>Local party's JID </td></tr>
<tr><td valign="top"></td><td valign="top"><em>remoteJid</em> </td><td>Remote party's JID </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="5d9bfc3b6a393e653e5083908e9d38b8"></a><!-- doxytag: member="TelEngine::JBComponentStream::getAuthStart" ref="5d9bfc3b6a393e653e5083908e9d38b8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classTelEngine_1_1XMLElement.html">XMLElement</a>* getAuthStart </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the authentication element to be sent when authentication starts <dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="classTelEngine_1_1XMLElement.html" title="An XML element.">XMLElement</a> pointer </dd></dl>
<p>Reimplemented from <a class="el" href="classTelEngine_1_1JBStream.html#5d9bfc3b6a393e653e5083908e9d38b8">JBStream</a>.</p>
</div>
</div><p>
<a class="anchor" name="2fb2d3eb7cf42783be6faa11a7059cef"></a><!-- doxytag: member="TelEngine::JBComponentStream::getStreamStart" ref="2fb2d3eb7cf42783be6faa11a7059cef" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classTelEngine_1_1XMLElement.html">XMLElement</a>* getStreamStart </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the starting stream element to be sent after stream connected <dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="classTelEngine_1_1XMLElement.html" title="An XML element.">XMLElement</a> pointer </dd></dl>
<p>Reimplemented from <a class="el" href="classTelEngine_1_1JBStream.html#2fb2d3eb7cf42783be6faa11a7059cef">JBStream</a>.</p>
</div>
</div><p>
<a class="anchor" name="4ffa4b2ca0aa99e02b2de6ae084a534f"></a><!-- doxytag: member="TelEngine::JBComponentStream::processAuth" ref="4ffa4b2ca0aa99e02b2de6ae084a534f" args="(XMLElement *xml)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void processAuth </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1XMLElement.html">XMLElement</a> * </td>
<td class="paramname"> <em>xml</em> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Process a received element in Auth state <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> </td><td>Valid <a class="el" href="classTelEngine_1_1XMLElement.html" title="An XML element.">XMLElement</a> pointer </td></tr>
</table>
</dl>
<p>Reimplemented from <a class="el" href="classTelEngine_1_1JBStream.html#4ffa4b2ca0aa99e02b2de6ae084a534f">JBStream</a>.</p>
</div>
</div><p>
<a class="anchor" name="43ffe0bd8fc6ece8a03826432621d15a"></a><!-- doxytag: member="TelEngine::JBComponentStream::processStarted" ref="43ffe0bd8fc6ece8a03826432621d15a" args="(XMLElement *xml)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void processStarted </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1XMLElement.html">XMLElement</a> * </td>
<td class="paramname"> <em>xml</em> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Process a received element in Started state <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> </td><td>Valid <a class="el" href="classTelEngine_1_1XMLElement.html" title="An XML element.">XMLElement</a> pointer </td></tr>
</table>
</dl>
<p>Reimplemented from <a class="el" href="classTelEngine_1_1JBStream.html#43ffe0bd8fc6ece8a03826432621d15a">JBStream</a>.</p>
</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
<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
>
221
