work_queue.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2013 The ClanLib Team
4 **
5 ** This software is provided 'as-is', without any express or implied
6 ** warranty. In no event will the authors be held liable for any damages
7 ** arising from the use of this software.
8 **
9 ** Permission is granted to anyone to use this software for any purpose,
10 ** including commercial applications, and to alter it and redistribute it
11 ** freely, subject to the following restrictions:
12 **
13 ** 1. The origin of this software must not be misrepresented; you must not
14 ** claim that you wrote the original software. If you use this software
15 ** in a product, an acknowledgment in the product documentation would be
16 ** appreciated but is not required.
17 ** 2. Altered source versions must be plainly marked as such, and must not be
18 ** misrepresented as being the original software.
19 ** 3. This notice may not be removed or altered from any source distribution.
20 **
21 ** Note: Some of the libraries ClanLib may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Magnus Norddahl
27 */
28 
29 
30 #pragma once
31 
32 #include "../api_core.h"
33 #include <memory>
34 #include <functional>
35 
36 namespace clan
37 {
40 
42 class CL_API_CORE WorkItem
43 {
44 public:
45  virtual ~WorkItem() { }
46 
48  virtual void process_work() = 0;
49 
51  virtual void work_completed() { }
52 };
53 
54 class WorkQueue_Impl;
55 
57 class CL_API_CORE WorkQueue
58 {
59 public:
62  WorkQueue(bool serial_queue = false);
63  ~WorkQueue();
64 
68  void queue(WorkItem *item);
69 
71  void queue(const std::function<void()> &func);
72 
74  void work_completed(const std::function<void()> &func);
75 
77  int get_items_queued() const;
78 
79 private:
80 
81  std::shared_ptr<WorkQueue_Impl> impl;
82 };
83 
84 }
85 
virtual ~WorkItem()
Definition: work_queue.h:45
Interface for executing work on a worker thread.
Definition: work_queue.h:42
virtual void work_completed()
Called by the WorkQueue thread to complete the work.
Definition: work_queue.h:51
Thread pool for worker threads.
Definition: work_queue.h:57