threadpool.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2010 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 CXXTOOLS_THREADPOOL_H
30 #define CXXTOOLS_THREADPOOL_H
31 
32 #include <cxxtools/callable.h>
33 #include <cxxtools/timespan.h>
34 
35 namespace cxxtools
36 {
37  class ThreadPoolImpl;
38 
39  class ThreadPool
40  {
41  ThreadPool(const ThreadPool&) { }
42  ThreadPool& operator=(const ThreadPool&) { return *this; }
43 
44  public:
52  class Future
53  {
54  friend class ThreadPoolImpl;
55 
56  class FutureImpl;
57  FutureImpl* _impl;
58  Future(FutureImpl* impl);
59 
60  public:
63  : _impl(0)
64  { }
65 
67  Future(const Future& f);
68 
70  Future& operator=(const Future& f);
71 
72  ~Future();
73 
79  bool wait(Seconds timeout = -1) const;
80 
82  bool isWaiting() const;
83 
85  bool isRunning() const;
86 
93  bool isFinished() const;
94 
99  bool isCanceled() const;
100 
102  bool isFailed() const;
103 
104  };
105 
111  explicit ThreadPool(unsigned size, bool doStart = true);
112 
118  ~ThreadPool();
119 
122  void start();
123 
130  void stop(bool cancel = false);
131 
136  Future schedule(const Callable<void>& cb);
137 
140  bool running() const;
141 
144  bool stopped() const;
145 
146  private:
147  ThreadPoolImpl* _impl;
148  };
149 }
150 
151 #endif // CXXTOOLS_THREADPOOL_H