Changeset bc2698

Timestamp:

Dec 13, 2011, 9:43:39 AM (14 years ago)

Author:

Frederik Heber <heber@…>

Children:

e2e035e

Parents:

e7352a5

git-author:

Frederik Heber <heber@…> (12/01/11 09:09:18)

git-committer:

Frederik Heber <heber@…> (12/13/11 09:43:39)

Message:

NotificationChannels is now static entity.

• this is in line with the other static entities on Observable that are intended to save memory (before we needed 8 bytes for the pointer in each and every Observable instances, whether it had channels or not.)
• Modified NOTIFY macro to accomodate for the changes.
• enhanced documentation of class Notifications.

Location:

src/Patterns

Files:

• Observer.cpp (modified) (2 diffs)
• Observer.hpp (modified) (3 diffs)
• unittests/stubs/ObserverStub.cpp (modified) (1 diff)

src/Patterns/Observer.cpp

@@ -43 +43 @@
 std::map<Observable*,std::set<Notification*> > Observable::notifications;
 set<Observable*> Observable::busyObservables; //!< Set of Observables that are currently busy notifying their sign-on'ed Observers
+Observable::ChannelMap Observable::NotificationChannels; //!< Map of Observables to their Channels.
 
 /** Attaching Sub-observables to Observables.
@@ -278 +279 @@
 Notification_ptr Observable::getChannel(size_t no) const
 {
-  ASSERT(NotificationChannels != NULL,
+  ChannelMap::iterator iter = NotificationChannels.find(const_cast<Observable *>(this));
+  ASSERT(iter != NotificationChannels.end(),
+      "Observable::getChannel() - we do not have a channel in NotificationChannels.");
+  const Channels *OurChannel = iter->second;
+  ASSERT(OurChannel != NULL,
       "Observable::getChannel() - observable has no channels.");
-  return NotificationChannels->getChannel(no);
+  return OurChannel->getChannel(no);
 }
 

src/Patterns/Observer.hpp

@@ -168 +168 @@
   static void enque_notification_internal(Observable *publisher, Notification_ptr notification);
 
-  Channels *NotificationChannels;
+  typedef std::map<Observable*, Channels *> ChannelMap;
+  static ChannelMap NotificationChannels;
 
 private:
@@ -197 +198 @@
 };
 
-/** Notifications are sort of new channels of an Observable.
+/** Notifications are sort of news channels of an Observable.
  * Via the NOTIFY() macro updates can be transmitted in a specific channel.
  * Observers can subscribe to Notification in much the same way as they can to
- * the Observable itself. Usually, Notifications
+ * the Observable itself. Usually, Notifications are used along
+ * with the usual OBSERVE() macro to generate both the specific and
+ * the global message of change.
  */
 class Notification {
@@ -287 +290 @@
 #define PASTE_HELPER(a,b) a ## b
 #define OBSERVE Observable::_Observable_protector PASTE(_scope_obs_protector_,__LINE__)(this)
-#define NOTIFY(channelno) do{Observable::enque_notification_internal(this,NotificationChannels->getChannel(channelno));}while(0)
+#define NOTIFY(channelno) do{const ChannelMap::const_iterator iter=NotificationChannels.find(this);ASSERT(iter!=NotificationChannels.end(),"NOTIFY() - channel not found.");Observable::enque_notification_internal(this,iter->second->getChannel(channelno));}while(0)
 #define LOCK_OBSERVABLE(observable) Observable::_Observable_protector PASTE(_scope_obs_protector_,__LINE__)(&(observable))
 

src/Patterns/unittests/stubs/ObserverStub.cpp

@@ -132 +132 @@
   Observable("NotificationObservable")
 {
-  NotificationChannels = new Channels(this);
-  NotificationChannels->addChannel(Operation1Notify);
-  NotificationChannels->addChannel(Operation2Notify);
+  Channels *OurChannel = new Channels(this);
+  NotificationChannels.insert( std::make_pair(this, OurChannel) );
+  OurChannel->addChannel(Operation1Notify);
+  OurChannel->addChannel(Operation2Notify);
 }
 
 NotificationObservable::~NotificationObservable()
 {
-  delete NotificationChannels;
+  NotificationChannels.erase(this);
 }