Mercurial > hg > orthanc
annotate OrthancFramework/Sources/JobsEngine/Operations/SequenceOfOperationsJob.h @ 5485:48b8dae6dc77
upgrade to year 2024
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Thu, 04 Jan 2024 15:10:42 +0100 |
| parents | b5c502bcaf99 |
| children | f7adfb22e20e |
| 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 | |
|
5485
48b8dae6dc77
upgrade to year 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5310
diff
changeset
|
5 * Copyright (C) 2017-2024 Osimis S.A., Belgium |
|
48b8dae6dc77
upgrade to year 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5310
diff
changeset
|
6 * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium |
| 2603 | 7 * |
| 8 * This program is free software: you can redistribute it and/or | |
|
4119
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4063
diff
changeset
|
9 * modify it under the terms of the GNU Lesser General Public License |
|
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4063
diff
changeset
|
10 * as published by the Free Software Foundation, either version 3 of |
|
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4063
diff
changeset
|
11 * the License, or (at your option) any later version. |
| 2603 | 12 * |
| 13 * This program is distributed in the hope that it will be useful, but | |
| 14 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
|
4119
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4063
diff
changeset
|
16 * Lesser General Public License for more details. |
| 2603 | 17 * |
|
4119
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4063
diff
changeset
|
18 * You should have received a copy of the GNU Lesser General Public |
|
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4063
diff
changeset
|
19 * License along with this program. If not, see |
|
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4063
diff
changeset
|
20 * <http://www.gnu.org/licenses/>. |
| 2603 | 21 **/ |
| 22 | |
| 23 | |
| 24 #pragma once | |
| 25 | |
| 26 #include "../IJob.h" | |
| 27 #include "IJobOperation.h" | |
| 28 | |
|
4202
2007ab69ac16
moving ORTHANC_FORCE_INLINE and ORTHANC_OVERRIDE from Enumerations.h to Compatibility.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4201
diff
changeset
|
29 #include "../../Compatibility.h" // For ORTHANC_OVERRIDE |
|
2007ab69ac16
moving ORTHANC_FORCE_INLINE and ORTHANC_OVERRIDE from Enumerations.h to Compatibility.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4201
diff
changeset
|
30 |
| 2603 | 31 #include <boost/thread/mutex.hpp> |
| 32 #include <boost/thread/condition_variable.hpp> | |
| 33 | |
| 34 #include <list> | |
| 35 | |
| 36 namespace Orthanc | |
| 37 { | |
|
4063
e00f3d089991
shared library of orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4044
diff
changeset
|
38 class ORTHANC_PUBLIC SequenceOfOperationsJob : public IJob |
| 2603 | 39 { |
| 40 public: | |
|
4063
e00f3d089991
shared library of orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4044
diff
changeset
|
41 class ORTHANC_PUBLIC IObserver : public boost::noncopyable |
| 2603 | 42 { |
| 43 public: | |
| 44 virtual ~IObserver() | |
| 45 { | |
| 46 } | |
| 47 | |
| 48 virtual void SignalDone(const SequenceOfOperationsJob& job) = 0; | |
| 49 }; | |
| 50 | |
| 51 private: | |
| 52 class Operation; | |
| 53 | |
|
2616
2f3007bf0708
event queues in Lua, serialization of sequence of operations
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2608
diff
changeset
|
54 std::string description_; |
| 2603 | 55 bool done_; |
| 56 boost::mutex mutex_; | |
| 57 std::vector<Operation*> operations_; | |
| 58 size_t current_; | |
| 59 boost::condition_variable operationAdded_; | |
| 60 boost::posix_time::time_duration trailingTimeout_; | |
| 61 std::list<IObserver*> observers_; | |
| 62 | |
|
2950
dc18d5804746
support of JobsHistorySize set to zero
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
63 void NotifyDone() const; |
|
dc18d5804746
support of JobsHistorySize set to zero
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
64 |
| 2603 | 65 public: |
|
2616
2f3007bf0708
event queues in Lua, serialization of sequence of operations
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2608
diff
changeset
|
66 SequenceOfOperationsJob(); |
| 2603 | 67 |
|
2666
2540ac79ab6c
SequenceOfOperationsJob serialization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2663
diff
changeset
|
68 SequenceOfOperationsJob(IJobUnserializer& unserializer, |
|
2540ac79ab6c
SequenceOfOperationsJob serialization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2663
diff
changeset
|
69 const Json::Value& serialized); |
|
2540ac79ab6c
SequenceOfOperationsJob serialization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2663
diff
changeset
|
70 |
| 2603 | 71 virtual ~SequenceOfOperationsJob(); |
| 72 | |
|
2616
2f3007bf0708
event queues in Lua, serialization of sequence of operations
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2608
diff
changeset
|
73 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
|
74 |
|
2666
2540ac79ab6c
SequenceOfOperationsJob serialization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2663
diff
changeset
|
75 void GetDescription(std::string& description); |
|
2540ac79ab6c
SequenceOfOperationsJob serialization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2663
diff
changeset
|
76 |
| 2603 | 77 void Register(IObserver& observer); |
| 78 | |
| 79 // This lock allows adding new operations to the end of the job, | |
| 80 // from another thread than the worker thread, after the job has | |
| 81 // been submitted for processing | |
|
4063
e00f3d089991
shared library of orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4044
diff
changeset
|
82 class ORTHANC_PUBLIC Lock : public boost::noncopyable |
| 2603 | 83 { |
| 84 private: | |
| 85 SequenceOfOperationsJob& that_; | |
| 86 boost::mutex::scoped_lock lock_; | |
| 87 | |
|
4348
93c281752e7a
reintroduced backward ABI compatibility in Orthanc Framework .so for unit tests of Orthanc 1.7.2 to 1.8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4310
diff
changeset
|
88 #if ORTHANC_BUILDING_FRAMEWORK_LIBRARY == 1 |
|
4350
e457c30970cf
fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4348
diff
changeset
|
89 ORTHANC_DEPRECATED(void AddInput(size_t index, |
|
e457c30970cf
fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4348
diff
changeset
|
90 const JobOperationValue& value)); |
|
4348
93c281752e7a
reintroduced backward ABI compatibility in Orthanc Framework .so for unit tests of Orthanc 1.7.2 to 1.8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4310
diff
changeset
|
91 #endif |
|
93c281752e7a
reintroduced backward ABI compatibility in Orthanc Framework .so for unit tests of Orthanc 1.7.2 to 1.8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4310
diff
changeset
|
92 |
| 2603 | 93 public: |
| 4304 | 94 explicit Lock(SequenceOfOperationsJob& that); |
| 2603 | 95 |
| 4304 | 96 bool IsDone() const; |
| 2603 | 97 |
| 98 void SetTrailingOperationTimeout(unsigned int timeout); | |
|
2608
25225f0b4f33
simplification wrt. dicom connection manager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2603
diff
changeset
|
99 |
| 2603 | 100 size_t AddOperation(IJobOperation* operation); |
| 101 | |
| 4304 | 102 size_t GetOperationsCount() const; |
| 2603 | 103 |
| 104 void AddInput(size_t index, | |
|
4310
2ae905070221
renaming pure interface JobOperationValue as IJobOperationValue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4305
diff
changeset
|
105 const IJobOperationValue& value); |
| 2603 | 106 |
| 107 void Connect(size_t input, | |
| 108 size_t output); | |
| 109 }; | |
| 110 | |
| 4304 | 111 virtual void Start() ORTHANC_OVERRIDE; |
| 2603 | 112 |
|
3658
2d90dd30858c
providing job ID to the IJob::Step() methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3640
diff
changeset
|
113 virtual JobStepResult Step(const std::string& jobId) ORTHANC_OVERRIDE; |
| 2603 | 114 |
|
3674
9201a7858cce
fix warnings with recent wasm
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3658
diff
changeset
|
115 virtual void Reset() ORTHANC_OVERRIDE; |
| 2603 | 116 |
| 4304 | 117 virtual void Stop(JobStopReason reason) ORTHANC_OVERRIDE; |
| 2603 | 118 |
|
3674
9201a7858cce
fix warnings with recent wasm
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3658
diff
changeset
|
119 virtual float GetProgress() ORTHANC_OVERRIDE; |
| 2603 | 120 |
| 4304 | 121 virtual void GetJobType(std::string& target) ORTHANC_OVERRIDE; |
| 2603 | 122 |
|
3674
9201a7858cce
fix warnings with recent wasm
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3658
diff
changeset
|
123 virtual void GetPublicContent(Json::Value& value) ORTHANC_OVERRIDE; |
| 2603 | 124 |
|
3674
9201a7858cce
fix warnings with recent wasm
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3658
diff
changeset
|
125 virtual bool Serialize(Json::Value& value) ORTHANC_OVERRIDE; |
|
2620
1232922c8793
speeding up shutdown if Lua script is in trailing phase
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2616
diff
changeset
|
126 |
|
2976
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2950
diff
changeset
|
127 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
|
128 MimeType& mime, |
|
4805
0a38000b086d
Archive jobs response now contains a header Content-Disposition:filename='archive.zip'
Alain Mazy <am@osimis.io>
parents:
4437
diff
changeset
|
129 std::string& filename, |
|
5310
b5c502bcaf99
added a route to DELETE /jobs/../archive
Alain Mazy <am@osimis.io>
parents:
5185
diff
changeset
|
130 const std::string& key) ORTHANC_OVERRIDE |
|
b5c502bcaf99
added a route to DELETE /jobs/../archive
Alain Mazy <am@osimis.io>
parents:
5185
diff
changeset
|
131 { |
|
b5c502bcaf99
added a route to DELETE /jobs/../archive
Alain Mazy <am@osimis.io>
parents:
5185
diff
changeset
|
132 return false; |
|
b5c502bcaf99
added a route to DELETE /jobs/../archive
Alain Mazy <am@osimis.io>
parents:
5185
diff
changeset
|
133 } |
|
b5c502bcaf99
added a route to DELETE /jobs/../archive
Alain Mazy <am@osimis.io>
parents:
5185
diff
changeset
|
134 |
|
b5c502bcaf99
added a route to DELETE /jobs/../archive
Alain Mazy <am@osimis.io>
parents:
5185
diff
changeset
|
135 virtual bool DeleteOutput(const std::string& key) ORTHANC_OVERRIDE |
|
b5c502bcaf99
added a route to DELETE /jobs/../archive
Alain Mazy <am@osimis.io>
parents:
5185
diff
changeset
|
136 { |
|
b5c502bcaf99
added a route to DELETE /jobs/../archive
Alain Mazy <am@osimis.io>
parents:
5185
diff
changeset
|
137 return false; |
|
b5c502bcaf99
added a route to DELETE /jobs/../archive
Alain Mazy <am@osimis.io>
parents:
5185
diff
changeset
|
138 } |
|
2976
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2950
diff
changeset
|
139 |
| 4304 | 140 void AwakeTrailingSleep(); |
| 2603 | 141 }; |
| 142 } |