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
|
<?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.idlequeue.GlibIdleQueue</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.idlequeue-module.html">Module idlequeue</a> ::
Class GlibIdleQueue
</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.idlequeue.GlibIdleQueue-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class GlibIdleQueue</h1><p class="nomargin-top"><span class="codelink"><a href="nbxmpp.idlequeue-pysrc.html#GlibIdleQueue">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_nbxmpp_i" name="uml_class_diagram_for_nbxmpp_i">
<area shape="rect" id="node15" href="nbxmpp.idlequeue.GlibIdleQueue-class.html#PROCESS_TIMEOUT" title="nbxmpp.idlequeue.GlibIdleQueue.PROCESS_TIMEOUT" alt="" coords="109,239,241,257"/>
<area shape="rect" id="node15" href="nbxmpp.idlequeue.GlibIdleQueue-class.html#process" title="Process idlequeue. Check for any pending timeout or alarm events.  Call IdleObjects on possible and requested read, write and error events on their file descriptors" alt="" coords="109,260,241,279"/>
<area shape="rect" id="node1" href="nbxmpp.idlequeue.GlibIdleQueue-class.html" title="Extends IdleQueue to use glib io_add_wath, instead of select/poll In another 'non gui' implementation of Gajim IdleQueue can be used safetly" alt="" coords="97,214,252,285"/>
<area shape="rect" id="node16" href="nbxmpp.idlequeue.IdleQueue-class.html#__init__" title="nbxmpp.idlequeue.IdleQueue.__init__" alt="" coords="17,39,335,57"/>
<area shape="rect" id="node16" href="nbxmpp.idlequeue.IdleQueue-class.html#set_alarm" title="Set up a new alarm. alarm_cb will be called after specified seconds." alt="" coords="17,57,335,76"/>
<area shape="rect" id="node16" href="nbxmpp.idlequeue.IdleQueue-class.html#remove_alarm" title="Remove alarm callback alarm_cb scheduled on alarm_time. Returns True if it was removed sucessfully, otherwise False" alt="" coords="17,76,335,95"/>
<area shape="rect" id="node16" href="nbxmpp.idlequeue.IdleQueue-class.html#remove_timeout" title="Remove the read timeout" alt="" coords="17,95,335,113"/>
<area shape="rect" id="node16" href="nbxmpp.idlequeue.IdleQueue-class.html#set_read_timeout" title="Seta a new timeout. If it is not removed after specified seconds, func or obj.read_timeout() will be called" alt="" coords="17,113,335,132"/>
<area shape="rect" id="node16" href="nbxmpp.idlequeue.IdleQueue-class.html#plug_idle" title="Plug an IdleObject into idlequeue. Filedescriptor fd must be set" alt="" coords="17,132,335,151"/>
<area shape="rect" id="node16" href="nbxmpp.idlequeue.IdleQueue-class.html#unplug_idle" title="Remove plugged IdleObject, specified by filedescriptor fd" alt="" coords="17,151,335,169"/>
<area shape="rect" id="node16" href="nbxmpp.idlequeue.IdleQueue-class.html#current_time" title="nbxmpp.idlequeue.IdleQueue.current_time" alt="" coords="17,169,335,188"/>
<area shape="rect" id="node2" href="nbxmpp.idlequeue.IdleQueue-class.html" title="IdleQueue provide three distinct time based features. Uses select.poll()" alt="" coords="5,6,347,194"/>
</map>
<img src="uml_class_diagram_for_nbxmpp_i.gif" alt='' usemap="#uml_class_diagram_for_nbxmpp_i" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
Extends IdleQueue to use glib io_add_wath, instead of select/poll In another
'non gui' implementation of Gajim IdleQueue can be used safetly
<!-- ==================== 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 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.idlequeue.GlibIdleQueue-class.html#_init_idle" class="summary-sig-name" onclick="show_private();">_init_idle</a>(<span class="summary-sig-arg">self</span>)</span><br />
Creates a dict, which maps file/pipe/sock descriptor to glib event id</td>
<td align="right" valign="top">
<span class="codelink"><a href="nbxmpp.idlequeue-pysrc.html#GlibIdleQueue._init_idle">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.idlequeue.GlibIdleQueue-class.html#_add_idle" class="summary-sig-name" onclick="show_private();">_add_idle</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">fd</span>,
<span class="summary-sig-arg">flags</span>)</span><br />
This method is called when we plug a new idle object. Start listening for
events from fd</td>
<td align="right" valign="top">
<span class="codelink"><a href="nbxmpp.idlequeue-pysrc.html#GlibIdleQueue._add_idle">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.idlequeue.GlibIdleQueue-class.html#_process_events" class="summary-sig-name" onclick="show_private();">_process_events</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">fd</span>,
<span class="summary-sig-arg">flags</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="nbxmpp.idlequeue-pysrc.html#GlibIdleQueue._process_events">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.idlequeue.GlibIdleQueue-class.html#_remove_idle" class="summary-sig-name" onclick="show_private();">_remove_idle</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">fd</span>)</span><br />
This method is called when we unplug a new idle object. Stop listening
for events from fd</td>
<td align="right" valign="top">
<span class="codelink"><a href="nbxmpp.idlequeue-pysrc.html#GlibIdleQueue._remove_idle">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.idlequeue.GlibIdleQueue-class.html#process" class="summary-sig-name">process</a>(<span class="summary-sig-arg">self</span>)</span><br />
Process idlequeue. Check for any pending timeout or alarm events. Call
IdleObjects on possible and requested read, write and error events on
their file descriptors</td>
<td align="right" valign="top">
<span class="codelink"><a href="nbxmpp.idlequeue-pysrc.html#GlibIdleQueue.process">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.idlequeue.IdleQueue-class.html">IdleQueue</a></code></b>:
<code><a href="nbxmpp.idlequeue.IdleQueue-class.html#__init__">__init__</a></code>,
<code><a href="nbxmpp.idlequeue.IdleQueue-class.html#current_time">current_time</a></code>,
<code><a href="nbxmpp.idlequeue.IdleQueue-class.html#plug_idle">plug_idle</a></code>,
<code><a href="nbxmpp.idlequeue.IdleQueue-class.html#remove_alarm">remove_alarm</a></code>,
<code><a href="nbxmpp.idlequeue.IdleQueue-class.html#remove_timeout">remove_timeout</a></code>,
<code><a href="nbxmpp.idlequeue.IdleQueue-class.html#set_alarm">set_alarm</a></code>,
<code><a href="nbxmpp.idlequeue.IdleQueue-class.html#set_read_timeout">set_read_timeout</a></code>,
<code><a href="nbxmpp.idlequeue.IdleQueue-class.html#unplug_idle">unplug_idle</a></code>
</p>
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="nbxmpp.idlequeue.IdleQueue-class.html">IdleQueue</a></code></b> (private):
<code><a href="nbxmpp.idlequeue.IdleQueue-class.html#_check_time_events" onclick="show_private();">_check_time_events</a></code>
</p></div>
</td>
</tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></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 Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-ClassVariables"
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">
<a href="nbxmpp.idlequeue.GlibIdleQueue-class.html#PROCESS_TIMEOUT" class="summary-name">PROCESS_TIMEOUT</a> = <code title="(2, True)"><code class="variable-group">(</code>2<code class="variable-op">, </code>True<code class="variable-group">)</code></code>
</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_idle"></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">_init_idle</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="nbxmpp.idlequeue-pysrc.html#GlibIdleQueue._init_idle">source code</a></span>
</td>
</tr></table>
Creates a dict, which maps file/pipe/sock descriptor to glib event id
<dl class="fields">
<dt>Overrides:
<a href="nbxmpp.idlequeue.IdleQueue-class.html#_init_idle" onclick="show_private();">IdleQueue._init_idle</a>
</dt>
</dl>
</td></tr></table>
</div>
<a name="_add_idle"></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">_add_idle</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">fd</span>,
<span class="sig-arg">flags</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="nbxmpp.idlequeue-pysrc.html#GlibIdleQueue._add_idle">source code</a></span>
</td>
</tr></table>
This method is called when we plug a new idle object. Start listening for
events from fd
<dl class="fields">
<dt>Overrides:
<a href="nbxmpp.idlequeue.IdleQueue-class.html#_add_idle" onclick="show_private();">IdleQueue._add_idle</a>
</dt>
</dl>
</td></tr></table>
</div>
<a name="_process_events"></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">_process_events</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">fd</span>,
<span class="sig-arg">flags</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="nbxmpp.idlequeue-pysrc.html#GlibIdleQueue._process_events">source code</a></span>
</td>
</tr></table>
<dl class="fields">
<dt>Overrides:
<a href="nbxmpp.idlequeue.IdleQueue-class.html#_process_events" onclick="show_private();">IdleQueue._process_events</a>
</dt>
</dl>
</td></tr></table>
</div>
<a name="_remove_idle"></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">_remove_idle</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">fd</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="nbxmpp.idlequeue-pysrc.html#GlibIdleQueue._remove_idle">source code</a></span>
</td>
</tr></table>
This method is called when we unplug a new idle object. Stop listening
for events from fd
<dl class="fields">
<dt>Overrides:
<a href="nbxmpp.idlequeue.IdleQueue-class.html#_remove_idle" onclick="show_private();">IdleQueue._remove_idle</a>
</dt>
</dl>
</td></tr></table>
</div>
<a name="process"></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">process</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="nbxmpp.idlequeue-pysrc.html#GlibIdleQueue.process">source code</a></span>
</td>
</tr></table>
<p>Process idlequeue. Check for any pending timeout or alarm events. Call
IdleObjects on possible and requested read, write and error events on
their file descriptors</p>
<p>Call this in regular intervals.</p>
<dl class="fields">
<dt>Overrides:
<a href="nbxmpp.idlequeue.IdleQueue-class.html#process">IdleQueue.process</a>
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== CLASS VARIABLE DETAILS ==================== -->
<a name="section-ClassVariableDetails"></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">Class Variable Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-ClassVariableDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="PROCESS_TIMEOUT"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">PROCESS_TIMEOUT</h3>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
<code class="variable-group">(</code>2<code class="variable-op">, </code>True<code class="variable-group">)</code>
</pre></td></tr></table>
</dd>
</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 Tue May 8 11:18:05 2012
</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>
|
