-
Notifications
You must be signed in to change notification settings - Fork 7
/
Copy pathTaskManager.html
247 lines (203 loc) · 7.84 KB
/
TaskManager.html
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>TaskManager - Task manager. : OpenKore source code documentation</title>
<link rel="stylesheet" type="text/css" href="openkore.css">
<link rel="stylesheet" type="text/css" href="highlight.css">
<!-- Fix broken PNG transparency for IE/Win5-6+ -->
<!--[if gte IE 5.5000]>
<script type="text/javascript" src="pngfix.js"></script>
<![endif]-->
</head>
<body>
<div id="title">OpenKore source code documentation</div>
<div id="navigation">
<ul>
<li><a href="http://www.openkore.com/">Main website</a></li>
<li><a href="index.html">Table of contents</a></li>
<li><b>TaskManager</b></li>
</ul>
</div>
<div id="main">
<h1>TaskManager - Task manager.</h1>
Please read
<a href="http://wiki.openkore.com/index.php/AI_subsystem_and_task_framework_overview">
the AI subsystem and task framework overview
</a>
for an overview.
<p><table class="functionIndex">
<tr><th colspan="3">Functions in this module</th></tr><tr onclick="location.href='#TaskManager->new';">
<td class="return-type"></td>
<td class="func"><a href="#TaskManager->new">TaskManager->new</a></td>
<td class="decl">()</td>
</tr><tr onclick="location.href='#$TaskManager->activeMutexesString';">
<td class="return-type">String</td>
<td class="func"><a href="#$TaskManager->activeMutexesString">$TaskManager->activeMutexesString</a></td>
<td class="decl">()</td>
</tr><tr onclick="location.href='#$TaskManager->activeTasksString';">
<td class="return-type">String</td>
<td class="func"><a href="#$TaskManager->activeTasksString">$TaskManager->activeTasksString</a></td>
<td class="decl">()</td>
</tr><tr onclick="location.href='#$TaskManager->add';">
<td class="return-type">void</td>
<td class="func"><a href="#$TaskManager->add">$TaskManager->add</a></td>
<td class="decl">(<span class="type"><a href="Task.html">Task</a></span> task)</td>
</tr><tr onclick="location.href='#$TaskManager->checkValidity';">
<td class="return-type">void</td>
<td class="func"><a href="#$TaskManager->checkValidity">$TaskManager->checkValidity</a></td>
<td class="decl">()</td>
</tr><tr onclick="location.href='#$TaskManager->countTasksByName';">
<td class="return-type">int</td>
<td class="func"><a href="#$TaskManager->countTasksByName">$TaskManager->countTasksByName</a></td>
<td class="decl">(<span class="type">String</span> name)</td>
</tr><tr onclick="location.href='#$TaskManager->iterate';">
<td class="return-type">void</td>
<td class="func"><a href="#$TaskManager->iterate">$TaskManager->iterate</a></td>
<td class="decl">()</td>
</tr><tr onclick="location.href='#$TaskManager->onTaskFinished';">
<td class="return-type"><a href="Utils--CallbackList.html">CallbackList</a></td>
<td class="func"><a href="#$TaskManager->onTaskFinished">$TaskManager->onTaskFinished</a></td>
<td class="decl">()</td>
</tr><tr onclick="location.href='#$Taskmanager->stopAll';">
<td class="return-type">void</td>
<td class="func"><a href="#$Taskmanager->stopAll">$Taskmanager->stopAll</a></td>
<td class="decl">()</td>
</tr>
</table>
<p><hr class="details_sep">
<h2>Details</h2>
<div class="details">
<p>
<div class="function"><a name="$TaskManager->activeMutexesString"></a>
<h3>$TaskManager->activeMutexesString</h3>
<dl>
<dt class="decl">
<span class="return-type"> String</span> <strong>$TaskManager->activeMutexesString</strong>()
</dt>
<dd>
<div class="desc">Returns a string which describes the currently active mutexes.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$TaskManager->activeTasksString"></a>
<h3>$TaskManager->activeTasksString</h3>
<dl>
<dt class="decl">
<span class="return-type"> String</span> <strong>$TaskManager->activeTasksString</strong>()
</dt>
<dd>
<div class="desc">Returns a string which describes the currently inactive tasks.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$TaskManager->add"></a>
<h3>$TaskManager->add</h3>
<dl>
<dt class="decl">
<span class="return-type"> void</span> <strong>$TaskManager->add</strong>(<span class="type"><a href="Task.html">Task</a></span> task)
</dt>
<dd>
<dl class="params_and_returns">
<dt class="requires"><strong>Requires:</strong></dt>
<dd class="requires">$task->getStatus() == Task::INACTIVE</dd>
</dl><p>
<div class="desc">Add a new task to this task manager.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$TaskManager->checkValidity"></a>
<h3>$TaskManager->checkValidity</h3>
<dl>
<dt class="decl">
<span class="return-type"> void</span> <strong>$TaskManager->checkValidity</strong>()
</dt>
<dd>
<div class="desc">Check whether the internal invariants are correct. Dies if that is not the case.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$TaskManager->countTasksByName"></a>
<h3>$TaskManager->countTasksByName</h3>
<dl>
<dt class="decl">
<span class="return-type"> int</span> <strong>$TaskManager->countTasksByName</strong>(<span class="type">String</span> name)
</dt>
<dd>
<dl class="params_and_returns">
<dt class="ensures"><strong>Ensures:</strong></dt>
<dd class="ensures">result >= 0</dd>
</dl><p>
<div class="desc">Count the number of tasks that have the specified name.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$TaskManager->iterate"></a>
<h3>$TaskManager->iterate</h3>
<dl>
<dt class="decl">
<span class="return-type"> void</span> <strong>$TaskManager->iterate</strong>()
</dt>
<dd>
<div class="desc">Reschedule tasks if necessary, and run one iteration of every active task.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$TaskManager->onTaskFinished"></a>
<h3>$TaskManager->onTaskFinished</h3>
<dl>
<dt class="decl">
<span class="return-type"> <a href="Utils--CallbackList.html">CallbackList</a></span> <strong>$TaskManager->onTaskFinished</strong>()
</dt>
<dd>
<div class="desc">This event is triggered when a task is finished, either successfully
or with an error.
<p>
The event argument is a hash containing this item:<br>
<tt>task</tt> - The task that was finished.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$Taskmanager->stopAll"></a>
<h3>$Taskmanager->stopAll</h3>
<dl>
<dt class="decl">
<span class="return-type"> void</span> <strong>$Taskmanager->stopAll</strong>()
</dt>
<dd>
<div class="desc">Tell all tasks (whether active or inactive) to stop.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="TaskManager->new"></a>
<h3>TaskManager->new</h3>
<dl>
<dt class="decl">
<span class="return-type"> </span><strong>TaskManager->new</strong>()
</dt>
<dd>
<div class="desc">Create a new TaskManager.</div>
</dd>
</dl>
</div>
</div>
<p><hr><p>
<div id="footer">
<ul>
<li><a href="http://validator.w3.org/check?uri=referer" title="Valid HTML 4.01!"><img src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" height="31" width="88"></a></li>
<li><a href="http://www.mozilla.com/" title="Get Firefox - Take Back the Web"><img width="104" height="32" src="http://www.mozilla.org/products/firefox/buttons/getfirefox_small.png" alt="Get Firefox - Take Back the Web"></a></li>
<li><a href="http://www.mozilla.com/" title="If you were looking at this page in any browser but Microsoft Internet Explorer, it would look and run better and faster"><img width="45" height="45" src="http://linuxart.com/img/noIE-small.png" alt="If you were looking at this page in any browser but Microsoft Internet Explorer, it would look and run better and faster"></a></li>
</ul>
Last modified: Fri Nov 16 10:05:11 2012
</div>
</div>
</body>
</html>