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
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
|
<?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>nbxmpp.dispatcher_nb.BOSHDispatcher</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="nbxmpp-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>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://python-nbxmpp.gajim.org">python-nbxmpp</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="nbxmpp-module.html">Package nbxmpp</a> ::
<a href="nbxmpp.dispatcher_nb-module.html">Module dispatcher_nb</a> ::
Class BOSHDispatcher
</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="nbxmpp.dispatcher_nb.BOSHDispatcher-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class BOSHDispatcher</h1><p class="nomargin-top"><span class="codelink"><a href="nbxmpp.dispatcher_nb-pysrc.html#BOSHDispatcher">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_nbxmpp_d" name="uml_class_diagram_for_nbxmpp_d">
<area shape="rect" id="node9" href="nbxmpp.dispatcher_nb.BOSHDispatcher-class.html#PlugIn" title="Attach to owner and register ourself and our _exported_methods in it. If defined by a subclass, call self.plugin(owner) to execute hook code after plugging" alt="" coords="141,473,519,492"/>
<area shape="rect" id="node9" href="nbxmpp.dispatcher_nb.BOSHDispatcher-class.html#StreamInit" title="Send an initial stream header" alt="" coords="141,492,519,511"/>
<area shape="rect" id="node9" href="nbxmpp.dispatcher_nb.BOSHDispatcher-class.html#StreamTerminate" title="Send a stream terminator" alt="" coords="141,511,519,529"/>
<area shape="rect" id="node9" href="nbxmpp.dispatcher_nb.BOSHDispatcher-class.html#ProcessNonBlocking" title="Check incoming stream for data waiting" alt="" coords="141,529,519,548"/>
<area shape="rect" id="node9" href="nbxmpp.dispatcher_nb.BOSHDispatcher-class.html#dispatch" title="Main procedure that performs XMPP stanza recognition and calling apppropriate handlers for it. Called by simplexml" alt="" coords="141,548,519,567"/>
<area shape="rect" id="node1" href="nbxmpp.dispatcher_nb.BOSHDispatcher-class.html" title="nbxmpp.dispatcher_nb.BOSHDispatcher" alt="" coords="129,441,529,573"/>
<area shape="rect" id="node10" href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#__init__" title="nbxmpp.dispatcher_nb.XMPPDispatcher.__init__" alt="" coords="17,135,643,153"/>
<area shape="rect" id="node10" href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#getAnID" title="nbxmpp.dispatcher_nb.XMPPDispatcher.getAnID" alt="" coords="17,153,643,172"/>
<area shape="rect" id="node10" href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#dumpHandlers" title="Return set of user-registered callbacks in it's internal format. Used within the library to carry user handlers set over Dispatcher replugins" alt="" coords="17,172,643,191"/>
<area shape="rect" id="node10" href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#restoreHandlers" title="Restore user-registered callbacks structure from dump previously obtained via dumpHandlers. Used within the library to carry user handlers set over Dispatcher replugins." alt="" coords="17,191,643,209"/>
<area shape="rect" id="node10" href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#plugin" title="Plug the Dispatcher instance into Client class instance and send initial stream header. Used internally" alt="" coords="17,209,643,228"/>
<area shape="rect" id="node10" href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#plugout" title="Prepare instance to be destructed" alt="" coords="17,228,643,247"/>
<area shape="rect" id="node10" href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#replace_non_character" title="nbxmpp.dispatcher_nb.XMPPDispatcher.replace_non_character" alt="" coords="17,247,643,265"/>
<area shape="rect" id="node10" href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#RegisterNamespace" title="Create internal structures for newly registered namespace" alt="" coords="17,265,643,284"/>
<area shape="rect" id="node10" href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#RegisterProtocol" title="Used to declare some top-level stanza name to dispatcher" alt="" coords="17,284,643,303"/>
<area shape="rect" id="node10" href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#RegisterNamespaceHandler" title="Register handler for processing all stanzas for specified namespace" alt="" coords="17,303,643,321"/>
<area shape="rect" id="node10" href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#RegisterHandler" title="Register user callback as stanzas handler of declared type" alt="" coords="17,321,643,340"/>
<area shape="rect" id="node10" href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#RegisterHandlerOnce" title="Unregister handler after first call (not implemented yet)" alt="" coords="17,340,643,359"/>
<area shape="rect" id="node10" href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#UnregisterHandler" title="Unregister handler. "typ" and "ns" must be specified exactly the same as with registering." alt="" coords="17,359,643,377"/>
<area shape="rect" id="node10" href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#send" title="Wrap transports send method when plugged into NonBlockingClient. Makes sure stanzas get ID and from tag." alt="" coords="17,396,643,415"/>
<area shape="rect" id="node2" href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html" title="Handles XMPP stream and is the first who takes control over a fresh stanza" alt="" coords="5,102,653,421"/>
<area shape="rect" id="node11" href="nbxmpp.plugin.PlugIn-class.html#PlugOut" title="Unregister our _exported_methods from owner and detach from it. If defined by a subclass, call self.plugout() after unplugging to execute hook code" alt="" coords="217,39,443,57"/>
<area shape="rect" id="node11" href="nbxmpp.plugin.PlugIn-class.html#get_instance" title="Factory Method for object creation" alt="" coords="217,57,443,76"/>
<area shape="rect" id="node3" href="nbxmpp.plugin.PlugIn-class.html" title="Abstract xmpppy plugin infrastructure code, providing plugging in/out and debugging functionality" alt="" coords="205,6,453,82"/>
</map>
<img src="uml_class_diagram_for_nbxmpp_d.gif" alt='' usemap="#uml_class_diagram_for_nbxmpp_d" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
<!-- ==================== 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="nbxmpp.dispatcher_nb.BOSHDispatcher-class.html#PlugIn" class="summary-sig-name">PlugIn</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">owner</span>,
<span class="summary-sig-arg">after_SASL</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">old_features</span>=<span class="summary-sig-default">None</span>)</span><br />
Attach to owner and register ourself and our _exported_methods in it.
If defined by a subclass, call self.plugin(owner) to execute hook
code after plugging</td>
<td align="right" valign="top">
<span class="codelink"><a href="nbxmpp.dispatcher_nb-pysrc.html#BOSHDispatcher.PlugIn">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="nbxmpp.dispatcher_nb.BOSHDispatcher-class.html#StreamInit" class="summary-sig-name">StreamInit</a>(<span class="summary-sig-arg">self</span>)</span><br />
Send an initial stream header</td>
<td align="right" valign="top">
<span class="codelink"><a href="nbxmpp.dispatcher_nb-pysrc.html#BOSHDispatcher.StreamInit">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="nbxmpp.dispatcher_nb.BOSHDispatcher-class.html#StreamTerminate" class="summary-sig-name">StreamTerminate</a>(<span class="summary-sig-arg">self</span>)</span><br />
Send a stream terminator</td>
<td align="right" valign="top">
<span class="codelink"><a href="nbxmpp.dispatcher_nb-pysrc.html#BOSHDispatcher.StreamTerminate">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="nbxmpp.dispatcher_nb.BOSHDispatcher-class.html#ProcessNonBlocking" class="summary-sig-name">ProcessNonBlocking</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">data</span>=<span class="summary-sig-default">None</span>)</span><br />
Check incoming stream for data waiting</td>
<td align="right" valign="top">
<span class="codelink"><a href="nbxmpp.dispatcher_nb-pysrc.html#BOSHDispatcher.ProcessNonBlocking">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="nbxmpp.dispatcher_nb.BOSHDispatcher-class.html#dispatch" class="summary-sig-name">dispatch</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">stanza</span>,
<span class="summary-sig-arg">session</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">direct</span>=<span class="summary-sig-default">0</span>)</span><br />
Main procedure that performs XMPP stanza recognition and calling
apppropriate handlers for it. Called by simplexml</td>
<td align="right" valign="top">
<span class="codelink"><a href="nbxmpp.dispatcher_nb-pysrc.html#BOSHDispatcher.dispatch">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="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html">XMPPDispatcher</a></code></b>:
<code><a href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#Event">Event</a></code>,
<code><a href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#RegisterCycleHandler">RegisterCycleHandler</a></code>,
<code><a href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#RegisterDefaultHandler">RegisterDefaultHandler</a></code>,
<code><a href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#RegisterEventHandler">RegisterEventHandler</a></code>,
<code><a href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#RegisterHandler">RegisterHandler</a></code>,
<code><a href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#RegisterHandlerOnce">RegisterHandlerOnce</a></code>,
<code><a href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#RegisterNamespace">RegisterNamespace</a></code>,
<code><a href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#RegisterNamespaceHandler">RegisterNamespaceHandler</a></code>,
<code><a href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#RegisterProtocol">RegisterProtocol</a></code>,
<code><a href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#SendAndCallForResponse">SendAndCallForResponse</a></code>,
<code><a href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#SendAndWaitForResponse">SendAndWaitForResponse</a></code>,
<code><a href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#UnregisterCycleHandler">UnregisterCycleHandler</a></code>,
<code><a href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#UnregisterHandler">UnregisterHandler</a></code>,
<code><a href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#__init__">__init__</a></code>,
<code><a href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#dumpHandlers">dumpHandlers</a></code>,
<code><a href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#getAnID">getAnID</a></code>,
<code><a href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#plugin">plugin</a></code>,
<code><a href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#plugout">plugout</a></code>,
<code><a href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#replace_non_character">replace_non_character</a></code>,
<code><a href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#restoreHandlers">restoreHandlers</a></code>,
<code><a href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#returnStanzaHandler">returnStanzaHandler</a></code>,
<code><a href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#send">send</a></code>
</p>
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html">XMPPDispatcher</a></code></b> (private):
<code><a href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#_WaitForData" onclick="show_private();">_WaitForData</a></code>,
<code><a href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#_check_stream_start" onclick="show_private();">_check_stream_start</a></code>,
<code><a href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#_init" onclick="show_private();">_init</a></code>
</p></div>
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="nbxmpp.plugin.PlugIn-class.html">plugin.PlugIn</a></code></b>:
<code><a href="nbxmpp.plugin.PlugIn-class.html#PlugOut">PlugOut</a></code>
</p>
</td>
</tr>
</table>
<!-- ==================== CLASS METHODS ==================== -->
<a name="section-ClassMethods"></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">Class Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-ClassMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="nbxmpp.plugin.PlugIn-class.html">plugin.PlugIn</a></code></b>:
<code><a href="nbxmpp.plugin.PlugIn-class.html#get_instance">get_instance</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="PlugIn"></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">PlugIn</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">owner</span>,
<span class="sig-arg">after_SASL</span>=<span class="sig-default">False</span>,
<span class="sig-arg">old_features</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="nbxmpp.dispatcher_nb-pysrc.html#BOSHDispatcher.PlugIn">source code</a></span>
</td>
</tr></table>
Attach to owner and register ourself and our _exported_methods in it.
If defined by a subclass, call self.plugin(owner) to execute hook
code after plugging
<dl class="fields">
<dt>Overrides:
<a href="nbxmpp.plugin.PlugIn-class.html#PlugIn">plugin.PlugIn.PlugIn</a>
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<a name="StreamInit"></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">StreamInit</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="nbxmpp.dispatcher_nb-pysrc.html#BOSHDispatcher.StreamInit">source code</a></span>
</td>
</tr></table>
Send an initial stream header
<dl class="fields">
<dt>Overrides:
<a href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#StreamInit">XMPPDispatcher.StreamInit</a>
</dt>
</dl>
</td></tr></table>
</div>
<a name="StreamTerminate"></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">StreamTerminate</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="nbxmpp.dispatcher_nb-pysrc.html#BOSHDispatcher.StreamTerminate">source code</a></span>
</td>
</tr></table>
Send a stream terminator
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="ProcessNonBlocking"></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">ProcessNonBlocking</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">data</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="nbxmpp.dispatcher_nb-pysrc.html#BOSHDispatcher.ProcessNonBlocking">source code</a></span>
</td>
</tr></table>
Check incoming stream for data waiting
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>data</code></strong> - data received from transports/IO sockets</li>
</ul></dd>
<dt>Returns:</dt>
<dd><ol class="rst-arabic simple">
<li>length of processed data if some data were processed;</li>
<li>'0' string if no data were processed but link is alive;</li>
<li>0 (zero) if underlying connection is closed.</li>
</ol></dd>
<dt>Overrides:
<a href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#ProcessNonBlocking">XMPPDispatcher.ProcessNonBlocking</a>
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<a name="dispatch"></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">dispatch</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">stanza</span>,
<span class="sig-arg">session</span>=<span class="sig-default">None</span>,
<span class="sig-arg">direct</span>=<span class="sig-default">0</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="nbxmpp.dispatcher_nb-pysrc.html#BOSHDispatcher.dispatch">source code</a></span>
</td>
</tr></table>
Main procedure that performs XMPP stanza recognition and calling
apppropriate handlers for it. Called by simplexml
<dl class="fields">
<dt>Overrides:
<a href="nbxmpp.dispatcher_nb.XMPPDispatcher-class.html#dispatch">XMPPDispatcher.dispatch</a>
<dd><em class="note">(inherited documentation)</em></dd>
</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="nbxmpp-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>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://python-nbxmpp.gajim.org">python-nbxmpp</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Fri Jul 26 11:25:12 2013
</td>
<td align="right" class="footer">
<a target="mainFrame" 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>
|
