RSC  0.17.1
SimpleTask.h
Go to the documentation of this file.
1 /* ============================================================
2  *
3  * This file is a part of the RSC project.
4  *
5  * Copyright (C) 2011 by Johannes Wienke <jwienke at techfak dot uni-bielefeld dot de>
6  *
7  * This file may be licensed under the terms of the
8  * GNU Lesser General Public License Version 3 (the ``LGPL''),
9  * or (at your option) any later version.
10  *
11  * Software distributed under the License is distributed
12  * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
13  * express or implied. See the LGPL for the specific language
14  * governing rights and limitations.
15  *
16  * You should have received a copy of the LGPL along with this
17  * program. If not, go to http://www.gnu.org/licenses/lgpl.html
18  * or write to the Free Software Foundation, Inc.,
19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20  *
21  * The development of this software was supported by:
22  * CoR-Lab, Research Institute for Cognition and Robotics
23  * Bielefeld University
24  *
25  * ============================================================ */
26 
27 #pragma once
28 
29 #include <boost/thread/recursive_mutex.hpp>
30 #include <boost/thread/condition.hpp>
31 
32 #include "Task.h"
33 #include "rsc/rscexports.h"
34 
35 namespace rsc {
36 namespace threading {
37 
47 class RSC_EXPORT SimpleTask: public Task {
48 public:
49 
50  SimpleTask();
51  virtual ~SimpleTask();
52 
53  virtual void cancel();
54 
55  virtual bool isCancelRequested();
56 
57  virtual void waitDone();
58 
59  virtual bool isDone();
60 
61 protected:
62  void markDone();
63 
64 private:
65 
66  mutable boost::recursive_mutex mutex;
67  boost::condition condition;
68 
69  volatile bool canceled;
70  volatile bool done;
71 
72 };
73 
74 }
75 }
boost::condition condition
Definition: SimpleTask.h:67
A task is a self.contained piece of work that can be executed by another thread.
Definition: Task.h:52
boost::recursive_mutex mutex
Definition: SimpleTask.h:66
A Task subclass which maintains interruption through a volatile boolean flag which should be processe...
Definition: SimpleTask.h:47
volatile bool canceled
Definition: SimpleTask.h:69