dali/internal/system/common/callback-manager.h

   1 #ifndef __DALI_INTERNAL_CALLBACK_MANAGER_H__
   2 #define __DALI_INTERNAL_CALLBACK_MANAGER_H__
   3
   4 /*
   5  * Copyright (c) 2018 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 // EXTERNAL INCLUDES
  22 #include <dali/public-api/signals/callback.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/public-api/dali-adaptor-common.h>
  26
  27 namespace Dali
  28 {
  29
  30 namespace Internal
  31 {
  32
  33 namespace Adaptor
  34 {
  35
  36 /**
  37  * Abstract interface to install call backs in to an applications main loop.
  38  */
  39 class CallbackManager
  40 {
  41
  42 public:
  43
  44     /**
  45      * Create a new call back interface
  46      */
  47     static CallbackManager* New();
  48
  49     /**
  50      * Virtual destructor
  51      */
  52     virtual ~CallbackManager() {}
  53
  54     /**
  55      * @brief Adds a @p callback to be run on idle.
  56      * @note Must be called from the main thread only.
  57      *
  58      * @param[in] callback custom callback function.
  59      *
  60      * @return true on success
  61      */
  62     virtual bool AddIdleCallback( CallbackBase* callback ) = 0;
  63
  64     /**
  65      * @brief Removes a previously added @p callback.
  66      * @note Must be called from main thread only.
  67      *
  68      * Does nothing if the @p callback doesn't exist.
  69      *
  70      * @param[in] callback The callback to be removed.
  71      */
  72     virtual void RemoveIdleCallback( CallbackBase* callback ) = 0;
  73
  74     /**
  75      * Starts the callback manager.
  76      */
  77     virtual void Start() = 0;
  78
  79     /**
  80      * Stop the callback manager and can remove all pending callbacks synchronously.
  81      * This call will synchronise with the main loop and not return
  82      * until all call backs have been deleted.
  83      */
  84     virtual void Stop() = 0;
  85
  86 protected:
  87
  88     /**
  89      * constructor
  90      */
  91     CallbackManager() {}
  92
  93 private:
  94
  95     // Undefined copy constructor.
  96     CallbackManager( const CallbackManager& );
  97
  98     // Undefined assignment operator.
  99     CallbackManager& operator=( const CallbackManager& );
 100
 101 };
 102
 103 } // namespace Adaptor
 104
 105 } // namespace Internal
 106
 107 } // namespace Dali
 108
 109 #endif // __DALI_INTERNAL_CALLBACK_MANAGER_H__