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
|
<?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.transports_nb.NonBlockingHTTP</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.transports_nb-module.html">Module transports_nb</a> ::
Class NonBlockingHTTP
</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.transports_nb.NonBlockingHTTP-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class NonBlockingHTTP</h1><p class="nomargin-top"><span class="codelink"><a href="nbxmpp.transports_nb-pysrc.html#NonBlockingHTTP">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_nbxmpp_t_6" name="uml_class_diagram_for_nbxmpp_t_6">
<area shape="rect" id="node238" href="nbxmpp.transports_nb.NonBlockingHTTP-class.html#__init__" title="Each trasport class can have different constructor but it has to have at least all the arguments of NonBlockingTransport constructor" alt="" coords="17,719,989,737"/>
<area shape="rect" id="node238" href="nbxmpp.transports_nb.NonBlockingHTTP-class.html#http_send" title="nbxmpp.transports_nb.NonBlockingHTTP.http_send" alt="" coords="17,737,989,756"/>
<area shape="rect" id="node238" href="nbxmpp.transports_nb.NonBlockingHTTP-class.html#build_http_message" title="Builds http message with given body. Values for headers and status line fields are taken from class variables" alt="" coords="17,756,989,775"/>
<area shape="rect" id="node238" href="nbxmpp.transports_nb.NonBlockingHTTP-class.html#parse_http_message" title="(statusline - list of e.g. ['HTTP/1.1', '200', 'OK']," alt="" coords="17,775,989,793"/>
<area shape="rect" id="node1" href="nbxmpp.transports_nb.NonBlockingHTTP-class.html" title="Socket wrapper that creates HTTP message out of sent data and peels-off HTTP headers from incoming messages" alt="" coords="5,686,1000,799"/>
<area shape="rect" id="node6" href="nbxmpp.transports_nb.NonBlockingHTTPBOSH-class.html" title="Class for BOSH HTTP connections. Slightly redefines HTTP transport by calling bosh bodytag generating callback before putting data on wire" alt="" coords="412,819,596,858"/>
<area shape="rect" id="node239" href="nbxmpp.transports_nb.NonBlockingTCP-class.html#start_disconnect" title="nbxmpp.transports_nb.NonBlockingTCP.start_disconnect" alt="" coords="311,436,697,455"/>
<area shape="rect" id="node239" href="nbxmpp.transports_nb.NonBlockingTCP-class.html#connect" title="Creates and connects transport to server and port defined in conn_5tuple which should be item from list returned from getaddrinfo" alt="" coords="311,455,697,473"/>
<area shape="rect" id="node239" href="nbxmpp.transports_nb.NonBlockingTCP-class.html#tls_init" title="Estabilishes TLS/SSL using this TCP connection by plugging a NonBlockingTLS module" alt="" coords="311,473,697,492"/>
<area shape="rect" id="node239" href="nbxmpp.transports_nb.NonBlockingTCP-class.html#pollin" title="Called by idlequeu when receive on plugged socket is possible" alt="" coords="311,492,697,511"/>
<area shape="rect" id="node239" href="nbxmpp.transports_nb.NonBlockingTCP-class.html#pollout" title="Called by idlequeu when send to plugged socket is possible" alt="" coords="311,511,697,529"/>
<area shape="rect" id="node239" href="nbxmpp.transports_nb.NonBlockingTCP-class.html#pollend" title="Called by idlequeue on TCP connection errors" alt="" coords="311,529,697,548"/>
<area shape="rect" id="node239" href="nbxmpp.transports_nb.NonBlockingTCP-class.html#disconnect" title="nbxmpp.transports_nb.NonBlockingTCP.disconnect" alt="" coords="311,548,697,567"/>
<area shape="rect" id="node239" href="nbxmpp.transports_nb.NonBlockingTCP-class.html#read_timeout" title="Called when there's no response from server in defined timeout" alt="" coords="311,567,697,585"/>
<area shape="rect" id="node239" href="nbxmpp.transports_nb.NonBlockingTCP-class.html#set_timeout" title="nbxmpp.transports_nb.NonBlockingTCP.set_timeout" alt="" coords="311,585,697,604"/>
<area shape="rect" id="node239" href="nbxmpp.transports_nb.NonBlockingTCP-class.html#remove_timeout" title="nbxmpp.transports_nb.NonBlockingTCP.remove_timeout" alt="" coords="311,604,697,623"/>
<area shape="rect" id="node239" href="nbxmpp.transports_nb.NonBlockingTCP-class.html#send" title="Append raw_data to the queue of messages to be send. If supplied data is unicode string, encode it to utf-8." alt="" coords="311,623,697,641"/>
<area shape="rect" id="node239" href="nbxmpp.transports_nb.NonBlockingTCP-class.html#encode_stanza" title="Encode str or unicode to utf-8" alt="" coords="311,641,697,660"/>
<area shape="rect" id="node2" href="nbxmpp.transports_nb.NonBlockingTCP-class.html" title="Non-blocking TCP socket wrapper" alt="" coords="299,403,709,666"/>
<area shape="rect" id="node242" href="nbxmpp.idlequeue.IdleObject-class.html#fd" title="filedescriptor, must be unique for each IdleObject" alt="" coords="300,248,431,267"/>
<area shape="rect" id="node3" href="nbxmpp.idlequeue.IdleObject-class.html" title="Idle listener interface. Listed methods are called by IdleQueue." alt="" coords="288,223,443,281"/>
<area shape="rect" id="node240" href="nbxmpp.transports_nb.NonBlockingTransport-class.html#plugin" title="nbxmpp.transports_nb.NonBlockingTransport.plugin" alt="" coords="484,153,801,172"/>
<area shape="rect" id="node240" href="nbxmpp.transports_nb.NonBlockingTransport-class.html#plugout" title="nbxmpp.transports_nb.NonBlockingTransport.plugout" alt="" coords="484,172,801,191"/>
<area shape="rect" id="node240" href="nbxmpp.transports_nb.NonBlockingTransport-class.html#set_state" title="nbxmpp.transports_nb.NonBlockingTransport.set_state" alt="" coords="484,191,801,209"/>
<area shape="rect" id="node240" href="nbxmpp.transports_nb.NonBlockingTransport-class.html#get_state" title="nbxmpp.transports_nb.NonBlockingTransport.get_state" alt="" coords="484,209,801,228"/>
<area shape="rect" id="node240" href="nbxmpp.transports_nb.NonBlockingTransport-class.html#onreceive" title="Set the on_receive callback." alt="" coords="484,228,801,247"/>
<area shape="rect" id="node240" href="nbxmpp.transports_nb.NonBlockingTransport-class.html#read_timeout2" title="called when there's no response from server in defined timeout" alt="" coords="484,247,801,265"/>
<area shape="rect" id="node240" href="nbxmpp.transports_nb.NonBlockingTransport-class.html#renew_send_timeout" title="nbxmpp.transports_nb.NonBlockingTransport.renew_send_timeout" alt="" coords="484,265,801,284"/>
<area shape="rect" id="node240" href="nbxmpp.transports_nb.NonBlockingTransport-class.html#renew_send_timeout2" title="nbxmpp.transports_nb.NonBlockingTransport.renew_send_timeout2" alt="" coords="484,284,801,303"/>
<area shape="rect" id="node240" href="nbxmpp.transports_nb.NonBlockingTransport-class.html#set_timeout2" title="nbxmpp.transports_nb.NonBlockingTransport.set_timeout2" alt="" coords="484,303,801,321"/>
<area shape="rect" id="node240" href="nbxmpp.transports_nb.NonBlockingTransport-class.html#get_fd" title="nbxmpp.transports_nb.NonBlockingTransport.get_fd" alt="" coords="484,321,801,340"/>
<area shape="rect" id="node240" href="nbxmpp.transports_nb.NonBlockingTransport-class.html#set_send_timeout" title="nbxmpp.transports_nb.NonBlockingTransport.set_send_timeout" alt="" coords="484,340,801,359"/>
<area shape="rect" id="node240" href="nbxmpp.transports_nb.NonBlockingTransport-class.html#set_send_timeout2" title="nbxmpp.transports_nb.NonBlockingTransport.set_send_timeout2" alt="" coords="484,359,801,377"/>
<area shape="rect" id="node4" href="nbxmpp.transports_nb.NonBlockingTransport-class.html" title="Abstract class representing a transport" alt="" coords="472,121,813,383"/>
<area shape="rect" id="node241" href="nbxmpp.plugin.PlugIn-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="529,39,755,57"/>
<area shape="rect" id="node241" 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="529,57,755,76"/>
<area shape="rect" id="node241" href="nbxmpp.plugin.PlugIn-class.html#get_instance" title="Factory Method for object creation" alt="" coords="529,76,755,95"/>
<area shape="rect" id="node5" href="nbxmpp.plugin.PlugIn-class.html" title="Abstract xmpppy plugin infrastructure code, providing plugging in/out and debugging functionality" alt="" coords="517,6,765,101"/>
</map>
<img src="uml_class_diagram_for_nbxmpp_t_6.gif" alt='' usemap="#uml_class_diagram_for_nbxmpp_t_6" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
Socket wrapper that creates HTTP message out of sent data and peels-off HTTP
headers from incoming messages
<!-- ==================== 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.transports_nb.NonBlockingHTTP-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">raise_event</span>,
<span class="summary-sig-arg">on_disconnect</span>,
<span class="summary-sig-arg">idlequeue</span>,
<span class="summary-sig-arg">estabilish_tls</span>,
<span class="summary-sig-arg">certs</span>,
<span class="summary-sig-arg">on_http_request_possible</span>,
<span class="summary-sig-arg">on_persistent_fallback</span>,
<span class="summary-sig-arg">http_dict</span>,
<span class="summary-sig-arg">proxy_dict</span>=<span class="summary-sig-default">None</span>)</span><br />
Each trasport class can have different constructor but it has to have at
least all the arguments of NonBlockingTransport constructor</td>
<td align="right" valign="top">
<span class="codelink"><a href="nbxmpp.transports_nb-pysrc.html#NonBlockingHTTP.__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="nbxmpp.transports_nb.NonBlockingHTTP-class.html#http_send" class="summary-sig-name">http_send</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">raw_data</span>,
<span class="summary-sig-arg">now</span>=<span class="summary-sig-default">False</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="nbxmpp.transports_nb-pysrc.html#NonBlockingHTTP.http_send">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="nbxmpp.transports_nb.NonBlockingHTTP-class.html#_on_receive" class="summary-sig-name" onclick="show_private();">_on_receive</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">data</span>)</span><br />
Preceeds passing received data to owner class. Gets rid of HTTP headers
and checks them.</td>
<td align="right" valign="top">
<span class="codelink"><a href="nbxmpp.transports_nb-pysrc.html#NonBlockingHTTP._on_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="nbxmpp.transports_nb.NonBlockingHTTP-class.html#build_http_message" class="summary-sig-name">build_http_message</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">httpbody</span>,
<span class="summary-sig-arg">method</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">POST</code><code class="variable-quote">'</code></span>)</span><br />
Builds http message with given body. Values for headers and status line
fields are taken from class variables</td>
<td align="right" valign="top">
<span class="codelink"><a href="nbxmpp.transports_nb-pysrc.html#NonBlockingHTTP.build_http_message">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.transports_nb.NonBlockingHTTP-class.html#parse_http_message" class="summary-sig-name">parse_http_message</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">message</span>)</span><br />
(statusline - list of e.g. ['HTTP/1.1', '200', 'OK'],</td>
<td align="right" valign="top">
<span class="codelink"><a href="nbxmpp.transports_nb-pysrc.html#NonBlockingHTTP.parse_http_message">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.transports_nb.NonBlockingTCP-class.html">NonBlockingTCP</a></code></b>:
<code><a href="nbxmpp.transports_nb.NonBlockingTCP-class.html#connect">connect</a></code>,
<code><a href="nbxmpp.transports_nb.NonBlockingTCP-class.html#disconnect">disconnect</a></code>,
<code><a href="nbxmpp.transports_nb.NonBlockingTCP-class.html#encode_stanza">encode_stanza</a></code>,
<code><a href="nbxmpp.transports_nb.NonBlockingTCP-class.html#pollend">pollend</a></code>,
<code><a href="nbxmpp.transports_nb.NonBlockingTCP-class.html#pollin">pollin</a></code>,
<code><a href="nbxmpp.transports_nb.NonBlockingTCP-class.html#pollout">pollout</a></code>,
<code><a href="nbxmpp.transports_nb.NonBlockingTCP-class.html#read_timeout">read_timeout</a></code>,
<code><a href="nbxmpp.transports_nb.NonBlockingTCP-class.html#remove_timeout">remove_timeout</a></code>,
<code><a href="nbxmpp.transports_nb.NonBlockingTCP-class.html#send">send</a></code>,
<code><a href="nbxmpp.transports_nb.NonBlockingTCP-class.html#set_timeout">set_timeout</a></code>,
<code><a href="nbxmpp.transports_nb.NonBlockingTCP-class.html#start_disconnect">start_disconnect</a></code>,
<code><a href="nbxmpp.transports_nb.NonBlockingTCP-class.html#tls_init">tls_init</a></code>
</p>
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="nbxmpp.transports_nb.NonBlockingTCP-class.html">NonBlockingTCP</a></code></b> (private):
<code><a href="nbxmpp.transports_nb.NonBlockingTCP-class.html#_connect_to_proxy" onclick="show_private();">_connect_to_proxy</a></code>,
<code><a href="nbxmpp.transports_nb.NonBlockingTCP-class.html#_do_receive" onclick="show_private();">_do_receive</a></code>,
<code><a href="nbxmpp.transports_nb.NonBlockingTCP-class.html#_do_send" onclick="show_private();">_do_send</a></code>,
<code><a href="nbxmpp.transports_nb.NonBlockingTCP-class.html#_on_connect" onclick="show_private();">_on_connect</a></code>,
<code><a href="nbxmpp.transports_nb.NonBlockingTCP-class.html#_plug_idle" onclick="show_private();">_plug_idle</a></code>
</p></div>
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="nbxmpp.transports_nb.NonBlockingTransport-class.html">NonBlockingTransport</a></code></b>:
<code><a href="nbxmpp.transports_nb.NonBlockingTransport-class.html#get_fd">get_fd</a></code>,
<code><a href="nbxmpp.transports_nb.NonBlockingTransport-class.html#get_state">get_state</a></code>,
<code><a href="nbxmpp.transports_nb.NonBlockingTransport-class.html#onreceive">onreceive</a></code>,
<code><a href="nbxmpp.transports_nb.NonBlockingTransport-class.html#plugin">plugin</a></code>,
<code><a href="nbxmpp.transports_nb.NonBlockingTransport-class.html#plugout">plugout</a></code>,
<code><a href="nbxmpp.transports_nb.NonBlockingTransport-class.html#read_timeout2">read_timeout2</a></code>,
<code><a href="nbxmpp.transports_nb.NonBlockingTransport-class.html#renew_send_timeout">renew_send_timeout</a></code>,
<code><a href="nbxmpp.transports_nb.NonBlockingTransport-class.html#renew_send_timeout2">renew_send_timeout2</a></code>,
<code><a href="nbxmpp.transports_nb.NonBlockingTransport-class.html#set_send_timeout">set_send_timeout</a></code>,
<code><a href="nbxmpp.transports_nb.NonBlockingTransport-class.html#set_send_timeout2">set_send_timeout2</a></code>,
<code><a href="nbxmpp.transports_nb.NonBlockingTransport-class.html#set_state">set_state</a></code>,
<code><a href="nbxmpp.transports_nb.NonBlockingTransport-class.html#set_timeout2">set_timeout2</a></code>
</p>
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="nbxmpp.transports_nb.NonBlockingTransport-class.html">NonBlockingTransport</a></code></b> (private):
<code><a href="nbxmpp.transports_nb.NonBlockingTransport-class.html#_on_connect_failure" onclick="show_private();">_on_connect_failure</a></code>,
<code><a href="nbxmpp.transports_nb.NonBlockingTransport-class.html#_tcp_connecting_started" onclick="show_private();">_tcp_connecting_started</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#PlugIn">PlugIn</a></code>,
<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>
<!-- ==================== INSTANCE VARIABLES ==================== -->
<a name="section-InstanceVariables"></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 Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceVariables"
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.idlequeue.IdleObject-class.html">idlequeue.IdleObject</a></code></b>:
<code><a href="nbxmpp.idlequeue.IdleObject-class.html#fd">fd</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">raise_event</span>,
<span class="sig-arg">on_disconnect</span>,
<span class="sig-arg">idlequeue</span>,
<span class="sig-arg">estabilish_tls</span>,
<span class="sig-arg">certs</span>,
<span class="sig-arg">on_http_request_possible</span>,
<span class="sig-arg">on_persistent_fallback</span>,
<span class="sig-arg">http_dict</span>,
<span class="sig-arg">proxy_dict</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="nbxmpp.transports_nb-pysrc.html#NonBlockingHTTP.__init__">source code</a></span>
</td>
</tr></table>
Each trasport class can have different constructor but it has to have at
least all the arguments of NonBlockingTransport constructor
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>on_http_request_possible</code></strong> - method to call when HTTP request to
socket owned by transport is possible.</li>
<li><strong class="pname"><code>on_persistent_fallback</code></strong> - callback called when server ends TCP
connection. It doesn't have to be fatal for HTTP session.</li>
<li><strong class="pname"><code>http_dict</code></strong> - dictionary with data for HTTP request and headers</li>
</ul></dd>
<dt>Overrides:
<a href="nbxmpp.idlequeue.IdleObject-class.html#__init__">idlequeue.IdleObject.__init__</a>
</dt>
</dl>
</td></tr></table>
</div>
<a name="http_send"></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">http_send</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">raw_data</span>,
<span class="sig-arg">now</span>=<span class="sig-default">False</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="nbxmpp.transports_nb-pysrc.html#NonBlockingHTTP.http_send">source code</a></span>
</td>
</tr></table>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="_on_receive"></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">_on_receive</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">data</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="nbxmpp.transports_nb-pysrc.html#NonBlockingHTTP._on_receive">source code</a></span>
</td>
</tr></table>
Preceeds passing received data to owner class. Gets rid of HTTP headers
and checks them.
<dl class="fields">
<dt>Overrides:
<a href="nbxmpp.transports_nb.NonBlockingTCP-class.html#_on_receive" onclick="show_private();">NonBlockingTCP._on_receive</a>
</dt>
</dl>
</td></tr></table>
</div>
<a name="build_http_message"></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">build_http_message</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">httpbody</span>,
<span class="sig-arg">method</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">POST</code><code class="variable-quote">'</code></span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="nbxmpp.transports_nb-pysrc.html#NonBlockingHTTP.build_http_message">source code</a></span>
</td>
</tr></table>
Builds http message with given body. Values for headers and status line
fields are taken from class variables
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="parse_http_message"></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">parse_http_message</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">message</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="nbxmpp.transports_nb-pysrc.html#NonBlockingHTTP.parse_http_message">source code</a></span>
</td>
</tr></table>
<dl class="rst-docutils">
<dt>Split http message into a tuple:</dt>
<dd><ul class="rst-first rst-last">
<li><p class="rst-first">(statusline - list of e.g. ['HTTP/1.1', '200', 'OK'],</p>
</li>
<li><dl class="rst-first rst-docutils">
<dt>headers - dictionary of headers e.g. {'Content-Length': '604',</dt>
<dd><p class="rst-first rst-last">'Content-Type': 'text/xml; charset=utf-8'},</p>
</dd>
</dl>
</li>
<li><p class="rst-first">httpbody - string with http body)</p>
</li>
<li><p class="rst-first">http_rest - what is left in the message after a full HTTP header + body</p>
</li>
</ul>
</dd>
</dl>
<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="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:15 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>
|
