Mercurial > hg > orthanc

comparison Core/JobsEngine/Operations/SequenceOfOperationsJob.h @ 2603:988936118354 jobs

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
reorganization
author Sebastien Jodogne <s.jodogne@gmail.com>
date Fri, 18 May 2018 17:02:25 +0200
parents
children 25225f0b4f33
comparison
equal deleted inserted replaced
2602:c25f1a52acbc 2603:988936118354
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-2018 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 jobType_;
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 Setup();
72
73 public:
74 SequenceOfOperationsJob() :
75 jobType_("SequenceOfOperations")
76 {
77 Setup();
78 }
79
80 SequenceOfOperationsJob(const std::string& jobType) :
81 jobType_(jobType)
82 {
83 Setup();
84 }
85
86 virtual ~SequenceOfOperationsJob();
87
88 void Register(IObserver& observer);
89
90 // This lock allows adding new operations to the end of the job,
91 // from another thread than the worker thread, after the job has
92 // been submitted for processing
93 class Lock : public boost::noncopyable
94 {
95 private:
96 SequenceOfOperationsJob& that_;
97 boost::mutex::scoped_lock lock_;
98
99 public:
100 Lock(SequenceOfOperationsJob& that) :
101 that_(that),
102 lock_(that.mutex_)
103 {
104 }
105
106 bool IsDone() const
107 {
108 return that_.done_;
109 }
110
111 void SetTrailingOperationTimeout(unsigned int timeout);
112
113 size_t AddOperation(IJobOperation* operation);
114
115 size_t GetOperationsCount() const
116 {
117 return that_.operations_.size();
118 }
119
120 void AddInput(size_t index,
121 const JobOperationValue& value);
122
123 void Connect(size_t input,
124 size_t output);
125 };
126
127 virtual void Start()
128 {
129 }
130
131 virtual JobStepResult ExecuteStep();
132
133 virtual void SignalResubmit();
134
135 virtual void ReleaseResources()
136 {
137 }
138
139 virtual float GetProgress();
140
141 virtual void GetJobType(std::string& target)
142 {
143 target = jobType_;
144 }
145
146 virtual void GetPublicContent(Json::Value& value);
147
148 virtual void GetInternalContent(Json::Value& value)
149 {
150 // TODO
151 }
152 };
153 }