annotate Framework/Messages/IObservable.h @ 302:4a79193ffb58 am-callable-and-promise

support for custom messages + no leaks in unit-tests
author am@osimis.io
date Tue, 18 Sep 2018 18:04:53 +0200
parents b4abaeb783b1
children b66d13708f40
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
267
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
24 #include <set>
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
25 #include <assert.h>
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
26 #include <algorithm>
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
27 #include <iostream>
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 268
diff changeset
28 #include <map>
267
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
29
302
4a79193ffb58 support for custom messages + no leaks in unit-tests
am@osimis.io
parents: 300
diff changeset
30
250
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
31 #include "MessageBroker.h"
267
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
32 #include "MessageType.h"
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 268
diff changeset
33 #include "ICallable.h"
267
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
34 #include "IObserver.h"
302
4a79193ffb58 support for custom messages + no leaks in unit-tests
am@osimis.io
parents: 300
diff changeset
35 #include "MessageForwarder.h"
250
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
36
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
37 namespace OrthancStone {
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
38
302
4a79193ffb58 support for custom messages + no leaks in unit-tests
am@osimis.io
parents: 300
diff changeset
39
250
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
40 class IObservable : public boost::noncopyable
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
41 {
258
e5a9b3d03478 first very basic version of SmartLoader
am@osimis.io
parents: 250
diff changeset
42 protected:
250
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
43 MessageBroker& broker_;
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: 268
diff changeset
45 typedef std::map<int, std::set<ICallable*> > Callables;
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 268
diff changeset
46 Callables callables_;
250
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
47
302
4a79193ffb58 support for custom messages + no leaks in unit-tests
am@osimis.io
parents: 300
diff changeset
48 typedef std::set<IMessageForwarder*> Forwarders;
4a79193ffb58 support for custom messages + no leaks in unit-tests
am@osimis.io
parents: 300
diff changeset
49 Forwarders forwarders_;
4a79193ffb58 support for custom messages + no leaks in unit-tests
am@osimis.io
parents: 300
diff changeset
50
250
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
51 public:
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
52
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
53 IObservable(MessageBroker& broker)
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
54 : broker_(broker)
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
55 {
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
56 }
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
57 virtual ~IObservable()
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
58 {
302
4a79193ffb58 support for custom messages + no leaks in unit-tests
am@osimis.io
parents: 300
diff changeset
59 // delete all callables (this will also unregister them from the broker)
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 268
diff changeset
60 for (Callables::const_iterator it = callables_.begin();
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 268
diff changeset
61 it != callables_.end(); ++it)
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 268
diff changeset
62 {
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 268
diff changeset
63 for (std::set<ICallable*>::const_iterator
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 268
diff changeset
64 it2 = it->second.begin(); it2 != it->second.end(); ++it2)
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 268
diff changeset
65 {
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 268
diff changeset
66 delete *it2;
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 268
diff changeset
67 }
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 268
diff changeset
68 }
302
4a79193ffb58 support for custom messages + no leaks in unit-tests
am@osimis.io
parents: 300
diff changeset
69
4a79193ffb58 support for custom messages + no leaks in unit-tests
am@osimis.io
parents: 300
diff changeset
70 // unregister the forwarders but don't delete them (they'll be deleted by the observable they are observing as any other callable)
4a79193ffb58 support for custom messages + no leaks in unit-tests
am@osimis.io
parents: 300
diff changeset
71 for (Forwarders::iterator it = forwarders_.begin();
4a79193ffb58 support for custom messages + no leaks in unit-tests
am@osimis.io
parents: 300
diff changeset
72 it != forwarders_.end(); ++it)
4a79193ffb58 support for custom messages + no leaks in unit-tests
am@osimis.io
parents: 300
diff changeset
73 {
4a79193ffb58 support for custom messages + no leaks in unit-tests
am@osimis.io
parents: 300
diff changeset
74 broker_.Unregister(dynamic_cast<IObserver&>(**it));
4a79193ffb58 support for custom messages + no leaks in unit-tests
am@osimis.io
parents: 300
diff changeset
75 }
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 268
diff changeset
76 }
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 268
diff changeset
77
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 268
diff changeset
78 void RegisterObserverCallback(ICallable* callable)
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 268
diff changeset
79 {
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 268
diff changeset
80 MessageType messageType = callable->GetMessageType();
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 268
diff changeset
81
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 268
diff changeset
82 callables_[messageType].insert(callable);
250
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
83 }
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
84
268
5bd4161bf11b removed constness of the observable when emitting a message
am@osimis.io
parents: 267
diff changeset
85 void EmitMessage(const IMessage& message)
250
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
86 {
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 268
diff changeset
87 Callables::const_iterator found = callables_.find(message.GetType());
250
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
88
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 268
diff changeset
89 if (found != callables_.end())
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 268
diff changeset
90 {
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 268
diff changeset
91 for (std::set<ICallable*>::const_iterator
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 268
diff changeset
92 it = found->second.begin(); it != found->second.end(); ++it)
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 268
diff changeset
93 {
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 268
diff changeset
94 if (broker_.IsActive((*it)->GetObserver()))
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 268
diff changeset
95 {
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 268
diff changeset
96 (*it)->Apply(message);
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 268
diff changeset
97 }
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 268
diff changeset
98 }
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 268
diff changeset
99 }
250
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
100 }
267
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
101
302
4a79193ffb58 support for custom messages + no leaks in unit-tests
am@osimis.io
parents: 300
diff changeset
102 void RegisterForwarder(IMessageForwarder* forwarder)
4a79193ffb58 support for custom messages + no leaks in unit-tests
am@osimis.io
parents: 300
diff changeset
103 {
4a79193ffb58 support for custom messages + no leaks in unit-tests
am@osimis.io
parents: 300
diff changeset
104 forwarders_.insert(forwarder);
4a79193ffb58 support for custom messages + no leaks in unit-tests
am@osimis.io
parents: 300
diff changeset
105 }
4a79193ffb58 support for custom messages + no leaks in unit-tests
am@osimis.io
parents: 300
diff changeset
106
250
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
107 };
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
108
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
109 }