annotate Framework/Toolbox/IWebService.h @ 267:89d02de83c03 am-2

added declaretion of messages handled/emitted
author am@osimis.io
date Wed, 22 Aug 2018 14:59:20 +0200
parents c9cf95b49a86
children 5bd4161bf11b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
57
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Stone of Orthanc
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
135
e2fe9352f240 upgrade to year 2018
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 113
diff changeset
5 * Copyright (C) 2017-2018 Osimis S.A., Belgium
57
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * modify it under the terms of the GNU Affero General Public License
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * as published by the Free Software Foundation, either version 3 of
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * the License, or (at your option) any later version.
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * This program is distributed in the hope that it will be useful, but
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
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
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * You should have received a copy of the GNU Affero General Public License
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 **/
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 #pragma once
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23
212
5412adf19980 resort to OrthancFramework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 201
diff changeset
24 #include <Core/IDynamicObject.h>
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
25 #include "../../Framework/Messages/IObserver.h"
57
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 #include <string>
252
40b21c1f8b8d more usage of IObservable/IObserver
am@osimis.io
parents: 251
diff changeset
27 #include <Core/Logging.h>
57
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 namespace OrthancStone
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 {
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
31 class IWebService
57
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 {
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
33 protected:
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
34 MessageBroker& broker_;
57
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 public:
257
9afafb192180 using PAM
am@osimis.io
parents: 252
diff changeset
36 typedef std::map<std::string, std::string> Headers;
9afafb192180 using PAM
am@osimis.io
parents: 252
diff changeset
37
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
38 class ICallback : public IObserver
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
39 {
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
40 public:
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
41 struct HttpRequestSuccessMessage: public IMessage
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
42 {
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
43 const std::string& Uri;
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
44 const void* Answer;
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
45 size_t AnswerSize;
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
46 Orthanc::IDynamicObject* Payload;
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
47 HttpRequestSuccessMessage(const std::string& uri,
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
48 const void* answer,
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
49 size_t answerSize,
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
50 Orthanc::IDynamicObject* payload)
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
51 : IMessage(MessageType_HttpRequestSuccess),
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
52 Uri(uri),
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
53 Answer(answer),
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
54 AnswerSize(answerSize),
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
55 Payload(payload)
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
56 {}
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
57 };
57
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
59 struct HttpRequestErrorMessage: public IMessage
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
60 {
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
61 const std::string& Uri;
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
62 Orthanc::IDynamicObject* Payload;
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
63 HttpRequestErrorMessage(const std::string& uri,
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
64 Orthanc::IDynamicObject* payload)
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
65 : IMessage(MessageType_HttpRequestError),
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
66 Uri(uri),
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
67 Payload(payload)
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
68 {}
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
69 };
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
70
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
71 ICallback(MessageBroker& broker)
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
72 : IObserver(broker)
267
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
73 {
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
74 DeclareHandledMessage(MessageType_HttpRequestError);
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
75 DeclareHandledMessage(MessageType_HttpRequestSuccess);
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
76 }
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
77 virtual ~ICallback()
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
78 {
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
79 }
57
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80
266
c9cf95b49a86 removed OrthancSlicesLoader::ISliceLoaderObserver; now using standard messages instead
am@osimis.io
parents: 257
diff changeset
81 virtual void HandleMessage(const IObservable& from, const IMessage& message)
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
82 {
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
83 switch(message.GetType())
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
84 {
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
85 case MessageType_HttpRequestError:
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
86 { const HttpRequestErrorMessage& msg = dynamic_cast<const HttpRequestErrorMessage&>(message);
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
87 OnHttpRequestError(msg.Uri,
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
88 msg.Payload);
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
89 }; break;
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
90
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
91 case MessageType_HttpRequestSuccess:
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
92 {
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
93 const HttpRequestSuccessMessage& msg = dynamic_cast<const HttpRequestSuccessMessage&>(message);
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
94 OnHttpRequestSuccess(msg.Uri,
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
95 msg.Answer,
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
96 msg.AnswerSize,
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
97 msg.Payload);
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
98 }; break;
252
40b21c1f8b8d more usage of IObservable/IObserver
am@osimis.io
parents: 251
diff changeset
99 default:
40b21c1f8b8d more usage of IObservable/IObserver
am@osimis.io
parents: 251
diff changeset
100 VLOG("unhandled message type" << message.GetType());
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
101 }
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
102 }
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
103
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
104 virtual void OnHttpRequestError(const std::string& uri,
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
105 Orthanc::IDynamicObject* payload) = 0;
57
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
106
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
107 virtual void OnHttpRequestSuccess(const std::string& uri,
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
108 const void* answer,
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
109 size_t answerSize,
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
110 Orthanc::IDynamicObject* payload) = 0;
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
111 };
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
112
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
113 IWebService(MessageBroker& broker)
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
114 : broker_(broker)
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
115 {}
57
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
116
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
117 virtual ~IWebService()
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
118 {
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
119 }
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
120
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
121 virtual void ScheduleGetRequest(ICallback& callback,
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
122 const std::string& uri,
257
9afafb192180 using PAM
am@osimis.io
parents: 252
diff changeset
123 const Headers& headers,
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
124 Orthanc::IDynamicObject* payload) = 0;
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
125
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
126 virtual void SchedulePostRequest(ICallback& callback,
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
127 const std::string& uri,
257
9afafb192180 using PAM
am@osimis.io
parents: 252
diff changeset
128 const Headers& headers,
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
129 const std::string& body,
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
130 Orthanc::IDynamicObject* payload) = 0;
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
131 };
57
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
132 }