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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
|
<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>xmpp.client.Component</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="xmpp-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="xmpp-module.html">Package xmpp</a> ::
<a href="xmpp.client-module.html">Module client</a> ::
Class Component
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="xmpp.client.Component-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Component</h1><span class="codelink"><a href="xmpp.client-pysrc.html#Component">source code</a></span><br /><br />
<pre class="base-tree">
<a href="xmpp.client.CommonClient-class.html">CommonClient</a> --+
|
<strong class="uidshort">Component</strong>
</pre>
<hr />
Component class. The only difference from CommonClient is ability to
perform component authentication.<br /><br />
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="xmpp.client.Component-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">server</span>,
<span class="summary-sig-arg">port</span>=<span class="summary-sig-default">5347</span>,
<span class="summary-sig-arg">typ</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">debug</span>=<span class="summary-sig-default"><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">always</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">nodebuilder</code><code class="variable-quote">'</code><code class="variable-group">]</code></span>,
<span class="summary-sig-arg">domains</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">sasl</span>=<span class="summary-sig-default">0</span>,
<span class="summary-sig-arg">bind</span>=<span class="summary-sig-default">0</span>,
<span class="summary-sig-arg">route</span>=<span class="summary-sig-default">0</span>,
<span class="summary-sig-arg">xcp</span>=<span class="summary-sig-default">0</span>)</span><br />
Init function for Components.</td>
<td align="right" valign="top">
<span class="codelink"><a href="xmpp.client-pysrc.html#Component.__init__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="xmpp.client.Component-class.html#connect" class="summary-sig-name">connect</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">server</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">proxy</span>=<span class="summary-sig-default">None</span>)</span><br />
This will connect to the server, and if the features tag is found
then set the namespace to be jabber:client as that is required for
jabberd2.</td>
<td align="right" valign="top">
<span class="codelink"><a href="xmpp.client-pysrc.html#Component.connect">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="dobind"></a><span class="summary-sig-name">dobind</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">sasl</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="xmpp.client-pysrc.html#Component.dobind">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="auth"></a><span class="summary-sig-name">auth</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">password</span>,
<span class="summary-sig-arg">dup</span>=<span class="summary-sig-default">None</span>)</span><br />
Authenticate component "name" with password
"password".</td>
<td align="right" valign="top">
<span class="codelink"><a href="xmpp.client-pysrc.html#Component.auth">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="xmpp.client.CommonClient-class.html">CommonClient</a></code></b>:
<code><a href="xmpp.client.CommonClient-class.html#DisconnectHandler">DisconnectHandler</a></code>,
<code><a href="xmpp.client.CommonClient-class.html#RegisterDisconnectHandler">RegisterDisconnectHandler</a></code>,
<code><a href="xmpp.client.CommonClient-class.html#UnregisterDisconnectHandler">UnregisterDisconnectHandler</a></code>,
<code><a href="xmpp.client.CommonClient-class.html#disconnected">disconnected</a></code>,
<code><a href="xmpp.client.CommonClient-class.html#event">event</a></code>,
<code><a href="xmpp.client.CommonClient-class.html#isConnected">isConnected</a></code>,
<code><a href="xmpp.client.CommonClient-class.html#reconnectAndReauth">reconnectAndReauth</a></code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">server</span>,
<span class="sig-arg">port</span>=<span class="sig-default">5347</span>,
<span class="sig-arg">typ</span>=<span class="sig-default">None</span>,
<span class="sig-arg">debug</span>=<span class="sig-default"><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">always</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">nodebuilder</code><code class="variable-quote">'</code><code class="variable-group">]</code></span>,
<span class="sig-arg">domains</span>=<span class="sig-default">None</span>,
<span class="sig-arg">sasl</span>=<span class="sig-default">0</span>,
<span class="sig-arg">bind</span>=<span class="sig-default">0</span>,
<span class="sig-arg">route</span>=<span class="sig-default">0</span>,
<span class="sig-arg">xcp</span>=<span class="sig-default">0</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="xmpp.client-pysrc.html#Component.__init__">source code</a></span>
</td>
</table>
Init function for Components. As components use a different auth
mechanism which includes the namespace of the component. Jabberd1.4 and
Ejabberd use the default namespace then for all client messages. Jabberd2
uses jabber:client. 'server' argument is a server name that you are
connecting to (f.e. "localhost"). 'port' can be specified if
'server' resolves to correct IP. If it is not then you'll need to specify
IP and port while calling "connect()".
<dl class="fields">
<dt>Overrides:
<a href="xmpp.client.CommonClient-class.html#__init__">CommonClient.__init__</a>
</dt>
</dl>
</td></tr></table>
</div>
<a name="connect"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">connect</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">server</span>=<span class="sig-default">None</span>,
<span class="sig-arg">proxy</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="xmpp.client-pysrc.html#Component.connect">source code</a></span>
</td>
</table>
This will connect to the server, and if the features tag is found then
set the namespace to be jabber:client as that is required for jabberd2.
'server' and 'proxy' arguments have the same meaning as in
xmpp.Client.connect()
<dl class="fields">
<dt>Overrides:
<a href="xmpp.client.CommonClient-class.html#connect">CommonClient.connect</a>
</dt>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="xmpp-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0beta1 on Sat Dec 15 22:25:14 2007
</td>
<td align="right" class="footer">
<a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie()
// -->
</script>
</body>
</html>
|
