Mercurial > hg > orthanc
comparison OrthancFramework/Sources/JobsEngine/JobsRegistry.h @ 4044:d25f4c0fa160 framework
splitting code into OrthancFramework and OrthancServer
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Wed, 10 Jun 2020 20:30:34 +0200 |
parents | Core/JobsEngine/JobsRegistry.h@1d2b31fc782f |
children | e00f3d089991 |
comparison
equal
deleted
inserted
replaced
4043:6c6239aec462 | 4044:d25f4c0fa160 |
---|---|
1 /** | |
2 * Orthanc - A Lightweight, RESTful DICOM Store | |
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics | |
4 * Department, University Hospital of Liege, Belgium | |
5 * Copyright (C) 2017-2020 Osimis S.A., Belgium | |
6 * | |
7 * This program is free software: you can redistribute it and/or | |
8 * modify it under the terms of the GNU General Public License as | |
9 * published by the Free Software Foundation, either version 3 of the | |
10 * License, or (at your option) any later version. | |
11 * | |
12 * In addition, as a special exception, the copyright holders of this | |
13 * program give permission to link the code of its release with the | |
14 * OpenSSL project's "OpenSSL" library (or with modified versions of it | |
15 * that use the same license as the "OpenSSL" library), and distribute | |
16 * the linked executables. You must obey the GNU General Public License | |
17 * in all respects for all of the code used other than "OpenSSL". If you | |
18 * modify file(s) with this exception, you may extend this exception to | |
19 * your version of the file(s), but you are not obligated to do so. If | |
20 * you do not wish to do so, delete this exception statement from your | |
21 * version. If you delete this exception statement from all source files | |
22 * in the program, then also delete it here. | |
23 * | |
24 * This program is distributed in the hope that it will be useful, but | |
25 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
27 * General Public License for more details. | |
28 * | |
29 * You should have received a copy of the GNU General Public License | |
30 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
31 **/ | |
32 | |
33 | |
34 #pragma once | |
35 | |
36 #if !defined(ORTHANC_SANDBOXED) | |
37 # error The macro ORTHANC_SANDBOXED must be defined | |
38 #endif | |
39 | |
40 #if ORTHANC_SANDBOXED == 1 | |
41 # error The job engine cannot be used in sandboxed environments | |
42 #endif | |
43 | |
44 #include "JobInfo.h" | |
45 #include "IJobUnserializer.h" | |
46 | |
47 #include <list> | |
48 #include <set> | |
49 #include <queue> | |
50 #include <boost/thread/mutex.hpp> | |
51 #include <boost/thread/condition_variable.hpp> | |
52 | |
53 namespace Orthanc | |
54 { | |
55 // This class handles the state machine of the jobs engine | |
56 class JobsRegistry : public boost::noncopyable | |
57 { | |
58 public: | |
59 class IObserver : public boost::noncopyable | |
60 { | |
61 public: | |
62 virtual ~IObserver() | |
63 { | |
64 } | |
65 | |
66 virtual void SignalJobSubmitted(const std::string& jobId) = 0; | |
67 | |
68 virtual void SignalJobSuccess(const std::string& jobId) = 0; | |
69 | |
70 virtual void SignalJobFailure(const std::string& jobId) = 0; | |
71 }; | |
72 | |
73 private: | |
74 enum CompletedReason | |
75 { | |
76 CompletedReason_Success, | |
77 CompletedReason_Failure, | |
78 CompletedReason_Canceled | |
79 }; | |
80 | |
81 class JobHandler; | |
82 | |
83 struct PriorityComparator | |
84 { | |
85 bool operator() (JobHandler*& a, | |
86 JobHandler*& b) const; | |
87 }; | |
88 | |
89 typedef std::map<std::string, JobHandler*> JobsIndex; | |
90 typedef std::list<JobHandler*> CompletedJobs; | |
91 typedef std::set<JobHandler*> RetryJobs; | |
92 typedef std::priority_queue<JobHandler*, | |
93 std::vector<JobHandler*>, // Could be a "std::deque" | |
94 PriorityComparator> PendingJobs; | |
95 | |
96 boost::mutex mutex_; | |
97 JobsIndex jobsIndex_; | |
98 PendingJobs pendingJobs_; | |
99 CompletedJobs completedJobs_; | |
100 RetryJobs retryJobs_; | |
101 | |
102 boost::condition_variable pendingJobAvailable_; | |
103 boost::condition_variable someJobComplete_; | |
104 size_t maxCompletedJobs_; | |
105 | |
106 IObserver* observer_; | |
107 | |
108 | |
109 #ifndef NDEBUG | |
110 bool IsPendingJob(const JobHandler& job) const; | |
111 | |
112 bool IsCompletedJob(JobHandler& job) const; | |
113 | |
114 bool IsRetryJob(JobHandler& job) const; | |
115 #endif | |
116 | |
117 void CheckInvariants() const; | |
118 | |
119 void ForgetOldCompletedJobs(); | |
120 | |
121 void SetCompletedJob(JobHandler& job, | |
122 bool success); | |
123 | |
124 void MarkRunningAsCompleted(JobHandler& job, | |
125 CompletedReason reason); | |
126 | |
127 void MarkRunningAsRetry(JobHandler& job, | |
128 unsigned int timeout); | |
129 | |
130 void MarkRunningAsPaused(JobHandler& job); | |
131 | |
132 bool GetStateInternal(JobState& state, | |
133 const std::string& id); | |
134 | |
135 void RemovePendingJob(const std::string& id); | |
136 | |
137 void RemoveRetryJob(JobHandler* handler); | |
138 | |
139 void SubmitInternal(std::string& id, | |
140 JobHandler* handler); | |
141 | |
142 public: | |
143 JobsRegistry(size_t maxCompletedJobs) : | |
144 maxCompletedJobs_(maxCompletedJobs), | |
145 observer_(NULL) | |
146 { | |
147 } | |
148 | |
149 JobsRegistry(IJobUnserializer& unserializer, | |
150 const Json::Value& s, | |
151 size_t maxCompletedJobs); | |
152 | |
153 ~JobsRegistry(); | |
154 | |
155 void SetMaxCompletedJobs(size_t i); | |
156 | |
157 size_t GetMaxCompletedJobs(); | |
158 | |
159 void ListJobs(std::set<std::string>& target); | |
160 | |
161 bool GetJobInfo(JobInfo& target, | |
162 const std::string& id); | |
163 | |
164 bool GetJobOutput(std::string& output, | |
165 MimeType& mime, | |
166 const std::string& job, | |
167 const std::string& key); | |
168 | |
169 void Serialize(Json::Value& target); | |
170 | |
171 void Submit(std::string& id, | |
172 IJob* job, // Takes ownership | |
173 int priority); | |
174 | |
175 void Submit(IJob* job, // Takes ownership | |
176 int priority); | |
177 | |
178 void SubmitAndWait(Json::Value& successContent, | |
179 IJob* job, // Takes ownership | |
180 int priority); | |
181 | |
182 bool SetPriority(const std::string& id, | |
183 int priority); | |
184 | |
185 bool Pause(const std::string& id); | |
186 | |
187 bool Resume(const std::string& id); | |
188 | |
189 bool Resubmit(const std::string& id); | |
190 | |
191 bool Cancel(const std::string& id); | |
192 | |
193 void ScheduleRetries(); | |
194 | |
195 bool GetState(JobState& state, | |
196 const std::string& id); | |
197 | |
198 void SetObserver(IObserver& observer); | |
199 | |
200 void ResetObserver(); | |
201 | |
202 void GetStatistics(unsigned int& pending, | |
203 unsigned int& running, | |
204 unsigned int& success, | |
205 unsigned int& errors); | |
206 | |
207 class RunningJob : public boost::noncopyable | |
208 { | |
209 private: | |
210 JobsRegistry& registry_; | |
211 JobHandler* handler_; // Can only be accessed if the | |
212 // registry mutex is locked! | |
213 IJob* job_; // Will by design be in mutual exclusion, | |
214 // because only one RunningJob can be | |
215 // executed at a time on a JobHandler | |
216 | |
217 std::string id_; | |
218 int priority_; | |
219 JobState targetState_; | |
220 unsigned int targetRetryTimeout_; | |
221 bool canceled_; | |
222 | |
223 public: | |
224 RunningJob(JobsRegistry& registry, | |
225 unsigned int timeout); | |
226 | |
227 ~RunningJob(); | |
228 | |
229 bool IsValid() const; | |
230 | |
231 const std::string& GetId() const; | |
232 | |
233 int GetPriority() const; | |
234 | |
235 IJob& GetJob(); | |
236 | |
237 bool IsPauseScheduled(); | |
238 | |
239 bool IsCancelScheduled(); | |
240 | |
241 void MarkSuccess(); | |
242 | |
243 void MarkFailure(); | |
244 | |
245 void MarkPause(); | |
246 | |
247 void MarkCanceled(); | |
248 | |
249 void MarkRetry(unsigned int timeout); | |
250 | |
251 void UpdateStatus(ErrorCode code, | |
252 const std::string& details); | |
253 }; | |
254 }; | |
255 } |