c++-gtk-utils

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- File List
- File Members

async_result.h
Go to the documentation of this file.
1 /* Copyright (C) 2012 and 2013 Chris Vine
2
3 The library comprised in this file or of which this file is part is
4 distributed by Chris Vine under the GNU Lesser General Public
5 License as follows:
6
7 This library is free software; you can redistribute it and/or
8 modify it under the terms of the GNU Lesser General Public License
9 as published by the Free Software Foundation; either version 2.1 of
10 the License, or (at your option) any later version.
11
12 This library is distributed in the hope that it will be useful, but
13 WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 Lesser General Public License, version 2.1, for more details.
16
17 You should have received a copy of the GNU Lesser General Public
18 License, version 2.1, along with this library (see the file LGPL.TXT
19 which came with this source code package in the c++-gtk-utils
20 sub-directory); if not, write to the Free Software Foundation, Inc.,
21 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22
23 However, it is not intended that the object code of a program whose
24 source code instantiates a template from this file or uses macros or
25 inline functions (of any length) should by reason only of that
26 instantiation or use be subject to the restrictions of use in the GNU
27 Lesser General Public License. With that in mind, the words "and
28 macros, inline functions and instantiations of templates (of any
29 length)" shall be treated as substituted for the words "and small
30 macros and small inline functions (ten lines or less in length)" in
31 the fourth paragraph of section 5 of that licence. This does not
32 affect any other reason why object code may be subject to the
33 restrictions in that licence (nor for the avoidance of doubt does it
34 affect the application of section 2 of that licence to modifications
35 of the source code in this file).
36
37 */
38
39 /**
40 * @file async_result.h
41 * @brief This file provides a thread-safe asynchronous result class.
42 */
43
44 #ifndef CGU_ASYNC_RESULT_H
45 #define CGU_ASYNC_RESULT_H
46
47 #include <utility> // for std::move
48
49 #include <c++-gtk-utils/mutex.h>
50 #include <c++-gtk-utils/thread.h>
51 #include <c++-gtk-utils/cgu_config.h>
52
53
54 namespace Cgu {
55
56 /**
57 * @class AsyncResult async_result.h c++-gtk-utils/async_result.h
58 * @brief A thread-safe asynchronous result class.
59 * @sa AsyncQueueDispatch Thread::Future
60 *
61 * Cgu::Thread::Future operates on the principle of there being one
62 * worker thread per task. In some cases however, it may be better to
63 * have a worker thread, or a limited pool of worker threads,
64 * executing a larger number of tasks. This can be implemented by
65 * having a worker thread or threads waiting on a
66 * Cgu::AsyncQueueDispatch object, onto which other threads push tasks
67 * represented by std::unique_ptr<const Cgu::Callback::Callback> or
68 * Cgu::Callback::SafeFunctor objects.
69 *
70 * Where this model is adopted, when a task completes it may report
71 * its results by dispatching a further callback to a glib main loop
72 * using Cgu::Callback::post(). However, there will also be cases
73 * where, rather than passing a result as an event to a main loop, a
74 * thread is to to wait for the task to complete. This class is
75 * intended to facilitate that. It operates in a way which is similar
76 * to the std::promise class in C++11. The thread which wishes to
77 * extract a result can call the get() method, which will block until
78 * the worker thread has called the set() method or posted an error.
79 *
80 * For safety reasons, the get() method returns by value and so will
81 * cause that value to be copied once. From version 2.0.11 a
82 * move_get() method is provided which will make a move operation
83 * instead of a copy if the value type implements a move constructor,
84 * but see the documentation on move_get() for the caveats with
85 * respect to its use: in particular, if move_get() is to be called by
86 * a thread, then get() may not be called by another thread.
87 *
88 * Here is a compilable example of a calculator class which runs a
89 * dedicated thread on which it carries out all its calculations:
90 *
91 * @code
92 * #include <vector>
93 * #include <numeric>
94 * #include <memory>
95 * #include <ostream>
96 * #include <iostream>
97 *
98 * #include <c++-gtk-utils/async_result.h>
99 * #include <c++-gtk-utils/async_queue.h>
100 * #include <c++-gtk-utils/shared_ptr.h>
101 * #include <c++-gtk-utils/thread.h>
102 * #include <c++-gtk-utils/callback.h>
103 *
104 * using namespace Cgu;
105 *
106 * class Calcs {
107 * AsyncQueueDispatch<std::unique_ptr<const Callback::Callback>> jobs;
108 * Thread::JoinableHandle t;
109 *
110 * void do_jobs() {
111 * for (;;) {
112 * std::unique_ptr<const Callback::Callback> job;
113 * jobs.move_pop_dispatch(job);
114 * job->dispatch();
115 * }
116 * }
117 * public:
118 *
119 * SharedLockPtr<AsyncResult<double>> mean(const std::vector<double>& nums) {
120 * SharedLockPtr<AsyncResult<double>> res(new AsyncResult<double>);
121 * jobs.emplace(Callback::lambda<>([=]() {
122 * if (nums.empty()) res->set(0.0);
123 * else res->set(std::accumulate(nums.begin(), nums.end(), 0.0)/nums.size());
124 * }));
125 * return res;
126 * }
127 *
128 * // ... other calculation methods here
129 *
130 * Calcs() {
131 * t = Thread::JoinableHandle(Thread::Thread::start(Callback::make(*this, &Calcs::do_jobs), true),
132 * Thread::JoinableHandle::join_on_exit);
133 * if (!t.is_managing()) throw "Thread start error";
134 * }
135 * ~Calcs() {
136 * jobs.emplace(Callback::lambda<>([]() {throw Thread::Exit();}));
137 * t.join();
138 * }
139 * };
140 *
141 * int main () {
142 *
143 * Calcs calcs;
144 * auto res1 = calcs.mean({1, 2, 8, 0});
145 * auto res2 = calcs.mean({101, 53.7, 87, 1.2});
146 *
147 * // ... do something else
148 *
149 * std::cout << res1->get() << std::endl;
150 * std::cout << res2->get() << std::endl;
151 *
152 * }
153 * @endcode
154 *
155 * AsyncResult objects cannot be copied by value, and as they need to
156 * be visible both to the set()ing and get()ing threads, it will often
157 * be easiest to construct them on free store and copy them by smart
158 * pointer, as in the example above. However, if the library is
159 * compiled with the \--with-glib-memory-slices-compat or
160 * \--with-glib-memory-slices-no-compat configuration options, any
161 * AsyncResult object constructed on free store will be constructed in
162 * glib memory slices, which are an efficient small object allocator.
163 */
164
165 template <class T> class AsyncResult {
166 T res;
167 bool done;
168 int error;
169 mutable Thread::Mutex mutex;
170 mutable Thread::Cond cond;
171
172 public:
173 /**
174 * @exception Thread::MutexError The constructor might throw this
175 * exception if initialisation of the contained mutex fails. (It is
176 * often not worth checking for this, as it means either memory is
177 * exhausted or pthread has run out of other resources to create new
178 * mutexes.) The constructor will also throw if the default
179 * constructor of the result type represented by this object throws.
180 * @exception Thread::CondError The constructor might throw this
181 * exception if initialisation of the contained condition variable
182 * fails. (It is often not worth checking for this, as it means
183 * either memory is exhausted or pthread has run out of other
184 * resources to create new condition variables.) The constructor will
185 * also throw if the default constructor of the result type
186 * represented by this object throws.
187 *
188 * Since 2.0.8
189 */
190 AsyncResult(): res(), done(false), error(0) {}
191
192 ~AsyncResult() {
193 // lock and unlock the mutex in the destructor so that we have an
194 // acquire operation to ensure that when this object is destroyed
195 // memory is synchronised, so any thread may destroy this object
196 Thread::Mutex::Lock lock{mutex};
197 }
198
199 // AsyncResult objects cannot be copied - they are mainly
200 // intended to pass a result between two known threads
201 /**
202 * This class cannot be copied. The copy constructor is deleted.
203 *
204 * Since 2.0.8
205 */
206 AsyncResult(const AsyncResult&) = delete;
207
208 /**
209 * This class cannot be copied. The assignment operator is deleted.
210 *
211 * Since 2.0.8
212 */
213 AsyncResult& operator=(const AsyncResult&) = delete;
214
215 /**
216 * This method sets the value represented by the AsyncResult object,
217 * provided that set() has not previously been called and
218 * set_error() has not previously been called with a value other
219 * than 0. If set() has previously been called or set_error()
220 * called with a value other than 0 (so that is_done() will return
221 * true) this method does nothing. It is thread safe. It is not a
222 * cancellation point. It will not throw unless the copy assignment
223 * operator of the value type throws.
224 * @param val The value which this object is to represent and which
225 * calls to get() or a call to move_get() will return. Any thread
226 * waiting on get() or move_get() will unblock, and any subsequent
227 * calls to is_done() will return true.
228 * @return true if the call to this method is effective because
229 * set() has not previously been called and set_error() has not
230 * previously been called with a value other than 0, otherwise
231 * false.
232 *
233 * Since 2.0.8
234 */
235 bool set(const T& val) {
236 Thread::Mutex::Lock lock{mutex};
237 if (!done) {
238 res = val;
239 done = true;
240 cond.broadcast();
241 return true;
242 }
243 return false;
244 }
245
246 /**
247 * This method sets the value represented by the AsyncResult object,
248 * provided that set() has not previously been called and
249 * set_error() has not previously been called with a value other
250 * than 0. If set() has previously been called or set_error()
251 * called with a value other than 0 (so that is_done() will return
252 * true) this method does nothing. It is thread safe. It is not a
253 * cancellation point. It will not throw unless the copy or move
254 * assignment operator of the value type throws.
255 * @param val The value which this object is to represent and which
256 * calls to get() or a call to move_get() will return. Any thread
257 * waiting on get() or move_get() will unblock, and any subsequent
258 * calls to is_done() will return true.
259 * @return true if the call to this method is effective because
260 * set() has not previously been called and set_error() has not
261 * previously been called with a value other than 0, otherwise
262 * false.
263 *
264 * Since 2.0.8
265 */
266 bool set(T&& val) {
267 Thread::Mutex::Lock lock{mutex};
268 if (!done) {
269 res = std::move(val);
270 done = true;
271 cond.broadcast();
272 return true;
273 }
274 return false;
275 }
276
277 /**
278 * This method gets the stored value represented by the AsyncResult
279 * object. It is thread safe. It is a cancellation point if it
280 * blocks, and is cancellation safe if the stack unwinds on
281 * cancellation. Any number of threads may call this method and
282 * block on it. It will not throw unless the copy constructor of
283 * the return type throws. It is strongly exception safe.
284 * @return the value represented by this object as set by a call to
285 * set(). If no such value has been set (and no error has been set)
286 * so that is_done() will return false, this method will block until
287 * either a value or an error has been set. If an error has been
288 * set, this method will return a default constructed object of the
289 * template type (and the error can be obtained with get_error()).
290 * @note Question: Couldn't this method return the stored value by
291 * lvalue reference to const? Answer: It could. However, because
292 * of return value optimization, which will be implemented by any
293 * compiler capable of compiling this library, no advantage would be
294 * gained by doing so when initializing a local variable with the
295 * return value of this method (the copy constructor will only be
296 * called once whether returning by value or const reference). The
297 * advantage of returning by value is that the call to the copy
298 * constructor is forced to be within the AsyncResult object's
299 * mutex, so different threads' calls to the copy constructor are
300 * serialized, and also with blocked cancellation, so this method is
301 * cancellation safe. All calls to this method by different threads
302 * are therefore isolated and we do not have to worry about the
303 * thread safety of direct access to the stored value via its const
304 * methods outside the mutex (which would not be thread safe if the
305 * stored value has data members declared mutable) nor about the
306 * cancellation safety of the copy constructor. Of course, for
307 * objects which do not have mutable data, a hit arises by returning
308 * by value in cases where it is not intended to initialize a local
309 * variable at all nor to cancel a thread: where, say, only const
310 * methods are to be called on the return value (which could be done
311 * directly if this method returned by const reference). However,
312 * in many use cases this will be mitigated by the move_get()
313 * method.
314 *
315 * Since 2.0.8
316 */
317 T get() const {
318 Thread::Mutex::Lock lock{mutex};
319 while (!done) cond.wait(mutex);
320 Thread::CancelBlock b;
321 return res;
322 }
323
324 /**
325 * This method gets the stored value represented by the AsyncResult
326 * object by a move operation, if the type of that value implements
327 * a move constructor (otherwise this method does the same as the
328 * get() method). It is provided as an option for cases where a
329 * move is required for efficiency reasons, but although it may be
330 * called by any thread, a move operation may normally only be made
331 * once (except where the return type has been designed to be moved
332 * more than once for the limited purpose of inspecting a flag
333 * indicating whether its value is valid or not). If this method is
334 * to be called then no calls to get() by another thread should
335 * normally be made. This method is a cancellation point if it
336 * blocks, and is cancellation safe if the stack unwinds on
337 * cancellation. It will not throw unless the copy or move
338 * constructor of the return type throws. It is only exception safe
339 * if the return type's move constructor is exception safe.
340 * @return The value represented by this object as set by a call to
341 * set(). If no such value has been set (and no error has been set)
342 * so that is_done() will return false, this method will block until
343 * either a value or an error has been set. If an error has been
344 * set, until a move operation has been carried out this method will
345 * return a default constructed object of the template type (and the
346 * error can be obtained with get_error()).
347 * @note Question: Couldn't this method return the stored value by
348 * rvalue reference? Answer: It could. However, because of return
349 * value optimization, which will be implemented by any compiler
350 * capable of compiling this library, no advantage would be gained
351 * by doing so when initializing a local variable with the return
352 * value of this method (the move constructor will only be called
353 * once, and no call will be made to the copy constructor, whether
354 * returning by value or rvalue reference). The advantage of
355 * returning by value is that the call to the move constructor is
356 * forced to be within the AsyncResult object's mutex, so different
357 * threads' calls to the move constructor are serialized, and also
358 * with blocked cancellation, so this method is cancellation safe.
359 * All calls to this method by different threads are therefore
360 * isolated and we do not have to worry about the thread safety of
361 * the mutating first call to this method, nor about direct access
362 * to the stored value via a rvalue reference outside the mutex nor
363 * the cancellation safety of the move constructor.
364 *
365 * Since 2.0.11
366 */
367 T move_get() {
368 Thread::Mutex::Lock lock{mutex};
369 while (!done) cond.wait(mutex);
370 Thread::CancelBlock b;
371 return std::move(res);
372 }
373
374 /**
375 * This method sets an error if called with a value other than 0,
376 * provided that set() has not previously been called and this
377 * method has not previously been called with a value other than 0.
378 * If set() has been called or this method previously called with a
379 * value other than 0 (so that is_done() will return true), this
380 * method does nothing. This method is thread safe. It is not a
381 * cancellation point. It will not throw.
382 * @param err The value which subsequent calls to get_error() will
383 * report. If the value of err is 0, or if this method has been
384 * called with a value other than 0 or set() has previously been
385 * called, this method will do nothing. Otherwise, any thread
386 * waiting on get() or move_get() will unblock (they will return a
387 * default constructed object of the template type), and any
388 * subsequent calls to is_done() will return true.
389 * @return true if the call to this method is effective because the
390 * error value passed is not 0, set() has not previously been called
391 * and this method has not previously been called with a value other
392 * than 0, otherwise false.
393 *
394 * Since 2.0.8
395 */
396 bool set_error(int err = -1) {
397 Thread::Mutex::Lock lock{mutex};
398 if (err && !done) {
399 error = err;
400 done = true;
401 cond.broadcast();
402 return true;
403 }
404 return false;
405 }
406
407 /**
408 * This method is thread safe. It is not a cancellation point. It
409 * will not throw.
410 * @return the error value set by a call to set_error(), or 0 if no
411 * error has been set.
412 *
413 * Since 2.0.8
414 */
415 int get_error() const {
416 Thread::Mutex::Lock lock{mutex};
417 return error;
418 }
419
420 /**
421 * This method is thread safe. It is not a cancellation point. It
422 * will not throw.
423 * @return true if set() has been called, or set_error() has been
424 * called with a value other than 0, otherwise false.
425 *
426 * Since 2.0.8
427 */
428 bool is_done() const {
429 Thread::Mutex::Lock lock{mutex};
430 return done;
431 }
432
433 /* Only has effect if --with-glib-memory-slices-compat or
434 * --with-glib-memory-slices-no-compat option picked */
435 CGU_GLIB_MEMORY_SLICES_FUNCS
436 };
437
438 } // namespace Cgu
439
440 #endif