work_queue.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2015 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 <memory>
33 #include <functional>
34
35 namespace clan
36 {
39
41 class WorkItem
42 {
43 public:
44 virtual ~WorkItem() { }
45
47 virtual void process_work() = 0;
48
50 virtual void work_completed() { }
51 };
52
53 class WorkQueue_Impl;
54
56 class WorkQueue
57 {
58 public:
61 WorkQueue(bool serial_queue = false);
62 ~WorkQueue();
63
67 void queue(WorkItem *item);
68
70 void queue(const std::function<void()> &func);
71
73 void work_completed(const std::function<void()> &func);
74
76 int get_items_queued() const;
77
81 void process_work_completed();
82
83 private:
84
85 std::shared_ptr<WorkQueue_Impl> impl;
86 };
87
88 }
89
clan
Definition: clanapp.h:35
clan::StyleTokenType::function
C style comment block.
clan::WorkItem::process_work
virtual void process_work()=0
Called by a worker thread to process work.
clan::WorkQueue::process_work_completed
void process_work_completed()
Process work completed queue.
clan::WorkItem::~WorkItem
virtual ~WorkItem()
Definition: work_queue.h:44
clan::WorkQueue::work_completed
void work_completed(const std::function< void()> &func)
Queue some work to be executed on the main WorkQueue thread.
clan::WorkQueue::queue
void queue(WorkItem *item)
Queue some work to be executed on a worker thread.
clan::WorkItem
Interface for executing work on a worker thread.
Definition: work_queue.h:41
clan::WorkQueue::~WorkQueue
~WorkQueue()
clan::WorkQueue::WorkQueue
WorkQueue(bool serial_queue=false)
Constructs a work queue.
clan::WorkQueue::get_items_queued
int get_items_queued() const
Returns the number of items currently queued.
clan::WorkItem::work_completed
virtual void work_completed()
Called by the WorkQueue thread to complete the work.
Definition: work_queue.h:50
clan::WorkQueue
Thread pool for worker threads.
Definition: work_queue.h:56