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
|
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"DTD/xhtml1-strict.dtd">
<html>
<head>
<title>API docs for “kiwi.tasklet.WaitForCall”</title>
<meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
<link href="apidocs.css" type="text/css" rel="stylesheet" />
</head>
<body>
<h1 class="class">Class k.t.WaitForCall(<a href="kiwi.tasklet.WaitCondition.html">WaitCondition</a>):</h1>
<p>
<span id="part">Part of <a href="kiwi.html">kiwi</a>.<a href="kiwi.tasklet.html">tasklet</a></span>
<a href="classIndex.html#kiwi.tasklet.WaitForCall">View In Hierarchy</a>
</p>
<div>
</div>
<div><p>An object that waits until it is called.</p>
This example demonstrates how a tasklet waits for a callback:
<pre class="literalblock">
import gobject
from kiwi import tasklet
mainloop = gobject.MainLoop()
def my_task():
callback = tasklet.WaitForCall()
gobject.timeout_add(1000, callback)
yield callback
mainloop.quit()
tasklet.run(my_task())
mainloop.run()
</pre>
<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Instance Variables</td><td class="fieldArg">return_value</td><td>value to return when called
</td></tr></table></div>
<div id="splitTables">
<table class="children sortable" id="id385">
<tr class="method">
<td>Method</td>
<td><a href="kiwi.tasklet.WaitForCall.html#__init__">__init__</a></td>
<td><span>Creates a wait condition that is actually a callable object, and waits
for a call to be made on it.
</span></td>
</tr><tr class="method">
<td>Method</td>
<td><a href="kiwi.tasklet.WaitForCall.html#arm">arm</a></td>
<td><span>Overrides WaitCondition.arm
</span></td>
</tr><tr class="method">
<td>Method</td>
<td><a href="kiwi.tasklet.WaitForCall.html#disarm">disarm</a></td>
<td><span>Overrides WaitCondition.disarm
</span></td>
</tr><tr class="method">
<td>Method</td>
<td><a href="kiwi.tasklet.WaitForCall.html#__call__">__call__</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr>
</table>
</div>
<div class="function">
<a name="kiwi.tasklet.WaitForCall.__init__"></a>
<a name="__init__"></a>
<div class="functionHeader">
def __init__(self, return_value=None):
</div>
<div class="functionBody">
<div class="interfaceinfo">overrides <a href="kiwi.tasklet.WaitCondition.html#__init__">kiwi.tasklet.WaitCondition.__init__</a></div>
<div>Creates a wait condition that is actually a callable object, and waits
for a call to be made on it.
<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">return_value</td><td>value to return when called; can also be modified dynamically from the
tasklet as the <code>return_value</code> instance variable.
</td></tr></table></div>
</div>
</div><div class="function">
<a name="kiwi.tasklet.WaitForCall.arm"></a>
<a name="arm"></a>
<div class="functionHeader">
def arm(self, tasklet):
</div>
<div class="functionBody">
<div class="interfaceinfo">overrides <a href="kiwi.tasklet.WaitCondition.html#arm">kiwi.tasklet.WaitCondition.arm</a></div>
<div>Overrides WaitCondition.arm
<table class="fieldTable"></table></div>
</div>
</div><div class="function">
<a name="kiwi.tasklet.WaitForCall.disarm"></a>
<a name="disarm"></a>
<div class="functionHeader">
def disarm(self):
</div>
<div class="functionBody">
<div class="interfaceinfo">overrides <a href="kiwi.tasklet.WaitCondition.html#disarm">kiwi.tasklet.WaitCondition.disarm</a></div>
<div>Overrides WaitCondition.disarm
<table class="fieldTable"></table></div>
</div>
</div><div class="function">
<a name="kiwi.tasklet.WaitForCall.__call__"></a>
<a name="__call__"></a>
<div class="functionHeader">
def __call__(self, *args, **kwargs):
</div>
<div class="functionBody">
<div class="undocumented">Undocumented</div>
</div>
</div>
<address>
<a href="index.html">API Documentation</a> for Kiwi, generated by <a href="http://codespeak.net/~mwh/pydoctor/">pydoctor</a> at 2008-05-29 16:06:17.
</address>
</body>
</html>
|
