Changeset dd7c44

Timestamp:

Oct 30, 2015, 11:43:20 AM (10 years ago)

Author:

Frederik Heber <heber@…>

Children:

6e2f3b

Parents:

1f96ec

git-author:

Frederik Heber <heber@…> (07/10/15 09:44:07)

git-committer:

Frederik Heber <heber@…> (10/30/15 11:43:20)

Message:

Added static functions to control access to static NotificationChannels.

• Relay is friend as it uses the mutex when accessing.
• this is to protect changes in NotificationChannels from changes outside the scope of this library.

Location:

src

Files:

• CodePatterns/Observer/Observable.hpp (modified) (3 diffs)
• Observer/Observable.cpp (modified) (5 diffs)
• Observer/unittests/stubs/ObserverStub.cpp (modified) (3 diffs)

src/CodePatterns/Observer/Observable.hpp

@@ -45 +45 @@
  */
 class Observable : public Observer {
+  //!> grant Relay access to NotificationChannels as we know it uses the mutex as well
+  friend class Relay;
 public:
   //!> typedef for a vector of channels
@@ -134 +136 @@
 
 protected:
+
+  static void insertNotificationChannel( std::pair<Observable*, Channels *> _pair);
+  static void eraseNotificationChannel(Observable * const _target);
+  static bool isNotificationChannelPresent(const Observable * const _target);
+  static const Channels *getNotificationChannels(const Observable * const _target);
+  static Notification_ptr getNotificationChannel(const Observable * const _target, const size_t _no);
+
+private:
 
   typedef std::map<Observable*, Channels *> ChannelMap;
@@ -188 +198 @@
 #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[this]->getChannel(channelno));}while(0)
+#define NOTIFY(channelno) do{Observable::enque_notification_internal(this,Observable::getNotificationChannel(this,channelno));}while(0)
 #define LOCK_OBSERVABLE(observable) Observable::_Observable_protector PASTE(_scope_obs_protector_,__LINE__)(&(observable))
 

src/Observer/Observable.cpp

@@ -335 +335 @@
 Notification_ptr Observable::getChannel(size_t no) const
 {
-  boost::recursive_mutex::scoped_lock lock(GlobalObservableInfo::getInstance().getObservablesMapMutex());
-  const ChannelMap::const_iterator iter = NotificationChannels.find(const_cast<Observable *>(this));
-  const bool status = iter != NotificationChannels.end();
-  Channels *OurChannel = NULL;
-  if (status)
-    OurChannel = iter->second;
-  ASSERT(status,
-      "Observable::getChannel() - we do not have a channel "+toString(no)+" in NotificationChannels.");
-  ASSERT(OurChannel != NULL,
-      "Observable::getChannel() - observable has no channels.");
-  return OurChannel->getChannel(no);
+  return getNotificationChannel(this, no);
 }
 
@@ -361 +351 @@
   }
   {
-    const ChannelMap::const_iterator iter =
-        NotificationChannels.find(const_cast<Observable *>(this));
-    // if not present, then we have zero observers
-    if (iter != NotificationChannels.end())
-      for (Channels::NotificationTypetoRefMap::const_iterator channeliter = iter->second->ChannelMap.begin();
-          channeliter != iter->second->ChannelMap.end();
+    boost::recursive_mutex::scoped_lock lock(GlobalObservableInfo::getInstance().getObservablesMapMutex());
+    const Channels *OurChannels = getNotificationChannels(this);
+    if (OurChannels != NULL)
+      for (Channels::NotificationTypetoRefMap::const_iterator channeliter = OurChannels->ChannelMap.begin();
+          channeliter != OurChannels->ChannelMap.end();
           ++channeliter)
         ObserverCount += (channeliter->second)->getNumberOfObservers();
@@ -396 +385 @@
 
   if (!_channels.empty()) {
-    boost::recursive_mutex::scoped_lock lock(GlobalObservableInfo::getInstance().getObservablesMapMutex());
     Channels *OurChannel = new Channels;
-    NotificationChannels.insert( std::make_pair(static_cast<Observable *>(this), OurChannel) );
     // add instance for each notification type
     for (channels_t::const_iterator iter = _channels.begin();
         iter != _channels.end(); ++iter)
       OurChannel->addChannel(*iter);
+    insertNotificationChannel( std::make_pair(static_cast<Observable *>(this), OurChannel) );
   }
 }
@@ -436 +424 @@
 
   // also kill instance in static Channels map if present
-  {
-    boost::recursive_mutex::scoped_lock lock(GlobalObservableInfo::getInstance().getObservablesMapMutex());
-    ChannelMap::iterator iter = NotificationChannels.find(static_cast<Observable *>(this));
-    if (iter != NotificationChannels.end()) {
-      iter->second->subjectKilled(static_cast<Observable *>(this));
-      delete iter->second;
-      NotificationChannels.erase(iter);
-    }
-  }
+  eraseNotificationChannel(this);
 }
 
@@ -453 +433 @@
   return channels;
 }
+
+void Observable::insertNotificationChannel(std::pair<Observable*, Channels *> _pair)
+{
+  boost::recursive_mutex::scoped_lock lock(GlobalObservableInfo::getInstance().getObservablesMapMutex());
+  NotificationChannels.insert(_pair);
+}
+
+void Observable::eraseNotificationChannel(Observable * const _target)
+{
+  boost::recursive_mutex::scoped_lock lock(GlobalObservableInfo::getInstance().getObservablesMapMutex());
+  ChannelMap::iterator iter = NotificationChannels.find(static_cast<Observable *>(_target));
+  if (iter != NotificationChannels.end()) {
+    iter->second->subjectKilled(static_cast<Observable *>(_target));
+    delete iter->second;
+    NotificationChannels.erase(iter);
+  }
+}
+
+bool Observable::isNotificationChannelPresent(const Observable * const _target)
+{
+  boost::recursive_mutex::scoped_lock lock(GlobalObservableInfo::getInstance().getObservablesMapMutex());
+  ChannelMap::const_iterator iter =
+      NotificationChannels.find(const_cast<Observable * const>(_target));
+  return iter != NotificationChannels.end();
+}
+
+
+const Channels* Observable::getNotificationChannels(const Observable * const _target)
+{
+  boost::recursive_mutex::scoped_lock lock(GlobalObservableInfo::getInstance().getObservablesMapMutex());
+  ChannelMap::const_iterator iter =
+      NotificationChannels.find(const_cast<Observable * const>(_target));
+  if (iter != NotificationChannels.end())
+    return iter->second;
+  else
+    return NULL;
+}
+
+Notification_ptr Observable::getNotificationChannel(const Observable * const _target, const size_t _no)
+{
+  boost::recursive_mutex::scoped_lock lock(GlobalObservableInfo::getInstance().getObservablesMapMutex());
+  ChannelMap::const_iterator iter =
+      NotificationChannels.find(const_cast<Observable * const>(_target));
+  ASSERT(iter != NotificationChannels.end(),
+      "Observable::getNotificationChannel() - could not find channel for target "
+      +toString(_target)+".");
+  return iter->second->getChannel(_no);
+}

src/Observer/unittests/stubs/ObserverStub.cpp

@@ -136 +136 @@
 {
   Channels *OurChannel = new Channels();
-  NotificationChannels.insert( std::make_pair(this, OurChannel) );
+  Observable::insertNotificationChannel( std::make_pair(this, OurChannel) );
   OurChannel->addChannel(Operation1Notify);
   OurChannel->addChannel(Operation2Notify);
@@ -143 +143 @@
 NotificationObservable::~NotificationObservable()
 {
-  NotificationChannels.erase(this);
+  Observable::eraseNotificationChannel(this);
 }
 
@@ -245 +245 @@
 {
   Channels *OurChannel = new Channels();
-  NotificationChannels.insert( std::make_pair(this, OurChannel) );
+  Observable::insertNotificationChannel( std::make_pair(this, OurChannel) );
   OurChannel->addChannel(NotificationObservable::Operation1Notify);
   OurChannel->addChannel(NotificationObservable::Operation2Notify);