backgroundworker.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2011 Tommi Maekitalo
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * As a special exception, you may use this file as part of a free
10  * software library without restriction. Specifically, if other files
11  * instantiate templates or use macros or inline functions from this
12  * file, or you compile this file and link it with other files to
13  * produce an executable, this file does not by itself cause the
14  * resulting executable to be covered by the GNU General Public
15  * License. This exception does not however invalidate any other
16  * reasons why the executable file might be covered by the GNU Library
17  * General Public License.
18  *
19  * This library is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22  * Lesser General Public License for more details.
23  *
24  * You should have received a copy of the GNU Lesser General Public
25  * License along with this library; if not, write to the Free Software
26  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
27  */
28 
29 #ifndef TNT_BACKGROUNDWORKER_H
30 #define TNT_BACKGROUNDWORKER_H
31 
32 #include <cxxtools/refcounted.h>
33 #include <cxxtools/smartptr.h>
34 #include <cxxtools/threadpool.h>
35 #include <cxxtools/condition.h>
36 #include <cxxtools/mutex.h>
37 #include <cxxtools/timespan.h>
38 #include <cxxtools/clock.h>
39 #include <list>
40 
41 namespace tnt
42 {
44  {
45  friend class BackgroundWorker;
46 
47  public:
49 
51  : _progress(0),
52  _id(_nextId++),
53  _livetime(livetime),
54  _jobReady(0)
55  { }
56  virtual ~BackgroundTask()
57  { }
58 
59  unsigned id() const
60  { return _id; }
61  unsigned progress() const;
62  bool ready() const
63  { return progress() >= 100; }
65  { return _timeoutTime; }
67  { return _livetime; }
69 
70  void updateProgress(unsigned p);
71 
72  virtual void execute() = 0;
73 
74  private:
75  void doTask();
76  unsigned _progress;
77  unsigned _id;
78  static unsigned _nextId;
79  cxxtools::DateTime _timeoutTime;
80  cxxtools::Timespan _livetime;
81  mutable cxxtools::Mutex _mutex;
82  cxxtools::Condition* _jobReady;
83  };
84 
86  {
89 
90  public:
91  static BackgroundWorker& it();
92 
93  unsigned runTask(BackgroundTask::Pointer task);
94 
95  BackgroundTask::Pointer getTask(unsigned id) const;
96  void removeTask(unsigned id);
97 
98  private:
99  mutable cxxtools::Mutex _mutex;
100  cxxtools::Condition _jobReady;
101  cxxtools::ThreadPool _threadPool;
102  bool _running;
103  void timeoutCheckerFunc();
104 
105  typedef std::list<BackgroundTask::Pointer> Tasks;
106  Tasks tasks;
107 
108  };
109 }
110 
111 #endif // TNT_BACKGROUNDWORKER_H