Mercurial > hg > orthanc
annotate Core/JobsEngine/Operations/SequenceOfOperationsJob.h @ 3121:f86ebf971a72 db-changes
fix unit tests
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Mon, 14 Jan 2019 16:23:08 +0100 |
| parents | 4e43e67f8ecf |
| children | 94f4a18a79cc |
| rev | line source |
|---|---|
| 2603 | 1 /** |
| 2 * Orthanc - A Lightweight, RESTful DICOM Store | |
| 3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics | |
| 4 * Department, University Hospital of Liege, Belgium | |
|
3060
4e43e67f8ecf
preparing for 2019
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2976
diff
changeset
|
5 * Copyright (C) 2017-2019 Osimis S.A., Belgium |
| 2603 | 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 | |
|
2608
25225f0b4f33
simplification wrt. dicom connection manager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2603
diff
changeset
|
39 #include "../../DicomNetworking/TimeoutDicomConnectionManager.h" |
|
25225f0b4f33
simplification wrt. dicom connection manager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2603
diff
changeset
|
40 |
| 2603 | 41 #include <boost/thread/mutex.hpp> |
| 42 #include <boost/thread/condition_variable.hpp> | |
| 43 | |
| 44 #include <list> | |
| 45 | |
| 46 namespace Orthanc | |
| 47 { | |
| 48 class SequenceOfOperationsJob : public IJob | |
| 49 { | |
| 50 public: | |
| 51 class IObserver : public boost::noncopyable | |
| 52 { | |
| 53 public: | |
| 54 virtual ~IObserver() | |
| 55 { | |
| 56 } | |
| 57 | |
| 58 virtual void SignalDone(const SequenceOfOperationsJob& job) = 0; | |
| 59 }; | |
| 60 | |
| 61 private: | |
| 62 class Operation; | |
| 63 | |
|
2616
2f3007bf0708
event queues in Lua, serialization of sequence of operations
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2608
diff
changeset
|
64 std::string description_; |
| 2603 | 65 bool done_; |
| 66 boost::mutex mutex_; | |
| 67 std::vector<Operation*> operations_; | |
| 68 size_t current_; | |
| 69 boost::condition_variable operationAdded_; | |
| 70 boost::posix_time::time_duration trailingTimeout_; | |
| 71 std::list<IObserver*> observers_; | |
|
2608
25225f0b4f33
simplification wrt. dicom connection manager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2603
diff
changeset
|
72 TimeoutDicomConnectionManager connectionManager_; |
| 2603 | 73 |
|
2950
dc18d5804746
support of JobsHistorySize set to zero
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
74 void NotifyDone() const; |
|
dc18d5804746
support of JobsHistorySize set to zero
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
75 |
| 2603 | 76 public: |
|
2616
2f3007bf0708
event queues in Lua, serialization of sequence of operations
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2608
diff
changeset
|
77 SequenceOfOperationsJob(); |
| 2603 | 78 |
|
2666
2540ac79ab6c
SequenceOfOperationsJob serialization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2663
diff
changeset
|
79 SequenceOfOperationsJob(IJobUnserializer& unserializer, |
|
2540ac79ab6c
SequenceOfOperationsJob serialization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2663
diff
changeset
|
80 const Json::Value& serialized); |
|
2540ac79ab6c
SequenceOfOperationsJob serialization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2663
diff
changeset
|
81 |
| 2603 | 82 virtual ~SequenceOfOperationsJob(); |
| 83 | |
|
2616
2f3007bf0708
event queues in Lua, serialization of sequence of operations
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2608
diff
changeset
|
84 void SetDescription(const std::string& description); |
|
2f3007bf0708
event queues in Lua, serialization of sequence of operations
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2608
diff
changeset
|
85 |
|
2666
2540ac79ab6c
SequenceOfOperationsJob serialization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2663
diff
changeset
|
86 void GetDescription(std::string& description); |
|
2540ac79ab6c
SequenceOfOperationsJob serialization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2663
diff
changeset
|
87 |
| 2603 | 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) : | |
|
2950
dc18d5804746
support of JobsHistorySize set to zero
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
101 that_(that), |
|
dc18d5804746
support of JobsHistorySize set to zero
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
102 lock_(that.mutex_) |
| 2603 | 103 { |
| 104 } | |
| 105 | |
| 106 bool IsDone() const | |
| 107 { | |
| 108 return that_.done_; | |
| 109 } | |
| 110 | |
| 111 void SetTrailingOperationTimeout(unsigned int timeout); | |
| 112 | |
|
2620
1232922c8793
speeding up shutdown if Lua script is in trailing phase
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2616
diff
changeset
|
113 void SetDicomAssociationTimeout(unsigned int timeout); |
|
2608
25225f0b4f33
simplification wrt. dicom connection manager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2603
diff
changeset
|
114 |
| 2603 | 115 size_t AddOperation(IJobOperation* operation); |
| 116 | |
| 117 size_t GetOperationsCount() const | |
| 118 { | |
| 119 return that_.operations_.size(); | |
| 120 } | |
| 121 | |
| 122 void AddInput(size_t index, | |
| 123 const JobOperationValue& value); | |
| 124 | |
| 125 void Connect(size_t input, | |
| 126 size_t output); | |
| 127 }; | |
| 128 | |
| 129 virtual void Start() | |
| 130 { | |
| 131 } | |
| 132 | |
|
2812
ea7aea6f6a95
improved naming of methods in IJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2811
diff
changeset
|
133 virtual JobStepResult Step(); |
| 2603 | 134 |
|
2812
ea7aea6f6a95
improved naming of methods in IJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2811
diff
changeset
|
135 virtual void Reset(); |
| 2603 | 136 |
|
2812
ea7aea6f6a95
improved naming of methods in IJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2811
diff
changeset
|
137 virtual void Stop(JobStopReason reason); |
| 2603 | 138 |
| 139 virtual float GetProgress(); | |
| 140 | |
| 141 virtual void GetJobType(std::string& target) | |
| 142 { | |
|
2616
2f3007bf0708
event queues in Lua, serialization of sequence of operations
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2608
diff
changeset
|
143 target = "SequenceOfOperations"; |
| 2603 | 144 } |
| 145 | |
| 146 virtual void GetPublicContent(Json::Value& value); | |
| 147 | |
|
2663
228e2783ce83
some jobs might not be serializable
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2648
diff
changeset
|
148 virtual bool Serialize(Json::Value& value); |
|
2620
1232922c8793
speeding up shutdown if Lua script is in trailing phase
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2616
diff
changeset
|
149 |
|
2976
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2950
diff
changeset
|
150 virtual bool GetOutput(std::string& output, |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2950
diff
changeset
|
151 MimeType& mime, |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2950
diff
changeset
|
152 const std::string& key) |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2950
diff
changeset
|
153 { |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2950
diff
changeset
|
154 return false; |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2950
diff
changeset
|
155 } |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2950
diff
changeset
|
156 |
|
2620
1232922c8793
speeding up shutdown if Lua script is in trailing phase
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2616
diff
changeset
|
157 void AwakeTrailingSleep() |
|
1232922c8793
speeding up shutdown if Lua script is in trailing phase
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2616
diff
changeset
|
158 { |
|
1232922c8793
speeding up shutdown if Lua script is in trailing phase
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2616
diff
changeset
|
159 operationAdded_.notify_one(); |
|
1232922c8793
speeding up shutdown if Lua script is in trailing phase
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2616
diff
changeset
|
160 } |
| 2603 | 161 }; |
| 162 } |