dali/internal/event/common/notification-manager.h

   1 #ifndef __DALI_INTERNAL_NOTIFICATION_MANAGER_H__
   2 #define __DALI_INTERNAL_NOTIFICATION_MANAGER_H__
   3
   4 /*
   5  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // INTERNAL INCLUDES
  22
  23 namespace Dali
  24 {
  25
  26 namespace Internal
  27 {
  28
  29 class PropertyNotification;
  30 class MessageBase;
  31
  32 /**
  33  * Provides notifications to the event-thread regarding the changes in previous update(s).
  34  * For example after an animation finished, or after resources were loaded.
  35  */
  36 class NotificationManager
  37 {
  38 public:
  39
  40   /**
  41    * Create an NotificationManager. Owned by Core in event thread side.
  42    */
  43   NotificationManager();
  44
  45   /**
  46    * Virtual destructor.
  47    */
  48   virtual ~NotificationManager();
  49
  50 /// Update side interface, can only be called from Update-thread
  51
  52   /**
  53    * Queue a scene message. This method is thread-safe.
  54    * @param[in] message A newly allocated message; NotificationManager takes ownership.
  55    */
  56   void QueueMessage( MessageBase* message );
  57
  58   /**
  59    * Signal Notification Manager that update frame is completed so it can let event thread process the notifications
  60    */
  61   void UpdateCompleted();
  62
  63 /// Event side interface, can only be called from Update-thread
  64
  65   /**
  66    * Query whether the NotificationManager has messages to process.
  67    * @return True if there are messages to process.
  68    */
  69   bool MessagesToProcess();
  70
  71   /**
  72    * This function is called by Core when events are processed.
  73    */
  74   void ProcessMessages();
  75
  76   /**
  77    * Retrieve the notification count; this is incremented when Notify() is called.
  78    */
  79   unsigned int GetNotificationCount() const;
  80
  81 private:
  82
  83   struct Impl;
  84   Impl* mImpl;
  85 };
  86
  87 /**
  88  * A functor for querying the notification count.
  89  * This is useful for skipping duplicate operations during NotificationManager::Notify()
  90  */
  91 struct NotificationCountQuery
  92 {
  93   NotificationCountQuery(const NotificationManager& manager)
  94   : mNotificationManager(manager)
  95   {
  96   }
  97
  98   unsigned int operator()() const
  99   {
 100     return mNotificationManager.GetNotificationCount();
 101   }
 102
 103 private:
 104
 105   const NotificationManager& mNotificationManager;
 106 };
 107
 108 } // namespace Internal
 109
 110 } // namespace Dali
 111
 112 #endif // __DALI_INTERNAL_NOTIFICATION_MANAGER_H__
 113