comparison Framework/Loaders/LoaderStateMachine.h @ 1337:b1396be5aa27 broker

Moved the fixed loaders back from the dead
author Benjamin Golinvaux <bgo@osimis.io>
date Fri, 03 Apr 2020 16:13:06 +0200
parents Framework/Deprecated/Loaders/LoaderStateMachine.h@9b126de2cde2
children 556b4bc19118
comparison
equal deleted inserted replaced
1334:04055b6b9e2c 1337:b1396be5aa27
1 /**
2 * Stone of Orthanc
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 Affero General Public License
9 * as published by the Free Software Foundation, either version 3 of
10 * the License, or (at your option) any later version.
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
15 * Affero General Public License for more details.
16 *
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 **/
20
21
22 #pragma once
23
24 #include "../../Messages/IObservable.h"
25 #include "../../Messages/ObserverBase.h"
26 #include "../../Oracle/GetOrthancImageCommand.h"
27 #include "../../Oracle/GetOrthancWebViewerJpegCommand.h"
28 #include "../../Oracle/IOracle.h"
29 #include "../../Oracle/OracleCommandExceptionMessage.h"
30 #include "../../Oracle/OrthancRestApiCommand.h"
31
32 #include <Core/IDynamicObject.h>
33
34 #include <list>
35
36 namespace OrthancStone
37 {
38 /**
39 This class is supplied with Oracle commands and will schedule up to
40 simultaneousDownloads_ of them at the same time, then will schedule the
41 rest once slots become available. It is used, a.o., by the
42 OrtancMultiframeVolumeLoader class.
43
44 To use it, you need to create commands that derive from State.
45
46 You need to initialize them with the object that must be called when
47 an answer is received.
48 */
49
50 class LoaderStateMachine : public OrthancStone::ObserverBase<LoaderStateMachine>
51 {
52 public:
53 class State : public Orthanc::IDynamicObject
54 {
55 private:
56 LoaderStateMachine& that_;
57
58 public:
59 State(LoaderStateMachine& that) :
60 that_(that)
61 {
62 }
63
64 State(const State& currentState) :
65 that_(currentState.that_)
66 {
67 }
68
69 void Schedule(OrthancStone::OracleCommandBase* command) const
70 {
71 that_.Schedule(command);
72 }
73
74 template <typename T>
75 T& GetLoader() const
76 {
77 return dynamic_cast<T&>(that_);
78 }
79
80 virtual void Handle(const OrthancStone::OrthancRestApiCommand::SuccessMessage& message);
81
82 virtual void Handle(const OrthancStone::GetOrthancImageCommand::SuccessMessage& message);
83
84 virtual void Handle(const OrthancStone::GetOrthancWebViewerJpegCommand::SuccessMessage& message);
85 };
86
87 void Schedule(OrthancStone::OracleCommandBase* command);
88
89 void Start();
90
91 private:
92 void Step();
93
94 void Clear();
95
96 void HandleExceptionMessage(const OrthancStone::OracleCommandExceptionMessage& message);
97
98 template <typename T>
99 void HandleSuccessMessage(const T& message);
100
101 typedef std::list<OrthancStone::IOracleCommand*> PendingCommands;
102
103 OrthancStone::ILoadersContext& loadersContext_;
104 bool active_;
105 unsigned int simultaneousDownloads_;
106 PendingCommands pendingCommands_;
107 unsigned int activeCommands_;
108
109
110 public:
111 LoaderStateMachine(OrthancStone::ILoadersContext& loadersContext);
112
113 void PostConstructor();
114
115 virtual ~LoaderStateMachine();
116
117 bool IsActive() const
118 {
119 return active_;
120 }
121
122 void SetSimultaneousDownloads(unsigned int count);
123 };
124 }