generic-library/poco
1
0
Fork 0
mirror of https://github.com/pocoproject/poco.git synced 2025-05-03 15:58:23 +02:00
Code Issues Projects Releases Wiki Activity

trunk/branch integration: documentation

Browse Source
This commit is contained in:
Marian Krivos 2011-08-22 17:57:35 +00:00
parent aa5edec47a
commit 06dad528cf
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Foundation/include/Poco/Task.h
View File

@ -83,10 +83,14 @@ public:
/// The value will be between 0.0 (just started) /// The value will be between 0.0 (just started)
/// and 1.0 (completed). /// and 1.0 (completed).
void cancel(); virtual void cancel();
/// Requests the task to cancel itself. For cancellation /// Requests the task to cancel itself. For cancellation
/// to work, the task's runTask() method must periodically /// to work, the task's runTask() method must periodically
/// call isCancelled() and react accordingly. /// call isCancelled() and react accordingly.
///
/// Can be overridden to implement custom behavior,
/// but the base class implementation of cancel() should
/// be called to ensure proper behavior.
bool isCancelled() const; bool isCancelled() const;
/// Returns true if cancellation of the task has been /// Returns true if cancellation of the task has been