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
|
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<html><head>
<title>Class: Timer::Timer</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link rel=StyleSheet href="../.././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript" language="JavaScript">
<!--
function popCode(url) {
window.open(url, "Code",
"resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}
//-->
</script>
</head>
<body bgcolor="white">
<table summary="Information on class" width="100%" border="0" cellspacing="0">
<tr class="title-row">
<td class="big-title-font">
<sup><font color="aqua">Class</font></sup> Timer::Timer
</td>
<td align="right">
<table summary="layout" cellspacing="0" cellpadding="2">
<tr valign="top">
<td class="small-title-font">In:</td>
<td class="small-title-font">
<a href="../../files/rbot/timer_rb.html" class="aqua">
rbot/timer.rb
</a>
<br />
</td>
</tr>
<tr>
<td class="small-title-font">Parent:</td>
<td class="small-title-font">
Object
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- banner header -->
<table summary="Diagram of classes and modules" width="100%">
<tr><td align="center">
<map name="map">
<area shape="RECT" coords="124,109,196,61" href="Action.html" alt="Class: Action">
<area shape="RECT" coords="28,109,100,61" href="Timer.html" alt="Class: Timer">
</map>
<img src="../../dot/m_4_0.png" usemap="#map" border=0 alt="Module: Timer">
</td></tr></table>
<div class="description"><p>
timer handler, manage multiple <a href="Action.html">Action</a> objects,
calling them when required. The timer must be ticked by whatever controls
it, i.e. regular calls to tick() at whatever granularity suits your
application's needs. Alternatively you can call run(), and the timer will
tick itself, but this blocks so you gotta do it in a thread (remember
ruby's threads block on syscalls so that can suck).
</p>
</div>
<table summary="Methods" cellpadding="5" width="100%">
<tr><td class="tablesubtitle">Methods</td></tr>
</table>
<div class="name-list">
<a href="#M000191">add</a>
<a href="#M000192">add_once</a>
<a href="#M000194">block</a>
<a href="#M000190">new</a>
<a href="#M000193">remove</a>
<a href="#M000197">run</a>
<a href="#M000196">tick</a>
<a href="#M000195">unblock</a>
</div>
<table summary="Method list" cellpadding="5" width="100%">
<tr><td class="tablesubtitle">Public Class methods</td></tr>
</table>
<table summary="method" width="100%" cellspacing="0" cellpadding="5" border="0">
<tr><td class="methodtitle">
<a name="M000190"></a>
<a href="Timer.src/M000190.html" target="Code" class="methodtitle"
onClick="popCode('Timer.src/M000190.html');return false;">
<b>new</b>()
</a>
</td></tr>
</table>
<table summary="Method list" cellpadding="5" width="100%">
<tr><td class="tablesubtitle">Public Instance methods</td></tr>
</table>
<table summary="method" width="100%" cellspacing="0" cellpadding="5" border="0">
<tr><td class="methodtitle">
<a name="M000191"></a>
<a href="Timer.src/M000191.html" target="Code" class="methodtitle"
onClick="popCode('Timer.src/M000191.html');return false;">
<b>add</b>(period, data=nil, &func)
</a>
</td></tr>
</table>
<div class="description">
<table>
<tr><td valign="top">period:</td><td>how often (seconds) to run the action
</td></tr>
<tr><td valign="top">data:</td><td>optional data to pass to the action's proc
</td></tr>
<tr><td valign="top">func:</td><td>associate a block with add() to perform the action
</td></tr>
</table>
<p>
add an action to the timer
</p>
</div>
<table summary="method" width="100%" cellspacing="0" cellpadding="5" border="0">
<tr><td class="methodtitle">
<a name="M000192"></a>
<a href="Timer.src/M000192.html" target="Code" class="methodtitle"
onClick="popCode('Timer.src/M000192.html');return false;">
<b>add_once</b>(period, data=nil, &func)
</a>
</td></tr>
</table>
<div class="description">
<table>
<tr><td valign="top">period:</td><td>how often (seconds) to run the action
</td></tr>
<tr><td valign="top">data:</td><td>optional data to pass to the action's proc
</td></tr>
<tr><td valign="top">func:</td><td>associate a block with add() to perform the action
</td></tr>
</table>
<p>
add an action to the timer which will be run just once, after
<tt>period</tt>
</p>
</div>
<table summary="method" width="100%" cellspacing="0" cellpadding="5" border="0">
<tr><td class="methodtitle">
<a name="M000193"></a>
<a href="Timer.src/M000193.html" target="Code" class="methodtitle"
onClick="popCode('Timer.src/M000193.html');return false;">
<b>remove</b>(handle)
</a>
</td></tr>
</table>
<div class="description">
<p>
remove action with handle <tt>handle</tt> from the timer
</p>
</div>
<table summary="method" width="100%" cellspacing="0" cellpadding="5" border="0">
<tr><td class="methodtitle">
<a name="M000194"></a>
<a href="Timer.src/M000194.html" target="Code" class="methodtitle"
onClick="popCode('Timer.src/M000194.html');return false;">
<b>block</b>(handle)
</a>
</td></tr>
</table>
<div class="description">
<p>
block action with handle <tt>handle</tt>
</p>
</div>
<table summary="method" width="100%" cellspacing="0" cellpadding="5" border="0">
<tr><td class="methodtitle">
<a name="M000195"></a>
<a href="Timer.src/M000195.html" target="Code" class="methodtitle"
onClick="popCode('Timer.src/M000195.html');return false;">
<b>unblock</b>(handle)
</a>
</td></tr>
</table>
<div class="description">
<p>
unblock action with handle <tt>handle</tt>
</p>
</div>
<table summary="method" width="100%" cellspacing="0" cellpadding="5" border="0">
<tr><td class="methodtitle">
<a name="M000196"></a>
<a href="Timer.src/M000196.html" target="Code" class="methodtitle"
onClick="popCode('Timer.src/M000196.html');return false;">
<b>tick</b>()
</a>
</td></tr>
</table>
<div class="description">
<p>
you can call this when you know you're idle, or you can split off a thread
and call the run() method to do it for you.
</p>
</div>
<table summary="method" width="100%" cellspacing="0" cellpadding="5" border="0">
<tr><td class="methodtitle">
<a name="M000197"></a>
<a href="Timer.src/M000197.html" target="Code" class="methodtitle"
onClick="popCode('Timer.src/M000197.html');return false;">
<b>run</b>(granularity=0.1)
</a>
</td></tr>
</table>
<div class="description">
<p>
the timer will tick() itself. this blocks, so run it in a thread, and watch
out for blocking syscalls
</p>
</div>
</body>
|
