1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
<HTML>
<HEAD>
<TITLE>class JBComponentStream</TITLE>
<META NAME="Generator" CONTENT="KDOC ">
</HEAD>
<BODY bgcolor="#ffffff" text="#000000" link="#0000ff" vlink="#000099" alink= "#ffffff">
<TABLE WIDTH="100%" BORDER="0">
<TR>
<TD>
<TABLE BORDER="0">
<TR><TD valign="top" align="left" cellspacing="10">
<h1>class JBComponentStream</h1>
</TD>
<TD valign="top" align="right" colspan="1">A Jabber Component stream. <small><A HREF="#longdesc">More...</A></small></TD></TR>
</TABLE>
<HR>
<TABLE BORDER="0">
<TR><TH>Full name</TH><TD><code><A HREF="TelEngine.html">TelEngine</A>::JBComponentStream</code></TD></TR>
<TR><TH>Definition</TH><TD><code>#include <<A HREF="libs___yjingle___yatejabber_h.html">libs/yjingle/yatejabber.h</A>></code></TD></TR>
<TR><TH>Inherits</TH><TD><A HREF="TelEngine__JBStream.html">TelEngine::JBStream</A> <small>[public ]</small></TD></TR>
<TR><TH><A HREF="full-list-TelEngine__JBComponentStream.html">List of all Methods</A></TH></TR>
</TABLE>
</TD>
<TD align="right"><TABLE BORDER="0"><TR><TD><small><A HREF="index-long.html">Annotated List</A></small></TD></TR>
<TR><TD><small><A HREF="header-list.html">Files</A></small></TD></TR>
<TR><TD><small><A HREF="all-globals.html">Globals</A></small></TD></TR>
<TR><TD><small><A HREF="hier.html">Hierarchy</A></small></TD></TR>
<TR><TD><small><A HREF="index.html">Index</A></small></TD></TR>
</TABLE></TD></TR></TABLE>
<h4>Public Methods</h4><ul><LI>virtual <b><A HREF="#ref2">~JBComponentStream</A></b> ()
</LI>
<LI>virtual void* <b><A HREF="#ref3">getObject</A></b> (const String& name) const
</LI>
</ul><h4>Protected Methods</h4><ul><LI> <b><A HREF="#ref4">JBComponentStream</A></b> (JBEngine* engine, XMPPServerInfo& info,
const JabberID& localJid, const JabberID& remoteJid)
</LI>
<LI>virtual XMLElement* <b><A HREF="#ref5">getStreamStart</A></b> ()
</LI>
<LI>virtual XMLElement* <b><A HREF="#ref6">getAuthStart</A></b> ()
</LI>
<LI>virtual void <b><A HREF="#ref7">processAuth</A></b> (XMLElement* xml)
</LI>
<LI>virtual void <b><A HREF="#ref8">processStarted</A></b> (XMLElement* xml)
</LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
This class holds a Jabber Component stream (implements the Jabber Component Protocol).
</p>
<A NAME="~JBComponentStream"></A><A NAME="ref2"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>~JBComponentStream</strong> ()
<br></td><td align="right"><h3><strong>~JBComponentStream</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Destructor
</p>
<A NAME="getObject"></A><A NAME="ref3"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void* <strong>getObject</strong> (const String& name)
<br></td><td align="right"><h3><strong>getObject</strong></h3></td></tr></table><p> <small>[const virtual]</small></p><p>
Get an object from this stream
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>name</i></TD><TD align="left" valign="top">The name of the object to get
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: Pointer to the object or 0 if not found
</p>
<p>Reimplemented from <A HREF="TelEngine__JBStream.html#getObject">JBStream</A>.</p>
<A NAME="JBComponentStream"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>JBComponentStream</strong> (JBEngine* engine, XMPPServerInfo& info,
const JabberID& localJid, const JabberID& remoteJid)
<br></td><td align="right"><h3><strong>JBComponentStream</strong></h3></td></tr></table><p> <small>[protected]</small></p><p>
Constructor. Build an outgoing stream
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>engine</i></TD><TD align="left" valign="top">The engine that owns this stream
</TD></TR>
<TR><TD align="left" valign="top"><i>info</i></TD><TD align="left" valign="top">Structure containing data used to connect to remote server
</TD></TR>
<TR><TD align="left" valign="top"><i>localJid</i></TD><TD align="left" valign="top">Local party's JID
</TD></TR>
<TR><TD align="left" valign="top"><i>remoteJid</i></TD><TD align="left" valign="top">Remote party's JID
</TD></TR>
</TABLE></P>
<A NAME="getStreamStart"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td> XMLElement* <strong>getStreamStart</strong> ()
<br></td><td align="right"><h3><strong>getStreamStart</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>
Get the starting stream element to be sent after stream connected
</p>
<p><b>Returns</b>: XMLElement pointer
</p>
<p>Reimplemented from <A HREF="TelEngine__JBStream.html#getStreamStart">JBStream</A>.</p>
<A NAME="getAuthStart"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td> XMLElement* <strong>getAuthStart</strong> ()
<br></td><td align="right"><h3><strong>getAuthStart</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>
Get the authentication element to be sent when authentication starts
</p>
<p><b>Returns</b>: XMLElement pointer
</p>
<p>Reimplemented from <A HREF="TelEngine__JBStream.html#getAuthStart">JBStream</A>.</p>
<A NAME="processAuth"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>processAuth</strong> (XMLElement* xml)
<br></td><td align="right"><h3><strong>processAuth</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>
Process a received element in Auth state
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>xml</i></TD><TD align="left" valign="top">Valid XMLElement pointer
</TD></TR>
</TABLE></P>
<p>Reimplemented from <A HREF="TelEngine__JBStream.html#processAuth">JBStream</A>.</p>
<A NAME="processStarted"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>processStarted</strong> (XMLElement* xml)
<br></td><td align="right"><h3><strong>processStarted</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>
Process a received element in Started state
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>xml</i></TD><TD align="left" valign="top">Valid XMLElement pointer
</TD></TR>
</TABLE></P>
<p>Reimplemented from <A HREF="TelEngine__JBStream.html#processStarted">JBStream</A>.</p>
<HR>
<table>
<tr><td><small>Generated by: paulc on bussard on Mon Mar 8 12:18:15 2010, using kdoc 2.0a54.</small></td></tr>
</table>
</BODY>
</HTML>
|
