annotate Framework/MultiThreading/BagOfTasksProcessor.h @ 236:b0ee417b667a

migrating new definitions in namespace Orthanc to namespace OrthancWSI
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 23 Feb 2021 10:27:58 +0100
parents c35a3a0627b9
children 49f647ed1b4c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
151
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
214
1e864138f0da upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 192
diff changeset
5 * Copyright (C) 2017-2021 Osimis S.A., Belgium
151
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * modify it under the terms of the GNU Affero General Public License
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * as published by the Free Software Foundation, either version 3 of
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * the License, or (at your option) any later version.
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * This program is distributed in the hope that it will be useful, but
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * Affero General Public License for more details.
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 *
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * You should have received a copy of the GNU Affero General Public License
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 **/
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 #pragma once
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 #include "BagOfTasks.h"
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25
192
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 175
diff changeset
26 #include <MultiThreading/SharedMessageQueue.h>
151
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 #include <stdint.h>
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 #include <map>
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30
236
b0ee417b667a migrating new definitions in namespace Orthanc to namespace OrthancWSI
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 216
diff changeset
31 namespace OrthancWSI
151
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 {
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 class BagOfTasksProcessor : public boost::noncopyable
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 {
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 private:
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 enum BagStatus
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 {
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 BagStatus_Running,
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 BagStatus_Canceled,
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 BagStatus_Failed
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 };
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 struct Bag
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 {
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 size_t size_;
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 size_t done_;
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 BagStatus status_;
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 Bag() :
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 size_(0),
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 done_(0),
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 status_(BagStatus_Failed)
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 {
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 }
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 explicit Bag(size_t size) :
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58 size_(size),
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 done_(0),
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 status_(BagStatus_Running)
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 {
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 }
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 };
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 class Task;
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68 typedef std::map<uint64_t, Bag> Bags;
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 typedef std::map<uint64_t, bool> ExitStatus;
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70
236
b0ee417b667a migrating new definitions in namespace Orthanc to namespace OrthancWSI
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 216
diff changeset
71 Orthanc::SharedMessageQueue queue_;
151
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73 boost::mutex mutex_;
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
74 uint64_t countBags_;
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75 Bags bags_;
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76 std::vector<boost::thread*> threads_;
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77 ExitStatus exitStatus_;
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78 bool continue_;
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 boost::condition_variable bagFinished_;
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82 static void Worker(BagOfTasksProcessor* that);
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84 void Cancel(int64_t bag);
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86 bool Join(int64_t bag);
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88 float GetProgress(int64_t bag);
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90 void SignalProgress(Task& task,
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91 Bag& bag);
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
92
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93 public:
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
94 class Handle : public boost::noncopyable
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95 {
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
96 friend class BagOfTasksProcessor;
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
97
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
98 private:
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
99 BagOfTasksProcessor& that_;
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
100 uint64_t bag_;
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
101 bool hasJoined_;
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
102 bool status_;
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
103
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
104 Handle(BagOfTasksProcessor& that,
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
105 uint64_t bag,
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
106 bool empty) :
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
107 that_(that),
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
108 bag_(bag),
216
c35a3a0627b9 cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 214
diff changeset
109 hasJoined_(empty),
c35a3a0627b9 cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 214
diff changeset
110 status_(false)
151
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
111 {
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
112 }
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
113
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
114 public:
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
115 ~Handle()
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
116 {
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
117 Join();
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
118 }
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
119
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
120 void Cancel()
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
121 {
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
122 that_.Cancel(bag_);
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
123 }
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
124
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
125 bool Join();
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
126
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
127 float GetProgress()
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
128 {
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
129 return that_.GetProgress(bag_);
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
130 }
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
131 };
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
132
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
133
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
134 explicit BagOfTasksProcessor(size_t countThreads);
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
135
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
136 ~BagOfTasksProcessor();
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
137
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
138 Handle* Submit(BagOfTasks& tasks);
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
139 };
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
140 }