Mercurial > hg > orthanc

comparison OrthancFramework/Sources/JobsEngine/Operations/SequenceOfOperationsJob.h @ 4044:d25f4c0fa160 framework

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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/Operations/SequenceOfOperationsJob.h@6498739a3c3c
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 #include "../IJob.h"
37 #include "IJobOperation.h"
38
39 #include <boost/thread/mutex.hpp>
40 #include <boost/thread/condition_variable.hpp>
41
42 #include <list>
43
44 namespace Orthanc
45 {
46 class SequenceOfOperationsJob : public IJob
47 {
48 public:
49 class IObserver : public boost::noncopyable
50 {
51 public:
52 virtual ~IObserver()
53 {
54 }
55
56 virtual void SignalDone(const SequenceOfOperationsJob& job) = 0;
57 };
58
59 private:
60 class Operation;
61
62 std::string description_;
63 bool done_;
64 boost::mutex mutex_;
65 std::vector<Operation*> operations_;
66 size_t current_;
67 boost::condition_variable operationAdded_;
68 boost::posix_time::time_duration trailingTimeout_;
69 std::list<IObserver*> observers_;
70
71 void NotifyDone() const;
72
73 public:
74 SequenceOfOperationsJob();
75
76 SequenceOfOperationsJob(IJobUnserializer& unserializer,
77 const Json::Value& serialized);
78
79 virtual ~SequenceOfOperationsJob();
80
81 void SetDescription(const std::string& description);
82
83 void GetDescription(std::string& description);
84
85 void Register(IObserver& observer);
86
87 // This lock allows adding new operations to the end of the job,
88 // from another thread than the worker thread, after the job has
89 // been submitted for processing
90 class Lock : public boost::noncopyable
91 {
92 private:
93 SequenceOfOperationsJob& that_;
94 boost::mutex::scoped_lock lock_;
95
96 public:
97 Lock(SequenceOfOperationsJob& that) :
98 that_(that),
99 lock_(that.mutex_)
100 {
101 }
102
103 bool IsDone() const
104 {
105 return that_.done_;
106 }
107
108 void SetTrailingOperationTimeout(unsigned int timeout);
109
110 size_t AddOperation(IJobOperation* operation);
111
112 size_t GetOperationsCount() const
113 {
114 return that_.operations_.size();
115 }
116
117 void AddInput(size_t index,
118 const JobOperationValue& value);
119
120 void Connect(size_t input,
121 size_t output);
122 };
123
124 virtual void Start() ORTHANC_OVERRIDE
125 {
126 }
127
128 virtual JobStepResult Step(const std::string& jobId) ORTHANC_OVERRIDE;
129
130 virtual void Reset() ORTHANC_OVERRIDE;
131
132 virtual void Stop(JobStopReason reason) ORTHANC_OVERRIDE
133 {
134 }
135
136 virtual float GetProgress() ORTHANC_OVERRIDE;
137
138 virtual void GetJobType(std::string& target) ORTHANC_OVERRIDE
139 {
140 target = "SequenceOfOperations";
141 }
142
143 virtual void GetPublicContent(Json::Value& value) ORTHANC_OVERRIDE;
144
145 virtual bool Serialize(Json::Value& value) ORTHANC_OVERRIDE;
146
147 virtual bool GetOutput(std::string& output,
148 MimeType& mime,
149 const std::string& key) ORTHANC_OVERRIDE
150 {
151 return false;
152 }
153
154 void AwakeTrailingSleep()
155 {
156 operationAdded_.notify_one();
157 }
158 };
159 }