annotate Framework/Messages/IMessage.h @ 299:3897f9f28cfa am-callable-and-promise

backup work in progress: updated messaging framework with ICallable
author am@osimis.io
date Fri, 14 Sep 2018 16:44:01 +0200
parents 192e6e349e69
children 4a79193ffb58
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
250
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
1 /**
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
2 * Stone of Orthanc
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
5 * Copyright (C) 2017-2018 Osimis S.A., Belgium
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
6 *
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
8 * modify it under the terms of the GNU Affero General Public License
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
9 * as published by the Free Software Foundation, either version 3 of
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
10 * the License, or (at your option) any later version.
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
11 *
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
12 * This program is distributed in the hope that it will be useful, but
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
15 * Affero General Public License for more details.
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
16 *
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
17 * You should have received a copy of the GNU Affero General Public License
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
19 **/
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
20
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
21
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
22 #pragma once
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
23
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
24 #include "MessageType.h"
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
25
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 250
diff changeset
26 #include <boost/noncopyable.hpp>
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 250
diff changeset
27
250
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
28 namespace OrthancStone {
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
29
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
30
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
31 // base message that are exchanged between IObservable and IObserver
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
32 struct IMessage : public boost::noncopyable
250
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
33 {
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
34 MessageType messageType_;
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
35 protected:
250
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
36 IMessage(const MessageType& messageType)
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
37 : messageType_(messageType)
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
38 {}
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
39 public:
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 250
diff changeset
40 virtual ~IMessage() {}
250
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
41
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
42 MessageType GetType() const {return messageType_;}
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
43 };
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
44
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
45
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
46 // base class to derive from to implement your own messages
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
47 // it handles the message type for you
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
48 template <MessageType type>
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
49 struct BaseMessage : public IMessage
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
50 {
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
51 enum
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
52 {
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
53 Type = type
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
54 };
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
55
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
56 BaseMessage()
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
57 : IMessage(static_cast<MessageType>(Type))
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
58 {}
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
59 };
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
60
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
61 // simple message implementation when no payload is needed
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
62 // sample usage:
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
63 // typedef NoPayloadMessage<MessageType_LayerSource_GeometryReady> GeometryReadyMessage;
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
64 template <MessageType type>
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
65 struct NoPayloadMessage : public BaseMessage<type>
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
66 {
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
67 NoPayloadMessage()
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
68 : BaseMessage<type>()
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
69 {}
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
70
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
71 };
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
72
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
73 // simple message implementation when no payload is needed but the origin is required
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
74 // sample usage:
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
75 // typedef OriginMessage<MessageType_SliceLoader_GeometryError, OrthancSlicesLoader> SliceGeometryErrorMessage;
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
76 template <MessageType type, typename TOrigin>
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
77 struct OriginMessage : public BaseMessage<type>
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
78 {
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
79 TOrigin& origin_;
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
80 OriginMessage(TOrigin& origin)
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
81 : BaseMessage<type>(),
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
82 origin_(origin)
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
83 {}
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
84
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
85 };
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
86
250
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
87 }