File: Poco.Util.TimerTask.html

package info (click to toggle)
poco-doc 1.3.6-1
  • links: PTS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, squeeze, stretch, wheezy
  • size: 10,076 kB
  • ctags: 9,611
  • sloc: makefile: 31
file content (76 lines) | stat: -rw-r--r-- 5,628 bytes parent folder | download | duplicates (2)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Class Poco::Util::TimerTask</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
<meta name="author" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="publisher" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="copyright" content="Copyright (c) 2009, Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="language" content="en"/>
<meta name="date" content="2009-11-24"/>
<meta name="generator" content="PocoDoc"/>
<link rel="stylesheet" href="css/styles.css" type="text/css"/>
</head>
<body bgcolor="#ffffff" leftmargin="0" topmargin="0">
<div class="header">
<h1 class="namespace"><a href="Poco.Util.html" class="namespace">Poco::Util</a></h1>
<h1 class="symbol">class TimerTask</h1>
</div>
<div class="body">
<p>
<b>Library:</b> Util<br />
<b>Package:</b> Timer<br />
<b>Header:</b> Poco/Util/TimerTask.h</p>
<h2>Description</h2>
<div class="description">
<p>A task that can be scheduled for one-time or  repeated execution by a <a href="Poco.Util.Timer.html" title="class Poco::Util::Timer">Timer</a>. </p>
<p>This is an abstract class. Subclasses must override the run() member function to implement the actual task logic. </p>
</div>
<h2>Inheritance</h2>
<p><b>Direct Base Classes: </b><a href="Poco.RefCountedObject.html" title="class Poco::RefCountedObject">Poco::RefCountedObject</a>, <a href="Poco.Runnable.html" title="class Poco::Runnable">Poco::Runnable</a></p>
<p><b>All Base Classes: </b><a href="Poco.RefCountedObject.html" title="class Poco::RefCountedObject">Poco::RefCountedObject</a>, <a href="Poco.Runnable.html" title="class Poco::Runnable">Poco::Runnable</a></p>
<p><b>Known Derived Classes: </b><a href="Poco.Util.TimerTaskAdapter.html" title="class Poco::Util::TimerTaskAdapter">TimerTaskAdapter</a></p>
<h2>Member Summary</h2>
<p><b>Member Functions: </b><a href="Poco.Util.TimerTask.html#17295" title="Poco::Util::TimerTask::cancel()">cancel</a>, <a href="Poco.Util.TimerTask.html#17296" title="Poco::Util::TimerTask::isCancelled()">isCancelled</a>, <a href="Poco.Util.TimerTask.html#17297" title="Poco::Util::TimerTask::lastExecution()">lastExecution</a></p>
<p><b>Inherited Functions: </b><a href="Poco.RefCountedObject.html#9659" title="Poco::RefCountedObject::duplicate()">duplicate</a>, <a href="Poco.RefCountedObject.html#9661" title="Poco::RefCountedObject::referenceCount()">referenceCount</a>, <a href="Poco.RefCountedObject.html#9660" title="Poco::RefCountedObject::release()">release</a>, <a href="Poco.Runnable.html#9810" title="Poco::Runnable::run()">run</a></p>
<h2>Types</h2>
<h3><a name="17293">Ptr</a></h3>
<p class="decl">typedef <a href="Poco.AutoPtr.html" title="class Poco::AutoPtr">Poco::AutoPtr</a> &lt; <a href="Poco.Util.TimerTask.html" title="class Poco::Util::TimerTask">TimerTask</a> &gt; <a href="Poco.Util.TimerTask.html#17293" title="Poco::Util::TimerTask::Ptr">Ptr</a>;</p>
<div class="description">
<p></p>
</div>
<h2>Constructors</h2>
<h3><a name="17294">TimerTask</a></h3>
<p class="decl"><a href="Poco.Util.TimerTask.html" title="class Poco::Util::TimerTask">TimerTask</a>();</p>
<div class="description">
<p>Creates the <a href="Poco.Util.TimerTask.html" title="class Poco::Util::TimerTask">TimerTask</a>. </p>
</div>
<h2>Destructor</h2>
<h3><a name="17298">~TimerTask</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" />  <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">~<a href="Poco.Util.TimerTask.html" title="class Poco::Util::TimerTask">TimerTask</a>();</p>
<div class="description">
<p>Destroys the <a href="Poco.Util.TimerTask.html" title="class Poco::Util::TimerTask">TimerTask</a>. </p>
</div>
<h2>Member Functions</h2>
<h3><a name="17295">cancel</a></h3>
<p class="decl">void cancel();</p>
<div class="description">
<p>Cancels the execution of the timer. If the task has been scheduled for one-time execution and has  not yet run, or has not yet been scheduled, it will never run.  If the task has been scheduled for repeated execution, it will never  run again. If the task is running when this call occurs, the task  will run to completion, but will never run again.	 </p>
</div>
<h3><a name="17296">isCancelled</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">bool isCancelled() const;</p>
<div class="description">
<p>Returns true if and only if the <a href="Poco.Util.TimerTask.html" title="class Poco::Util::TimerTask">TimerTask</a> has been cancelled by a call to <a href="Poco.Util.TimerTask.html#17295" title="Poco::Util::TimerTask::cancel()">cancel</a>(). </p>
</div>
<h3><a name="17297">lastExecution</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.Timestamp.html" title="class Poco::Timestamp">Poco::Timestamp</a> lastExecution() const;</p>
<div class="description">
<p>Returns the time of the last execution of the timer task. </p>
<p>Returns 0 if the timer has never been executed. </p>
</div>
<p class="footer">POCO C++ Libraries 1.3.6-all<br />
Copyright &copy; 2009, <a href="http://pocoproject.org/" target="_blank">Applied Informatics Software Engineering GmbH and Contributors</a></p>

</div>
</body>
</html>