Mercurial > hg > orthanc-stone
annotate Framework/Deprecated/Toolbox/IWebService.h @ 1305:a5326ce4f24b broker
Trackers and measuring tools now use the viewport instead of ViewportController, so that proper locks can be used
author | Benjamin Golinvaux <bgo@osimis.io> |
---|---|
date | Wed, 04 Mar 2020 09:45:38 +0100 |
parents | 7ec8fea061b9 |
children | 30deba7bc8e2 |
rev | line source |
---|---|
57 | 1 /** |
2 * Stone of Orthanc | |
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics | |
4 * Department, University Hospital of Liege, Belgium | |
1270
2d8ab34c8c91
upgrade to year 2020
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1048
diff
changeset
|
5 * Copyright (C) 2017-2020 Osimis S.A., Belgium |
57 | 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. | |
251
192e6e349e69
first usage of new message system (in SDL only)
am@osimis.io
parents:
212
diff
changeset
|
16 * |
57 | 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 | |
732
c35e98d22764
move Deprecated classes to a separate folder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
726
diff
changeset
|
24 #include "../../Messages/IObserver.h" |
c35e98d22764
move Deprecated classes to a separate folder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
726
diff
changeset
|
25 #include "../../Messages/ICallable.h" |
377 | 26 |
1048
f6be9412e42a
cleaning up IObservable.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
940
diff
changeset
|
27 #include <Core/Enumerations.h> |
377 | 28 #include <Core/IDynamicObject.h> |
29 #include <Core/Logging.h> | |
30 | |
57 | 31 #include <string> |
299
3897f9f28cfa
backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents:
288
diff
changeset
|
32 #include <map> |
57 | 33 |
726
4f2416d519b4
moving layers, widgets and loaders to Deprecated namespace
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
643
diff
changeset
|
34 namespace Deprecated |
57 | 35 { |
1222
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
36 template <typename TMessage> |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
37 class MessageHandler : public OrthancStone::ICallable |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
38 { |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
39 }; |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
40 |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
41 |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
42 template <typename TObserver, |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
43 typename TMessage> |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
44 class DeprecatedCallable : public MessageHandler<TMessage> |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
45 { |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
46 private: |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
47 typedef void (TObserver::* MemberMethod) (const TMessage&); |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
48 |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
49 boost::weak_ptr<OrthancStone::IObserver> observer_; |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
50 MemberMethod function_; |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
51 |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
52 public: |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
53 DeprecatedCallable(boost::shared_ptr<TObserver> observer, |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
54 MemberMethod function) : |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
55 observer_(observer), |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
56 function_(function) |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
57 { |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
58 } |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
59 |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
60 virtual void Apply(const OrthancStone::IMessage& message) |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
61 { |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
62 boost::shared_ptr<OrthancStone::IObserver> lock(observer_); |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
63 if (lock) |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
64 { |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
65 TObserver& observer = dynamic_cast<TObserver&>(*lock); |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
66 const TMessage& typedMessage = dynamic_cast<const TMessage&>(message); |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
67 (observer.*function_) (typedMessage); |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
68 } |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
69 } |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
70 |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
71 virtual const OrthancStone::MessageIdentifier& GetMessageIdentifier() |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
72 { |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
73 return TMessage::GetStaticIdentifier(); |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
74 } |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
75 |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
76 virtual boost::weak_ptr<OrthancStone::IObserver> GetObserver() const |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
77 { |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
78 return observer_; |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
79 } |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
80 }; |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
81 |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
82 |
288 | 83 // The IWebService performs HTTP requests. |
84 // Since applications can run in native or WASM environment and, since | |
85 // in a WASM environment, the WebService is asynchronous, the IWebservice | |
86 // also implements an asynchronous interface: you must schedule a request | |
87 // and you'll be notified when the response/error is ready. | |
377 | 88 class IWebService : public boost::noncopyable |
269 | 89 { |
90 public: | |
417
aee3d7941c9b
preparing to load images using DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
383
diff
changeset
|
91 typedef std::map<std::string, std::string> HttpHeaders; |
257 | 92 |
726
4f2416d519b4
moving layers, widgets and loaders to Deprecated namespace
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
643
diff
changeset
|
93 class HttpRequestSuccessMessage : public OrthancStone::IMessage |
299
3897f9f28cfa
backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents:
288
diff
changeset
|
94 { |
643
f0008c55e5f7
getting rid of MessageType enumeration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
440
diff
changeset
|
95 ORTHANC_STONE_MESSAGE(__FILE__, __LINE__); |
f0008c55e5f7
getting rid of MessageType enumeration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
440
diff
changeset
|
96 |
377 | 97 private: |
98 const std::string& uri_; | |
99 const void* answer_; | |
100 size_t answerSize_; | |
417
aee3d7941c9b
preparing to load images using DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
383
diff
changeset
|
101 const HttpHeaders& answerHeaders_; |
377 | 102 const Orthanc::IDynamicObject* payload_; |
103 | |
104 public: | |
301 | 105 HttpRequestSuccessMessage(const std::string& uri, |
309 | 106 const void* answer, |
107 size_t answerSize, | |
417
aee3d7941c9b
preparing to load images using DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
383
diff
changeset
|
108 const HttpHeaders& answerHeaders, |
377 | 109 const Orthanc::IDynamicObject* payload) : |
110 uri_(uri), | |
111 answer_(answer), | |
112 answerSize_(answerSize), | |
417
aee3d7941c9b
preparing to load images using DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
383
diff
changeset
|
113 answerHeaders_(answerHeaders), |
377 | 114 payload_(payload) |
115 { | |
116 } | |
117 | |
118 const std::string& GetUri() const | |
119 { | |
120 return uri_; | |
121 } | |
122 | |
123 const void* GetAnswer() const | |
124 { | |
125 return answer_; | |
126 } | |
127 | |
128 size_t GetAnswerSize() const | |
129 { | |
130 return answerSize_; | |
131 } | |
132 | |
417
aee3d7941c9b
preparing to load images using DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
383
diff
changeset
|
133 const HttpHeaders& GetAnswerHttpHeaders() const |
aee3d7941c9b
preparing to load images using DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
383
diff
changeset
|
134 { |
aee3d7941c9b
preparing to load images using DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
383
diff
changeset
|
135 return answerHeaders_; |
aee3d7941c9b
preparing to load images using DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
383
diff
changeset
|
136 } |
aee3d7941c9b
preparing to load images using DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
383
diff
changeset
|
137 |
377 | 138 bool HasPayload() const |
139 { | |
140 return payload_ != NULL; | |
141 } | |
142 | |
143 const Orthanc::IDynamicObject& GetPayload() const; | |
144 }; | |
145 | |
146 | |
726
4f2416d519b4
moving layers, widgets and loaders to Deprecated namespace
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
643
diff
changeset
|
147 class HttpRequestErrorMessage : public OrthancStone::IMessage |
299
3897f9f28cfa
backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents:
288
diff
changeset
|
148 { |
643
f0008c55e5f7
getting rid of MessageType enumeration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
440
diff
changeset
|
149 ORTHANC_STONE_MESSAGE(__FILE__, __LINE__); |
f0008c55e5f7
getting rid of MessageType enumeration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
440
diff
changeset
|
150 |
377 | 151 private: |
152 const std::string& uri_; | |
153 const Orthanc::IDynamicObject* payload_; | |
940
861c080ef47b
handling httpStatus in WebService error messages
Alain Mazy <alain@mazy.be>
parents:
732
diff
changeset
|
154 Orthanc::HttpStatus httpStatus_; |
377 | 155 |
156 public: | |
301 | 157 HttpRequestErrorMessage(const std::string& uri, |
940
861c080ef47b
handling httpStatus in WebService error messages
Alain Mazy <alain@mazy.be>
parents:
732
diff
changeset
|
158 Orthanc::HttpStatus httpStatus, |
377 | 159 const Orthanc::IDynamicObject* payload) : |
160 uri_(uri), | |
940
861c080ef47b
handling httpStatus in WebService error messages
Alain Mazy <alain@mazy.be>
parents:
732
diff
changeset
|
161 payload_(payload), |
861c080ef47b
handling httpStatus in WebService error messages
Alain Mazy <alain@mazy.be>
parents:
732
diff
changeset
|
162 httpStatus_(httpStatus) |
377 | 163 { |
164 } | |
165 | |
166 const std::string& GetUri() const | |
167 { | |
168 return uri_; | |
169 } | |
170 | |
940
861c080ef47b
handling httpStatus in WebService error messages
Alain Mazy <alain@mazy.be>
parents:
732
diff
changeset
|
171 Orthanc::HttpStatus GetHttpStatus() const |
861c080ef47b
handling httpStatus in WebService error messages
Alain Mazy <alain@mazy.be>
parents:
732
diff
changeset
|
172 { |
861c080ef47b
handling httpStatus in WebService error messages
Alain Mazy <alain@mazy.be>
parents:
732
diff
changeset
|
173 return httpStatus_; |
861c080ef47b
handling httpStatus in WebService error messages
Alain Mazy <alain@mazy.be>
parents:
732
diff
changeset
|
174 } |
861c080ef47b
handling httpStatus in WebService error messages
Alain Mazy <alain@mazy.be>
parents:
732
diff
changeset
|
175 |
377 | 176 bool HasPayload() const |
177 { | |
178 return payload_ != NULL; | |
179 } | |
180 | |
181 const Orthanc::IDynamicObject& GetPayload() const; | |
299
3897f9f28cfa
backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents:
288
diff
changeset
|
182 }; |
3897f9f28cfa
backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents:
288
diff
changeset
|
183 |
3897f9f28cfa
backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents:
288
diff
changeset
|
184 |
269 | 185 virtual ~IWebService() |
186 { | |
187 } | |
251
192e6e349e69
first usage of new message system (in SDL only)
am@osimis.io
parents:
212
diff
changeset
|
188 |
434
3a8bcc45c221
moved the HTTP cache from OrthancApiClient to BaseWebService (not implemented yet in WASM)
am@osimis.io
parents:
417
diff
changeset
|
189 virtual void EnableCache(bool enable) = 0; |
377 | 190 |
299
3897f9f28cfa
backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents:
288
diff
changeset
|
191 virtual void GetAsync(const std::string& uri, |
417
aee3d7941c9b
preparing to load images using DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
383
diff
changeset
|
192 const HttpHeaders& headers, |
377 | 193 Orthanc::IDynamicObject* payload /* takes ownership */, |
1222
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
194 MessageHandler<IWebService::HttpRequestSuccessMessage>* successCallback, |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
195 MessageHandler<IWebService::HttpRequestErrorMessage>* failureCallback = NULL, |
309 | 196 unsigned int timeoutInSeconds = 60) = 0; |
299
3897f9f28cfa
backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents:
288
diff
changeset
|
197 |
300
b4abaeb783b1
messaging refactoring almost complete: works fine in native
am@osimis.io
parents:
299
diff
changeset
|
198 virtual void PostAsync(const std::string& uri, |
417
aee3d7941c9b
preparing to load images using DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
383
diff
changeset
|
199 const HttpHeaders& headers, |
300
b4abaeb783b1
messaging refactoring almost complete: works fine in native
am@osimis.io
parents:
299
diff
changeset
|
200 const std::string& body, |
377 | 201 Orthanc::IDynamicObject* payload /* takes ownership */, |
1222
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
202 MessageHandler<IWebService::HttpRequestSuccessMessage>* successCallback, |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
203 MessageHandler<IWebService::HttpRequestErrorMessage>* failureCallback = NULL, |
309 | 204 unsigned int timeoutInSeconds = 60) = 0; |
299
3897f9f28cfa
backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents:
288
diff
changeset
|
205 |
315
aad37d0b6407
Added LayerWidget::RemoveLayer + DELETE commands in WebService
am@osimis.io
parents:
309
diff
changeset
|
206 virtual void DeleteAsync(const std::string& uri, |
417
aee3d7941c9b
preparing to load images using DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
383
diff
changeset
|
207 const HttpHeaders& headers, |
377 | 208 Orthanc::IDynamicObject* payload /* takes ownership */, |
1222
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
209 MessageHandler<IWebService::HttpRequestSuccessMessage>* successCallback, |
21c2b0eee53c
deprecating MessageHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1060
diff
changeset
|
210 MessageHandler<IWebService::HttpRequestErrorMessage>* failureCallback = NULL, |
315
aad37d0b6407
Added LayerWidget::RemoveLayer + DELETE commands in WebService
am@osimis.io
parents:
309
diff
changeset
|
211 unsigned int timeoutInSeconds = 60) = 0; |
269 | 212 }; |
57 | 213 } |