Mercurial > hg > orthanc
annotate OrthancFramework/Sources/JobsEngine/Operations/SequenceOfOperationsJob.h @ 4181:b416b6bf129b
clarification of sdk doc about deadlocks
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Tue, 08 Sep 2020 09:16:33 +0200 |
| parents | bf7b9edf6b81 |
| children | 2d5209153b32 |
| 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 | |
|
3640
94f4a18a79cc
upgrade to year 2020
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3060
diff
changeset
|
5 * Copyright (C) 2017-2020 Osimis S.A., Belgium |
| 2603 | 6 * |
| 7 * 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
|
8 * 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
|
9 * 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
|
10 * the License, or (at your option) any later version. |
| 2603 | 11 * |
| 12 * This program is distributed in the hope that it will be useful, but | |
| 13 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 14 * 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
|
15 * Lesser General Public License for more details. |
| 2603 | 16 * |
|
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
|
17 * 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
|
18 * 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
|
19 * <http://www.gnu.org/licenses/>. |
| 2603 | 20 **/ |
| 21 | |
| 22 | |
| 23 #pragma once | |
| 24 | |
| 25 #include "../IJob.h" | |
| 26 #include "IJobOperation.h" | |
| 27 | |
| 28 #include <boost/thread/mutex.hpp> | |
| 29 #include <boost/thread/condition_variable.hpp> | |
| 30 | |
| 31 #include <list> | |
| 32 | |
| 33 namespace Orthanc | |
| 34 { | |
|
4063
e00f3d089991
shared library of orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4044
diff
changeset
|
35 class ORTHANC_PUBLIC SequenceOfOperationsJob : public IJob |
| 2603 | 36 { |
| 37 public: | |
|
4063
e00f3d089991
shared library of orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4044
diff
changeset
|
38 class ORTHANC_PUBLIC IObserver : public boost::noncopyable |
| 2603 | 39 { |
| 40 public: | |
| 41 virtual ~IObserver() | |
| 42 { | |
| 43 } | |
| 44 | |
| 45 virtual void SignalDone(const SequenceOfOperationsJob& job) = 0; | |
| 46 }; | |
| 47 | |
| 48 private: | |
| 49 class Operation; | |
| 50 | |
|
2616
2f3007bf0708
event queues in Lua, serialization of sequence of operations
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2608
diff
changeset
|
51 std::string description_; |
| 2603 | 52 bool done_; |
| 53 boost::mutex mutex_; | |
| 54 std::vector<Operation*> operations_; | |
| 55 size_t current_; | |
| 56 boost::condition_variable operationAdded_; | |
| 57 boost::posix_time::time_duration trailingTimeout_; | |
| 58 std::list<IObserver*> observers_; | |
| 59 | |
|
2950
dc18d5804746
support of JobsHistorySize set to zero
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
60 void NotifyDone() const; |
|
dc18d5804746
support of JobsHistorySize set to zero
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
61 |
| 2603 | 62 public: |
|
2616
2f3007bf0708
event queues in Lua, serialization of sequence of operations
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2608
diff
changeset
|
63 SequenceOfOperationsJob(); |
| 2603 | 64 |
|
2666
2540ac79ab6c
SequenceOfOperationsJob serialization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2663
diff
changeset
|
65 SequenceOfOperationsJob(IJobUnserializer& unserializer, |
|
2540ac79ab6c
SequenceOfOperationsJob serialization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2663
diff
changeset
|
66 const Json::Value& serialized); |
|
2540ac79ab6c
SequenceOfOperationsJob serialization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2663
diff
changeset
|
67 |
| 2603 | 68 virtual ~SequenceOfOperationsJob(); |
| 69 | |
|
2616
2f3007bf0708
event queues in Lua, serialization of sequence of operations
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2608
diff
changeset
|
70 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
|
71 |
|
2666
2540ac79ab6c
SequenceOfOperationsJob serialization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2663
diff
changeset
|
72 void GetDescription(std::string& description); |
|
2540ac79ab6c
SequenceOfOperationsJob serialization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2663
diff
changeset
|
73 |
| 2603 | 74 void Register(IObserver& observer); |
| 75 | |
| 76 // This lock allows adding new operations to the end of the job, | |
| 77 // from another thread than the worker thread, after the job has | |
| 78 // been submitted for processing | |
|
4063
e00f3d089991
shared library of orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4044
diff
changeset
|
79 class ORTHANC_PUBLIC Lock : public boost::noncopyable |
| 2603 | 80 { |
| 81 private: | |
| 82 SequenceOfOperationsJob& that_; | |
| 83 boost::mutex::scoped_lock lock_; | |
| 84 | |
| 85 public: | |
| 86 Lock(SequenceOfOperationsJob& that) : | |
|
2950
dc18d5804746
support of JobsHistorySize set to zero
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
87 that_(that), |
|
dc18d5804746
support of JobsHistorySize set to zero
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
88 lock_(that.mutex_) |
| 2603 | 89 { |
| 90 } | |
| 91 | |
| 92 bool IsDone() const | |
| 93 { | |
| 94 return that_.done_; | |
| 95 } | |
| 96 | |
| 97 void SetTrailingOperationTimeout(unsigned int timeout); | |
|
2608
25225f0b4f33
simplification wrt. dicom connection manager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2603
diff
changeset
|
98 |
| 2603 | 99 size_t AddOperation(IJobOperation* operation); |
| 100 | |
| 101 size_t GetOperationsCount() const | |
| 102 { | |
| 103 return that_.operations_.size(); | |
| 104 } | |
| 105 | |
| 106 void AddInput(size_t index, | |
| 107 const JobOperationValue& value); | |
| 108 | |
| 109 void Connect(size_t input, | |
| 110 size_t output); | |
| 111 }; | |
| 112 | |
|
3674
9201a7858cce
fix warnings with recent wasm
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3658
diff
changeset
|
113 virtual void Start() ORTHANC_OVERRIDE |
| 2603 | 114 { |
| 115 } | |
| 116 | |
|
3658
2d90dd30858c
providing job ID to the IJob::Step() methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3640
diff
changeset
|
117 virtual JobStepResult Step(const std::string& jobId) ORTHANC_OVERRIDE; |
| 2603 | 118 |
|
3674
9201a7858cce
fix warnings with recent wasm
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3658
diff
changeset
|
119 virtual void Reset() ORTHANC_OVERRIDE; |
| 2603 | 120 |
|
3851
6498739a3c3c
refactoring: TimeoutDicomConnectionManager is now only used by Lua
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3674
diff
changeset
|
121 virtual void Stop(JobStopReason reason) ORTHANC_OVERRIDE |
|
6498739a3c3c
refactoring: TimeoutDicomConnectionManager is now only used by Lua
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3674
diff
changeset
|
122 { |
|
6498739a3c3c
refactoring: TimeoutDicomConnectionManager is now only used by Lua
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3674
diff
changeset
|
123 } |
| 2603 | 124 |
|
3674
9201a7858cce
fix warnings with recent wasm
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3658
diff
changeset
|
125 virtual float GetProgress() ORTHANC_OVERRIDE; |
| 2603 | 126 |
|
3674
9201a7858cce
fix warnings with recent wasm
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3658
diff
changeset
|
127 virtual void GetJobType(std::string& target) ORTHANC_OVERRIDE |
| 2603 | 128 { |
|
2616
2f3007bf0708
event queues in Lua, serialization of sequence of operations
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2608
diff
changeset
|
129 target = "SequenceOfOperations"; |
| 2603 | 130 } |
| 131 | |
|
3674
9201a7858cce
fix warnings with recent wasm
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3658
diff
changeset
|
132 virtual void GetPublicContent(Json::Value& value) ORTHANC_OVERRIDE; |
| 2603 | 133 |
|
3674
9201a7858cce
fix warnings with recent wasm
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3658
diff
changeset
|
134 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
|
135 |
|
2976
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2950
diff
changeset
|
136 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
|
137 MimeType& mime, |
|
3674
9201a7858cce
fix warnings with recent wasm
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3658
diff
changeset
|
138 const std::string& key) ORTHANC_OVERRIDE |
|
2976
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2950
diff
changeset
|
139 { |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2950
diff
changeset
|
140 return false; |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2950
diff
changeset
|
141 } |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2950
diff
changeset
|
142 |
|
2620
1232922c8793
speeding up shutdown if Lua script is in trailing phase
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2616
diff
changeset
|
143 void AwakeTrailingSleep() |
|
1232922c8793
speeding up shutdown if Lua script is in trailing phase
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2616
diff
changeset
|
144 { |
|
1232922c8793
speeding up shutdown if Lua script is in trailing phase
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2616
diff
changeset
|
145 operationAdded_.notify_one(); |
|
1232922c8793
speeding up shutdown if Lua script is in trailing phase
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2616
diff
changeset
|
146 } |
| 2603 | 147 }; |
| 148 } |