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
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
|
<?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.session.Session</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.session-module.html">Module session</a> ::
Class Session
</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.session.Session-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Session</h1><span class="codelink"><a href="xmpp.session-pysrc.html#Session">source code</a></span><br /><br />
The Session class instance is used for storing all session-related
info like credentials, socket/xml stream/session state flags, roster
items (in case of client type connection) etc. Session object have no
means of discovering is any info is ready to be read. Instead you should
use poll() (recomended) or select() methods for this purpose. Session can
be one of two types: 'server' and 'client'. 'server' session handles
inbound connection and 'client' one used to create an outbound one.
Session instance have multitude of internal attributes. The most imporant
is the 'peer' one. It is set once the peer is authenticated (client).<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.session.Session-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">socket</span>,
<span class="summary-sig-arg">owner</span>,
<span class="summary-sig-arg">xmlns</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">peer</span>=<span class="summary-sig-default">None</span>)</span><br />
When the session is created it's type (client/server) is
determined from the beginning.</td>
<td align="right" valign="top">
<span class="codelink"><a href="xmpp.session-pysrc.html#Session.__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.session.Session-class.html#StartStream" class="summary-sig-name">StartStream</a>(<span class="summary-sig-arg">self</span>)</span><br />
This method is used to initialise the internal xml expat parser
and to send initial stream header (in case of client connection).</td>
<td align="right" valign="top">
<span class="codelink"><a href="xmpp.session-pysrc.html#Session.StartStream">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.session.Session-class.html#receive" class="summary-sig-name">receive</a>(<span class="summary-sig-arg">self</span>)</span><br />
Reads all pending incoming data.</td>
<td align="right" valign="top">
<span class="codelink"><a href="xmpp.session-pysrc.html#Session.receive">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.session.Session-class.html#sendnow" class="summary-sig-name">sendnow</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">chunk</span>)</span><br />
Put chunk into "immidiatedly send" queue.</td>
<td align="right" valign="top">
<span class="codelink"><a href="xmpp.session-pysrc.html#Session.sendnow">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.session.Session-class.html#enqueue" class="summary-sig-name">enqueue</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">stanza</span>)</span><br />
Takes Protocol instance as argument.</td>
<td align="right" valign="top">
<span class="codelink"><a href="xmpp.session-pysrc.html#Session.enqueue">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.session.Session-class.html#push_queue" class="summary-sig-name">push_queue</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">failreason</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">urn:ietf:params:xml:ns:xmpp-stanzas recipient-unavailable</code><code class="variable-quote">'</code></span>)</span><br />
If stream is authenticated than move items from "send"
queue to "immidiatedly send" queue.</td>
<td align="right" valign="top">
<span class="codelink"><a href="xmpp.session-pysrc.html#Session.push_queue">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.session.Session-class.html#flush_queue" class="summary-sig-name">flush_queue</a>(<span class="summary-sig-arg">self</span>)</span><br />
Put the "immidiatedly send" queue content on the
wire.</td>
<td align="right" valign="top">
<span class="codelink"><a href="xmpp.session-pysrc.html#Session.flush_queue">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<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.session.Session-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">trusted</span>=<span class="summary-sig-default">0</span>)</span><br />
This is callback that is used to pass the received stanza forth to
owner's dispatcher _if_ the stream is authorised.</td>
<td align="right" valign="top">
<span class="codelink"><a href="xmpp.session-pysrc.html#Session._dispatch">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<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.session.Session-class.html#_catch_stream_id" class="summary-sig-name">_catch_stream_id</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">ns</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">tag</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">stream</code><code class="variable-quote">'</code></span>,
<span class="summary-sig-arg">attrs</span>=<span class="summary-sig-default"><code class="variable-group">{</code><code class="variable-group">}</code></span>)</span><br />
This callback is used to detect the stream namespace of incoming
stream.</td>
<td align="right" valign="top">
<span class="codelink"><a href="xmpp.session-pysrc.html#Session._catch_stream_id">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<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.session.Session-class.html#_stream_open" class="summary-sig-name">_stream_open</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">ns</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">tag</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">stream</code><code class="variable-quote">'</code></span>,
<span class="summary-sig-arg">attrs</span>=<span class="summary-sig-default"><code class="variable-group">{</code><code class="variable-group">}</code></span>)</span><br />
This callback is used to handle opening stream tag of the incoming
stream.</td>
<td align="right" valign="top">
<span class="codelink"><a href="xmpp.session-pysrc.html#Session._stream_open">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="feature"></a><span class="summary-sig-name">feature</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">feature</span>)</span><br />
Declare some stream feature as activated one.</td>
<td align="right" valign="top">
<span class="codelink"><a href="xmpp.session-pysrc.html#Session.feature">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.session.Session-class.html#unfeature" class="summary-sig-name">unfeature</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">feature</span>)</span><br />
Declare some feature as illegal.</td>
<td align="right" valign="top">
<span class="codelink"><a href="xmpp.session-pysrc.html#Session.unfeature">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<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.session.Session-class.html#_stream_close" class="summary-sig-name">_stream_close</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">unregister</span>=<span class="summary-sig-default">1</span>)</span><br />
Write the closing stream tag and destroy the underlaying
socket.</td>
<td align="right" valign="top">
<span class="codelink"><a href="xmpp.session-pysrc.html#Session._stream_close">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.session.Session-class.html#terminate_stream" class="summary-sig-name">terminate_stream</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">error</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">unregister</span>=<span class="summary-sig-default">1</span>)</span><br />
Notify the peer about stream closure.</td>
<td align="right" valign="top">
<span class="codelink"><a href="xmpp.session-pysrc.html#Session.terminate_stream">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<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="_destroy_socket"></a><span class="summary-sig-name">_destroy_socket</span>(<span class="summary-sig-arg">self</span>)</span><br />
Break cyclic dependancies to let python's GC free memory right
now.</td>
<td align="right" valign="top">
<span class="codelink"><a href="xmpp.session-pysrc.html#Session._destroy_socket">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="start_feature"></a><span class="summary-sig-name">start_feature</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">f</span>)</span><br />
Declare some feature as "negotiating now" to prevent
other features from start negotiating.</td>
<td align="right" valign="top">
<span class="codelink"><a href="xmpp.session-pysrc.html#Session.start_feature">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="stop_feature"></a><span class="summary-sig-name">stop_feature</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">f</span>)</span><br />
Declare some feature as "negotiated" to allow other
features start negotiating.</td>
<td align="right" valign="top">
<span class="codelink"><a href="xmpp.session-pysrc.html#Session.stop_feature">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.session.Session-class.html#set_socket_state" class="summary-sig-name">set_socket_state</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">newstate</span>)</span><br />
Change the underlaying socket state.</td>
<td align="right" valign="top">
<span class="codelink"><a href="xmpp.session-pysrc.html#Session.set_socket_state">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.session.Session-class.html#set_session_state" class="summary-sig-name">set_session_state</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">newstate</span>)</span><br />
Change the session state.</td>
<td align="right" valign="top">
<span class="codelink"><a href="xmpp.session-pysrc.html#Session.set_session_state">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.session.Session-class.html#set_stream_state" class="summary-sig-name">set_stream_state</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">newstate</span>)</span><br />
Change the underlaying XML stream state Stream starts with
STREAM__NOT_OPENED and then proceeds with STREAM__OPENED,
STREAM__CLOSING and STREAM__CLOSED states.</td>
<td align="right" valign="top">
<span class="codelink"><a href="xmpp.session-pysrc.html#Session.set_stream_state">source code</a></span>
</td>
</tr>
</table>
</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">socket</span>,
<span class="sig-arg">owner</span>,
<span class="sig-arg">xmlns</span>=<span class="sig-default">None</span>,
<span class="sig-arg">peer</span>=<span class="sig-default">None</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="xmpp.session-pysrc.html#Session.__init__">source code</a></span>
</td>
</table>
When the session is created it's type (client/server) is determined
from the beginning. socket argument is the pre-created socket-like
object. It must have the following methods: send, recv, fileno, close.
owner is the 'master' instance that have Dispatcher plugged into it and
generally will take care about all session events. xmlns is the stream
namespace that will be used. Client must set this argument If server sets
this argument than stream will be dropped if opened with some another
namespace. peer is the name of peer instance. This is the flag that
differentiates client session from server session. Client must set it to
the name of the server that will be connected, server must leave this
argument alone.
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="StartStream"></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">StartStream</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="xmpp.session-pysrc.html#Session.StartStream">source code</a></span>
</td>
</table>
This method is used to initialise the internal xml expat parser and to
send initial stream header (in case of client connection). Should be used
after initial connection and after every stream restart.
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="receive"></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">receive</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="xmpp.session-pysrc.html#Session.receive">source code</a></span>
</td>
</table>
Reads all pending incoming data. Raises IOError on disconnection.
Blocks until at least one byte is read.
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="sendnow"></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">sendnow</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">chunk</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="xmpp.session-pysrc.html#Session.sendnow">source code</a></span>
</td>
</table>
Put chunk into "immidiatedly send" queue. Should only be
used for auth/TLS stuff and like. If you just want to shedule regular
stanza for delivery use enqueue method.
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="enqueue"></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">enqueue</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">stanza</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="xmpp.session-pysrc.html#Session.enqueue">source code</a></span>
</td>
</table>
Takes Protocol instance as argument. Puts stanza into "send"
fifo queue. Items into the send queue are hold until stream
authenticated. After that this method is effectively the same as
"sendnow" method.
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="push_queue"></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">push_queue</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">failreason</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">urn:ietf:params:xml:ns:xmpp-stanzas recipient-unavailable</code><code class="variable-quote">'</code></span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="xmpp.session-pysrc.html#Session.push_queue">source code</a></span>
</td>
</table>
If stream is authenticated than move items from "send" queue
to "immidiatedly send" queue. Else if the stream is failed then
return all queued stanzas with error passed as argument. Otherwise do
nothing.
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="flush_queue"></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">flush_queue</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="xmpp.session-pysrc.html#Session.flush_queue">source code</a></span>
</td>
</table>
Put the "immidiatedly send" queue content on the wire.
Blocks until at least one byte sent.
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="_dispatch"></a>
<div class="private">
<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">trusted</span>=<span class="sig-default">0</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="xmpp.session-pysrc.html#Session._dispatch">source code</a></span>
</td>
</table>
This is callback that is used to pass the received stanza forth to
owner's dispatcher _if_ the stream is authorised. Otherwise the stanza is
just dropped. The 'trusted' argument is used to emulate stanza receive.
This method is used internally.
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="_catch_stream_id"></a>
<div class="private">
<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">_catch_stream_id</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">ns</span>=<span class="sig-default">None</span>,
<span class="sig-arg">tag</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">stream</code><code class="variable-quote">'</code></span>,
<span class="sig-arg">attrs</span>=<span class="sig-default"><code class="variable-group">{</code><code class="variable-group">}</code></span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="xmpp.session-pysrc.html#Session._catch_stream_id">source code</a></span>
</td>
</table>
This callback is used to detect the stream namespace of incoming
stream. Used internally.
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="_stream_open"></a>
<div class="private">
<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">_stream_open</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">ns</span>=<span class="sig-default">None</span>,
<span class="sig-arg">tag</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">stream</code><code class="variable-quote">'</code></span>,
<span class="sig-arg">attrs</span>=<span class="sig-default"><code class="variable-group">{</code><code class="variable-group">}</code></span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="xmpp.session-pysrc.html#Session._stream_open">source code</a></span>
</td>
</table>
This callback is used to handle opening stream tag of the incoming
stream. In the case of client session it just make some validation.
Server session also sends server headers and if the stream valid the
features node. Used internally.
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="unfeature"></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">unfeature</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">feature</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="xmpp.session-pysrc.html#Session.unfeature">source code</a></span>
</td>
</table>
Declare some feature as illegal. Illegal features can not be used.
Example: BIND feature becomes illegal after Non-SASL auth.
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="_stream_close"></a>
<div class="private">
<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">_stream_close</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">unregister</span>=<span class="sig-default">1</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="xmpp.session-pysrc.html#Session._stream_close">source code</a></span>
</td>
</table>
Write the closing stream tag and destroy the underlaying socket. Used
internally.
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="terminate_stream"></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">terminate_stream</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">error</span>=<span class="sig-default">None</span>,
<span class="sig-arg">unregister</span>=<span class="sig-default">1</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="xmpp.session-pysrc.html#Session.terminate_stream">source code</a></span>
</td>
</table>
Notify the peer about stream closure. Ensure that xmlstream is not
brokes - i.e. if the stream isn't opened yet - open it before closure. If
the error condition is specified than create a stream error and send it
along with closing stream tag. Emulate receiving 'unavailable' type
presence just before stream closure.
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="set_socket_state"></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">set_socket_state</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">newstate</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="xmpp.session-pysrc.html#Session.set_socket_state">source code</a></span>
</td>
</table>
Change the underlaying socket state. Socket starts with
SOCKET_UNCONNECTED state and then proceeds (possibly) to SOCKET_ALIVE and
then to SOCKET_DEAD
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="set_session_state"></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">set_session_state</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">newstate</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="xmpp.session-pysrc.html#Session.set_session_state">source code</a></span>
</td>
</table>
Change the session state. Session starts with SESSION_NOT_AUTHED state
and then comes through SESSION_AUTHED, SESSION_BOUND, SESSION_OPENED and
SESSION_CLOSED states.
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="set_stream_state"></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">set_stream_state</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">newstate</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="xmpp.session-pysrc.html#Session.set_stream_state">source code</a></span>
</td>
</table>
Change the underlaying XML stream state Stream starts with
STREAM__NOT_OPENED and then proceeds with STREAM__OPENED, STREAM__CLOSING
and STREAM__CLOSED states. Note that some features (like TLS and SASL)
requires stream re-start so this state can have non-linear changes.
<dl class="fields">
</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:17 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>
|
