-
Notifications
You must be signed in to change notification settings - Fork 7
Expand file tree
/
Copy pathTask.html
More file actions
710 lines (610 loc) · 22.5 KB
/
Copy pathTask.html
File metadata and controls
710 lines (610 loc) · 22.5 KB
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
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
<!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>Task - Abstract task base class. : 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>Task</b></li>
</ul>
</div>
<div id="main">
<h1>Task - Abstract task base class.</h1>
This is the abstract base class for all tasks. 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>
<h3>Notes on priority constants</h3>
The only things you may assume about the values of priority contants are:
<ul>
<li>Each priority constant differ at least a value of 100 from other priority constants.
That is, <tt>abs(c1 - c2) >= 300</tt> if c1 and c2 are two random priority constants.</li>
<li>A higher value means a higher priority.
</li>
</ul>
<p><table class="functionIndex">
<tr><th colspan="3">Constructor</th></tr><tr onclick="location.href='#Task->new';">
<td class="return-type"></td>
<td class="func"><a href="#Task->new">Task->new</a></td>
<td class="decl">(options...)</td>
</tr>
</table>
<p><table class="functionIndex">
<tr><th colspan="3">Events</th></tr><tr onclick="location.href='#$Task->onMutexesChanged';">
<td class="return-type"><a href="Utils--CallbackList.html">CallbackList</a></td>
<td class="func"><a href="#$Task->onMutexesChanged">$Task->onMutexesChanged</a></td>
<td class="decl">()</td>
</tr><tr onclick="location.href='#$Task->onStop';">
<td class="return-type"><a href="Utils--CallbackList.html">CallbackList</a></td>
<td class="func"><a href="#$Task->onStop">$Task->onStop</a></td>
<td class="decl">()</td>
</tr>
</table>
<p><table class="functionIndex">
<tr><th colspan="3">Priority constants</th></tr><tr onclick="location.href='#Task::HIGH_PRIORITY';">
<td class="return-type"></td>
<td class="func"><a href="#Task::HIGH_PRIORITY">Task::HIGH_PRIORITY</a></td>
<td class="decl"></td>
</tr><tr onclick="location.href='#Task::LOW_PRIORITY';">
<td class="return-type"></td>
<td class="func"><a href="#Task::LOW_PRIORITY">Task::LOW_PRIORITY</a></td>
<td class="decl"></td>
</tr><tr onclick="location.href='#Task::NORMAL_PRIORITY';">
<td class="return-type"></td>
<td class="func"><a href="#Task::NORMAL_PRIORITY">Task::NORMAL_PRIORITY</a></td>
<td class="decl"></td>
</tr><tr onclick="location.href='#Task::USER_PRIORITY';">
<td class="return-type"></td>
<td class="func"><a href="#Task::USER_PRIORITY">Task::USER_PRIORITY</a></td>
<td class="decl"></td>
</tr>
</table>
<p><table class="functionIndex">
<tr><th colspan="3">Protected commands</th></tr><tr onclick="location.href='#$Task->setDone';">
<td class="return-type">void</td>
<td class="func"><a href="#$Task->setDone">$Task->setDone</a></td>
<td class="decl">()</td>
</tr><tr onclick="location.href='#$Task->setError';">
<td class="return-type">void</td>
<td class="func"><a href="#$Task->setError">$Task->setError</a></td>
<td class="decl">(<span class="type">code,</span> message)</td>
</tr><tr onclick="location.href='#$Task->setMutexes';">
<td class="return-type">void</td>
<td class="func"><a href="#$Task->setMutexes">$Task->setMutexes</a></td>
<td class="decl">(mutexes...)</td>
</tr><tr onclick="location.href='#$Task->setStopped';">
<td class="return-type">void</td>
<td class="func"><a href="#$Task->setStopped">$Task->setStopped</a></td>
<td class="decl">()</td>
</tr>
</table>
<p><table class="functionIndex">
<tr><th colspan="3">Public commands</th></tr><tr onclick="location.href='#$Task->activate';">
<td class="return-type">void</td>
<td class="func"><a href="#$Task->activate">$Task->activate</a></td>
<td class="decl">()</td>
</tr><tr onclick="location.href='#$Task->interrupt';">
<td class="return-type">void</td>
<td class="func"><a href="#$Task->interrupt">$Task->interrupt</a></td>
<td class="decl">()</td>
</tr><tr onclick="location.href='#$Task->iterate';">
<td class="return-type">void</td>
<td class="func"><a href="#$Task->iterate">$Task->iterate</a></td>
<td class="decl">()</td>
</tr><tr onclick="location.href='#$Task->resume';">
<td class="return-type">void</td>
<td class="func"><a href="#$Task->resume">$Task->resume</a></td>
<td class="decl">()</td>
</tr><tr onclick="location.href='#$Task->stop';">
<td class="return-type">void</td>
<td class="func"><a href="#$Task->stop">$Task->stop</a></td>
<td class="decl">()</td>
</tr>
</table>
<p><table class="functionIndex">
<tr><th colspan="3">Queries</th></tr><tr onclick="location.href='#$Task->getError';">
<td class="return-type">Hash*</td>
<td class="func"><a href="#$Task->getError">$Task->getError</a></td>
<td class="decl">()</td>
</tr><tr onclick="location.href='#$Task->getMutexes';">
<td class="return-type">Array<String>*</td>
<td class="func"><a href="#$Task->getMutexes">$Task->getMutexes</a></td>
<td class="decl">()</td>
</tr><tr onclick="location.href='#$Task->getName';">
<td class="return-type">String</td>
<td class="func"><a href="#$Task->getName">$Task->getName</a></td>
<td class="decl">()</td>
</tr><tr onclick="location.href='#$Task->getPriority';">
<td class="return-type">int</td>
<td class="func"><a href="#$Task->getPriority">$Task->getPriority</a></td>
<td class="decl">()</td>
</tr><tr onclick="location.href='#$Task->getStatus';">
<td class="return-type"></td>
<td class="func"><a href="#$Task->getStatus">$Task->getStatus</a></td>
<td class="decl">()</td>
</tr>
</table>
<p><table class="functionIndex">
<tr><th colspan="3">Status constants</th></tr><tr onclick="location.href='#Task::DONE';">
<td class="return-type"></td>
<td class="func"><a href="#Task::DONE">Task::DONE</a></td>
<td class="decl"></td>
</tr><tr onclick="location.href='#Task::INACTIVE';">
<td class="return-type"></td>
<td class="func"><a href="#Task::INACTIVE">Task::INACTIVE</a></td>
<td class="decl"></td>
</tr><tr onclick="location.href='#Task::INTERRUPTED';">
<td class="return-type"></td>
<td class="func"><a href="#Task::INTERRUPTED">Task::INTERRUPTED</a></td>
<td class="decl"></td>
</tr><tr onclick="location.href='#Task::RUNNING';">
<td class="return-type"></td>
<td class="func"><a href="#Task::RUNNING">Task::RUNNING</a></td>
<td class="decl"></td>
</tr><tr onclick="location.href='#Task::STOPPED';">
<td class="return-type"></td>
<td class="func"><a href="#Task::STOPPED">Task::STOPPED</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="$Task->activate"></a>
<h3>$Task->activate</h3>
<dl>
<dt class="decl">
<span class="return-type"> void</span> <strong>$Task->activate</strong>()
</dt>
<dd>
<dl class="params_and_returns">
<dt class="requires"><strong>Requires:</strong></dt>
<dd class="requires">$self->getStatus() == Task::INACTIVE</dd>
<dt class="ensures"><strong>Ensures:</strong></dt>
<dd class="ensures"><code>$self->getStatus()</code> == Task::RUNNING</dd>
</dl><p>
<div class="desc">Notify a task that it will be activated. Activation happens only once:
just before <code>iterate()</code> is called, but only if the task has just been created.
This allows the task to perform initialization.
<p>
This method will be called by the task manager.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$Task->getError"></a>
<h3>$Task->getError</h3>
<dl>
<dt class="decl">
<span class="return-type"> Hash*</span> <strong>$Task->getError</strong>()
</dt>
<dd>
<dl class="params_and_returns">
<dt class="requires"><strong>Requires:</strong></dt>
<dd class="requires">$self->getStatus() == Task::DONE</dd>
</dl><p>
<div class="desc">If the status is Task::DONE, then return information about the error (if the task
completed with an error).
Otherwise (if the task completed successfully), return undef.
<p>
The error information is a reference to a hash, containing two items:
<ul>
<li>code - The error code.</li>
<li>message - The error message.
</li>
</ul></div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$Task->getMutexes"></a>
<h3>$Task->getMutexes</h3>
<dl>
<dt class="decl">
<span class="return-type"> Array<String>*</span> <strong>$Task->getMutexes</strong>()
</dt>
<dd>
<dl class="params_and_returns">
<dt class="ensures"><strong>Ensures:</strong></dt>
<dd class="ensures">defined(result)</dd>
</dl><p>
<div class="desc">Returns a reference to an array of mutexes for this task. Note that the mutex list may
change during a Task's life time. This list must not be modified outside the Task object.
<p>
If you override this method, then you <b>must</b> ensure that when the mutex list changes,
you trigger a onMutexesChanged event. Otherwise the task manager will not behave correctly.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$Task->getName"></a>
<h3>$Task->getName</h3>
<dl>
<dt class="decl">
<span class="return-type"> String</span> <strong>$Task->getName</strong>()
</dt>
<dd>
<dl class="params_and_returns">
<dt class="ensures"><strong>Ensures:</strong></dt>
<dd class="ensures"><code>$result</code> ne ""</dd>
</dl><p>
<div class="desc">Returns a human-readable name for this task.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$Task->getPriority"></a>
<h3>$Task->getPriority</h3>
<dl>
<dt class="decl">
<span class="return-type"> int</span> <strong>$Task->getPriority</strong>()
</dt>
<dd>
<div class="desc">Get the priority for this task. This priority is guaranteed to never change during a Task's
life time.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$Task->getStatus"></a>
<h3>$Task->getStatus</h3>
<dl>
<dt class="decl">
<span class="return-type"> </span><strong>$Task->getStatus</strong>()
</dt>
<dd>
<div class="desc">Returns the task's status. This is one of Task::RUNNING, Task::INTERRUPTED, Task::STOPPED or Task::DONE.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$Task->interrupt"></a>
<h3>$Task->interrupt</h3>
<dl>
<dt class="decl">
<span class="return-type"> void</span> <strong>$Task->interrupt</strong>()
</dt>
<dd>
<dl class="params_and_returns">
<dt class="requires"><strong>Requires:</strong></dt>
<dd class="requires">$self->getStatus() == Task::RUNNING</dd>
<dt class="ensures"><strong>Ensures:</strong></dt>
<dd class="ensures"><code>$self->getStatus()</code> == Task::INTERRUPTED</dd>
</dl><p>
<div class="desc">Notify a (running) task that it is about to be interrupted. The task may take necessary actions
(like updating internal timers) in preparation for interruption. The task must immediately
cease all actions, and set the status to Task::INTERRUPTED.
<p>
This method should only be called by the task manager.
<p>
Task implementors may override this method to implement code for interruption handling.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$Task->iterate"></a>
<h3>$Task->iterate</h3>
<dl>
<dt class="decl">
<span class="return-type"> void</span> <strong>$Task->iterate</strong>()
</dt>
<dd>
<dl class="params_and_returns">
<dt class="requires"><strong>Requires:</strong></dt>
<dd class="requires">$self->getStatus() == Task::RUNNING</dd>
</dl><p>
<div class="desc">Run one iteration of this task. Task implementors must override this method to
implement task code.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$Task->onMutexesChanged"></a>
<h3>$Task->onMutexesChanged</h3>
<dl>
<dt class="decl">
<span class="return-type"> <a href="Utils--CallbackList.html">CallbackList</a></span> <strong>$Task->onMutexesChanged</strong>()
</dt>
<dd>
<div class="desc">This event is triggered when the mutex list for this task has changed.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$Task->onStop"></a>
<h3>$Task->onStop</h3>
<dl>
<dt class="decl">
<span class="return-type"> <a href="Utils--CallbackList.html">CallbackList</a></span> <strong>$Task->onStop</strong>()
</dt>
<dd>
<div class="desc">This event is triggered when the task's status has been set to Task::STOPPED.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$Task->resume"></a>
<h3>$Task->resume</h3>
<dl>
<dt class="decl">
<span class="return-type"> void</span> <strong>$Task->resume</strong>()
</dt>
<dd>
<dl class="params_and_returns">
<dt class="requires"><strong>Requires:</strong></dt>
<dd class="requires">$self->getStatus() == Task::INTERRUPTED</dd>
<dt class="ensures"><strong>Ensures:</strong></dt>
<dd class="ensures"><code>$self->getStatus()</code> == Task::RUNNING</dd>
</dl><p>
<div class="desc">Notify an (interrupted) task that it is about to be resumed. The task may take
necessary actions in prepration for resuming. The task must set its status to
Task::RUNNING.
<p>
This method should only be called by the task manager.
<p>
Task implementors may override this method to implement code for resume handling.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$Task->setDone"></a>
<h3>$Task->setDone</h3>
<dl>
<dt class="decl">
<span class="return-type"> void</span> <strong>$Task->setDone</strong>()
</dt>
<dd>
<dl class="params_and_returns">
<dt class="requires"><strong>Requires:</strong></dt>
<dd class="requires">$self->getStatus() == Task::INACTIVE or Task::RUNNING</dd>
</dl><p>
<div class="desc">Indicate that the task has been completed, without error. The
status will be set to Task::DONE.
<p>
Do not call this method outside <a href="Task.html#$Task->iterate"><code>$Task->iterate()</code></a>, or bad things will happen!</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$Task->setError"></a>
<h3>$Task->setError</h3>
<dl>
<dt class="decl">
<span class="return-type"> void</span> <strong>$Task->setError</strong>(<span class="type">code,</span> message)
</dt>
<dd>
<dl class="params_and_returns">
<dt class="params"><strong>Parameters:</strong></dt>
<dd class="param"><code>code</code> : An error code.</dd>
<dd class="param"><code>message</code> : An error message.</dd>
<dt class="requires"><strong>Requires:</strong></dt>
<dd class="requires">$self->getStatus() == Task::INACTIVE or Task::RUNNING</dd>
</dl><p>
<div class="desc">Indicate that the task has been completed, but with an error.
The status will be set to Task::DONE, and <a href="Task.html#$Task->getError"><code>$Task->getError()</code></a> will return
the error information passed to this method.
<p>
Do not call this method outside <a href="Task.html#$Task->iterate"><code>$Task->iterate()</code></a>, or bad things will happen!</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$Task->setMutexes"></a>
<h3>$Task->setMutexes</h3>
<dl>
<dt class="decl">
<span class="return-type"> void</span> <strong>$Task->setMutexes</strong>(mutexes...)
</dt>
<dd>
<div class="desc">Set the currently active mutexes for this task. This will trigger an
onMutexesChanged event.
<p>
You should only call this method inside the class's <code>iterate()</code> method,
or during initialization. Otherwise you may confuse the task manager.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$Task->setStopped"></a>
<h3>$Task->setStopped</h3>
<dl>
<dt class="decl">
<span class="return-type"> void</span> <strong>$Task->setStopped</strong>()
</dt>
<dd>
<dl class="params_and_returns">
<dt class="requires"><strong>Requires:</strong></dt>
<dd class="requires">$self->getStatus() == Task::RUNNING, Task::INACTIVE or Task::INTERRUPTED</dd>
<dt class="ensures"><strong>Ensures:</strong></dt>
<dd class="ensures"><code>$self->getStatus()</code> == Task::STOPPED</dd>
</dl><p>
<div class="desc">Set the task's status to Task::STOPPED and trigger an onStop event.
This is useful for tasks that cannot stop immediately
when <code>stop()</code> is called: they can mark the task as stopped when appropriate.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$Task->stop"></a>
<h3>$Task->stop</h3>
<dl>
<dt class="decl">
<span class="return-type"> void</span> <strong>$Task->stop</strong>()
</dt>
<dd>
<dl class="params_and_returns">
<dt class="requires"><strong>Requires:</strong></dt>
<dd class="requires">$self->getStatus() == Task::RUNNING, Task::INACTIVE or Task::INTERRUPTED</dd>
</dl><p>
<div class="desc">Notify a task that it must completely stop. When the task is actually stopped,
the status must be set to Task::STOPPED.
<p>
The default behavior is to immediate set the status to Task::STOPPED
by calling <a href="Task.html#$Task->setStopped"><code>$Task->setStopped()</code></a>, thereby triggering an onStop event.
Task implementors may override this method to implement custom stop handling.
You may choose to stop the task after a period of time, instead of immediately.
<p>
This method may be called by anybody, not just the task manager.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="Task->new"></a>
<h3>Task->new</h3>
<dl>
<dt class="decl">
<span class="return-type"> </span><strong>Task->new</strong>(options...)
</dt>
<dd>
<dl class="params_and_returns">
<dt class="ensures"><strong>Ensures:</strong></dt>
<dd class="ensures"><code>result->getStatus()</code> == Task::INACTIVE</dd>
</dl><p>
<div class="desc">Create a new Task object. The following options are allowed:
<ul>
<li><tt>name</tt> - A name for this task. <a href="Task.html#$Task->getName"><code>$Task->getName()</code></a> will return this name.
If not specified, the class's name (excluding the "Task::" prefix) will be used as name.</li>
<li><tt>priority</tt> - A priority for this task. <a href="Task.html#$Task->getPriority"><code>$Task->getPriority()</code></a> will return this value.
The default priority is Task::NORMAL_PRIORITY</li>
<li><tt>mutexes</tt> - A reference to an array of mutexes. <a href="Task.html#$Task->getMutexes"><code>$Task->getMutexes()</code></a> will return this value.
The default is an empty mutex list.
</li>
</ul></div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="Task::DONE"></a>
<h3>Task::DONE</h3>
<dl>
<dt class="decl">
<span class="return-type"> </span><strong>Task::DONE</strong>
</dt>
<dd>
<div class="desc">Indicates that the task is completed. A completed task cannot be stopped or interrupted.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="Task::HIGH_PRIORITY"></a>
<h3>Task::HIGH_PRIORITY</h3>
<dl>
<dt class="decl">
<span class="return-type"> </span><strong>Task::HIGH_PRIORITY</strong>
</dt>
<dd>
<div class="desc">Indicates a high task priority.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="Task::INACTIVE"></a>
<h3>Task::INACTIVE</h3>
<dl>
<dt class="decl">
<span class="return-type"> </span><strong>Task::INACTIVE</strong>
</dt>
<dd>
<div class="desc">Indicates that the task has just been created.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="Task::INTERRUPTED"></a>
<h3>Task::INTERRUPTED</h3>
<dl>
<dt class="decl">
<span class="return-type"> </span><strong>Task::INTERRUPTED</strong>
</dt>
<dd>
<div class="desc">Indicates that the task is interrupted, and not running.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="Task::LOW_PRIORITY"></a>
<h3>Task::LOW_PRIORITY</h3>
<dl>
<dt class="decl">
<span class="return-type"> </span><strong>Task::LOW_PRIORITY</strong>
</dt>
<dd>
<div class="desc">Indicates a low task priority.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="Task::NORMAL_PRIORITY"></a>
<h3>Task::NORMAL_PRIORITY</h3>
<dl>
<dt class="decl">
<span class="return-type"> </span><strong>Task::NORMAL_PRIORITY</strong>
</dt>
<dd>
<div class="desc">Indicates a normal task priority.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="Task::RUNNING"></a>
<h3>Task::RUNNING</h3>
<dl>
<dt class="decl">
<span class="return-type"> </span><strong>Task::RUNNING</strong>
</dt>
<dd>
<div class="desc">Indicates that the task is running.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="Task::STOPPED"></a>
<h3>Task::STOPPED</h3>
<dl>
<dt class="decl">
<span class="return-type"> </span><strong>Task::STOPPED</strong>
</dt>
<dd>
<div class="desc">Indicates that the task is stopped. A stopped task cannot resume.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="Task::USER_PRIORITY"></a>
<h3>Task::USER_PRIORITY</h3>
<dl>
<dt class="decl">
<span class="return-type"> </span><strong>Task::USER_PRIORITY</strong>
</dt>
<dd>
<div class="desc">Priority used for user-invoked commands.</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>