Mercurial > hg > orthanc-stone
annotate Framework/Messages/IObservable.cpp @ 1064:af4b9cba905f broker
simplify how observers are regsitered, and how callables are created
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Tue, 15 Oct 2019 13:46:01 +0200 |
parents | e713f1a99861 |
children | 9d42f89b8c3c |
rev | line source |
---|---|
403 | 1 /** |
2 * Stone of Orthanc | |
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics | |
4 * Department, University Hospital of Liege, Belgium | |
439 | 5 * Copyright (C) 2017-2019 Osimis S.A., Belgium |
403 | 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 #include "IObservable.h" | |
23 | |
973
38409549db43
Log with addresses + added fingerprint mechanism to avoid calling zombie objects
Benjamin Golinvaux <bgo@osimis.io>
parents:
643
diff
changeset
|
24 #include <Core/Logging.h> |
403 | 25 #include <Core/OrthancException.h> |
26 | |
27 #include <cassert> | |
28 | |
29 namespace OrthancStone | |
30 { | |
31 IObservable::~IObservable() | |
32 { | |
33 // delete all callables (this will also unregister them from the broker) | |
34 for (Callables::const_iterator it = callables_.begin(); | |
35 it != callables_.end(); ++it) | |
36 { | |
37 for (std::set<ICallable*>::const_iterator | |
38 it2 = it->second.begin(); it2 != it->second.end(); ++it2) | |
39 { | |
40 delete *it2; | |
41 } | |
42 } | |
43 | |
44 // unregister the forwarders but don't delete them (they'll be | |
45 // deleted by the observable they are observing as any other | |
46 // callable) | |
47 for (Forwarders::iterator it = forwarders_.begin(); | |
48 it != forwarders_.end(); ++it) | |
49 { | |
50 IMessageForwarder* fw = *it; | |
1059
e713f1a99861
replacing MessageBroker by weak_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
977
diff
changeset
|
51 |
e713f1a99861
replacing MessageBroker by weak_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
977
diff
changeset
|
52 // TODO - What to do with forwarders? |
e713f1a99861
replacing MessageBroker by weak_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
977
diff
changeset
|
53 |
e713f1a99861
replacing MessageBroker by weak_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
977
diff
changeset
|
54 //broker_.Unregister(dynamic_cast<IObserver&>(*fw)); |
403 | 55 } |
56 } | |
57 | |
58 | |
59 void IObservable::RegisterObserverCallback(ICallable* callable) | |
60 { | |
61 if (callable == NULL) | |
62 { | |
63 throw Orthanc::OrthancException(Orthanc::ErrorCode_NullPointer); | |
64 } | |
65 | |
643
f0008c55e5f7
getting rid of MessageType enumeration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
623
diff
changeset
|
66 const MessageIdentifier& id = callable->GetMessageIdentifier(); |
f0008c55e5f7
getting rid of MessageType enumeration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
623
diff
changeset
|
67 callables_[id].insert(callable); |
403 | 68 } |
69 | |
428
751fb354149e
ability to change the scene of the RadiographyWidget
am@osimis.io
parents:
403
diff
changeset
|
70 void IObservable::Unregister(IObserver *observer) |
751fb354149e
ability to change the scene of the RadiographyWidget
am@osimis.io
parents:
403
diff
changeset
|
71 { |
977
262a0244e9b2
Added missing Unregister for objects that register by the broker + logs + guard in FetchContext
Benjamin Golinvaux <bgo@osimis.io>
parents:
973
diff
changeset
|
72 LOG(TRACE) << "IObservable::Unregister for IObserver at addr: " |
262a0244e9b2
Added missing Unregister for objects that register by the broker + logs + guard in FetchContext
Benjamin Golinvaux <bgo@osimis.io>
parents:
973
diff
changeset
|
73 << std::hex << observer << std::dec; |
428
751fb354149e
ability to change the scene of the RadiographyWidget
am@osimis.io
parents:
403
diff
changeset
|
74 // delete all callables from this observer |
751fb354149e
ability to change the scene of the RadiographyWidget
am@osimis.io
parents:
403
diff
changeset
|
75 for (Callables::iterator itCallableSet = callables_.begin(); |
751fb354149e
ability to change the scene of the RadiographyWidget
am@osimis.io
parents:
403
diff
changeset
|
76 itCallableSet != callables_.end(); ++itCallableSet) |
751fb354149e
ability to change the scene of the RadiographyWidget
am@osimis.io
parents:
403
diff
changeset
|
77 { |
751fb354149e
ability to change the scene of the RadiographyWidget
am@osimis.io
parents:
403
diff
changeset
|
78 for (std::set<ICallable*>::const_iterator |
751fb354149e
ability to change the scene of the RadiographyWidget
am@osimis.io
parents:
403
diff
changeset
|
79 itCallable = itCallableSet->second.begin(); itCallable != itCallableSet->second.end(); ) |
751fb354149e
ability to change the scene of the RadiographyWidget
am@osimis.io
parents:
403
diff
changeset
|
80 { |
1059
e713f1a99861
replacing MessageBroker by weak_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
977
diff
changeset
|
81 boost::shared_ptr<IObserver> shared((*itCallable)->GetObserver()); |
e713f1a99861
replacing MessageBroker by weak_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
977
diff
changeset
|
82 |
e713f1a99861
replacing MessageBroker by weak_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
977
diff
changeset
|
83 if (shared && |
e713f1a99861
replacing MessageBroker by weak_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
977
diff
changeset
|
84 shared.get() == observer) |
428
751fb354149e
ability to change the scene of the RadiographyWidget
am@osimis.io
parents:
403
diff
changeset
|
85 { |
977
262a0244e9b2
Added missing Unregister for objects that register by the broker + logs + guard in FetchContext
Benjamin Golinvaux <bgo@osimis.io>
parents:
973
diff
changeset
|
86 LOG(TRACE) << " ** IObservable::Unregister : deleting callable: " |
262a0244e9b2
Added missing Unregister for objects that register by the broker + logs + guard in FetchContext
Benjamin Golinvaux <bgo@osimis.io>
parents:
973
diff
changeset
|
87 << std::hex << (*itCallable) << std::dec; |
428
751fb354149e
ability to change the scene of the RadiographyWidget
am@osimis.io
parents:
403
diff
changeset
|
88 delete *itCallable; |
751fb354149e
ability to change the scene of the RadiographyWidget
am@osimis.io
parents:
403
diff
changeset
|
89 itCallableSet->second.erase(itCallable++); |
751fb354149e
ability to change the scene of the RadiographyWidget
am@osimis.io
parents:
403
diff
changeset
|
90 } |
751fb354149e
ability to change the scene of the RadiographyWidget
am@osimis.io
parents:
403
diff
changeset
|
91 else |
751fb354149e
ability to change the scene of the RadiographyWidget
am@osimis.io
parents:
403
diff
changeset
|
92 ++itCallable; |
751fb354149e
ability to change the scene of the RadiographyWidget
am@osimis.io
parents:
403
diff
changeset
|
93 } |
751fb354149e
ability to change the scene of the RadiographyWidget
am@osimis.io
parents:
403
diff
changeset
|
94 } |
751fb354149e
ability to change the scene of the RadiographyWidget
am@osimis.io
parents:
403
diff
changeset
|
95 } |
403 | 96 |
623
42dadae61fa9
renamed IObservable::EmitMessage() as BroadcastMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
440
diff
changeset
|
97 void IObservable::EmitMessageInternal(const IObserver* receiver, |
42dadae61fa9
renamed IObservable::EmitMessage() as BroadcastMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
440
diff
changeset
|
98 const IMessage& message) |
403 | 99 { |
977
262a0244e9b2
Added missing Unregister for objects that register by the broker + logs + guard in FetchContext
Benjamin Golinvaux <bgo@osimis.io>
parents:
973
diff
changeset
|
100 LOG(TRACE) << "IObservable::EmitMessageInternal receiver = " |
262a0244e9b2
Added missing Unregister for objects that register by the broker + logs + guard in FetchContext
Benjamin Golinvaux <bgo@osimis.io>
parents:
973
diff
changeset
|
101 << std::hex << receiver << std::dec; |
643
f0008c55e5f7
getting rid of MessageType enumeration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
623
diff
changeset
|
102 Callables::const_iterator found = callables_.find(message.GetIdentifier()); |
403 | 103 |
104 if (found != callables_.end()) | |
105 { | |
106 for (std::set<ICallable*>::const_iterator | |
107 it = found->second.begin(); it != found->second.end(); ++it) | |
108 { | |
109 assert(*it != NULL); | |
623
42dadae61fa9
renamed IObservable::EmitMessage() as BroadcastMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
440
diff
changeset
|
110 |
1059
e713f1a99861
replacing MessageBroker by weak_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
977
diff
changeset
|
111 boost::shared_ptr<IObserver> observer((*it)->GetObserver()); |
e713f1a99861
replacing MessageBroker by weak_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
977
diff
changeset
|
112 |
e713f1a99861
replacing MessageBroker by weak_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
977
diff
changeset
|
113 if (observer) |
403 | 114 { |
623
42dadae61fa9
renamed IObservable::EmitMessage() as BroadcastMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
440
diff
changeset
|
115 if (receiver == NULL || // Are we broadcasting? |
1059
e713f1a99861
replacing MessageBroker by weak_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
977
diff
changeset
|
116 observer.get() == receiver) // Not broadcasting, but this is the receiver |
623
42dadae61fa9
renamed IObservable::EmitMessage() as BroadcastMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
440
diff
changeset
|
117 { |
42dadae61fa9
renamed IObservable::EmitMessage() as BroadcastMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
440
diff
changeset
|
118 (*it)->Apply(message); |
42dadae61fa9
renamed IObservable::EmitMessage() as BroadcastMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
440
diff
changeset
|
119 } |
403 | 120 } |
1064
af4b9cba905f
simplify how observers are regsitered, and how callables are created
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1059
diff
changeset
|
121 else |
af4b9cba905f
simplify how observers are regsitered, and how callables are created
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1059
diff
changeset
|
122 { |
af4b9cba905f
simplify how observers are regsitered, and how callables are created
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1059
diff
changeset
|
123 // TODO => Remove "it" from the list of callables => This |
af4b9cba905f
simplify how observers are regsitered, and how callables are created
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1059
diff
changeset
|
124 // allows to suppress the need for "Unregister()" |
af4b9cba905f
simplify how observers are regsitered, and how callables are created
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1059
diff
changeset
|
125 } |
403 | 126 } |
127 } | |
128 } | |
129 | |
623
42dadae61fa9
renamed IObservable::EmitMessage() as BroadcastMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
440
diff
changeset
|
130 |
42dadae61fa9
renamed IObservable::EmitMessage() as BroadcastMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
440
diff
changeset
|
131 void IObservable::BroadcastMessage(const IMessage& message) |
42dadae61fa9
renamed IObservable::EmitMessage() as BroadcastMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
440
diff
changeset
|
132 { |
42dadae61fa9
renamed IObservable::EmitMessage() as BroadcastMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
440
diff
changeset
|
133 EmitMessageInternal(NULL, message); |
42dadae61fa9
renamed IObservable::EmitMessage() as BroadcastMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
440
diff
changeset
|
134 } |
42dadae61fa9
renamed IObservable::EmitMessage() as BroadcastMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
440
diff
changeset
|
135 |
42dadae61fa9
renamed IObservable::EmitMessage() as BroadcastMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
440
diff
changeset
|
136 |
42dadae61fa9
renamed IObservable::EmitMessage() as BroadcastMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
440
diff
changeset
|
137 void IObservable::EmitMessage(const IObserver& observer, |
42dadae61fa9
renamed IObservable::EmitMessage() as BroadcastMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
440
diff
changeset
|
138 const IMessage& message) |
42dadae61fa9
renamed IObservable::EmitMessage() as BroadcastMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
440
diff
changeset
|
139 { |
977
262a0244e9b2
Added missing Unregister for objects that register by the broker + logs + guard in FetchContext
Benjamin Golinvaux <bgo@osimis.io>
parents:
973
diff
changeset
|
140 LOG(TRACE) << "IObservable::EmitMessage observer = " |
262a0244e9b2
Added missing Unregister for objects that register by the broker + logs + guard in FetchContext
Benjamin Golinvaux <bgo@osimis.io>
parents:
973
diff
changeset
|
141 << std::hex << &observer << std::dec; |
623
42dadae61fa9
renamed IObservable::EmitMessage() as BroadcastMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
440
diff
changeset
|
142 EmitMessageInternal(&observer, message); |
42dadae61fa9
renamed IObservable::EmitMessage() as BroadcastMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
440
diff
changeset
|
143 } |
403 | 144 |
145 void IObservable::RegisterForwarder(IMessageForwarder* forwarder) | |
146 { | |
147 if (forwarder == NULL) | |
148 { | |
149 throw Orthanc::OrthancException(Orthanc::ErrorCode_NullPointer); | |
150 } | |
151 | |
152 forwarders_.insert(forwarder); | |
153 } | |
154 } |