adaptors/common/trigger-event.h

   1 #ifndef __DALI_INTERNAL_TRIGGER_EVENT_H__
   2 #define __DALI_INTERNAL_TRIGGER_EVENT_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 // EXTERNAL INCLUDES
  22 #include <boost/function.hpp>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/public-api/common/dali-common.h>
  26 #include <base/interfaces/trigger-event-interface.h>
  27
  28 namespace Dali
  29 {
  30
  31 namespace Internal
  32 {
  33
  34 namespace Adaptor
  35 {
  36
  37 class FileDescriptorMonitor;
  38
  39 /**
  40  * The TriggerEvent class is used to send events between threads.  For example, this can be used
  41  * to wake up one thread from another thread.
  42  *
  43  * Typically, these should be created in the application thread.
  44  *
  45  * The observer will be informed whenever the event is triggered.
  46  *
  47  * The implementation of TriggerEvent uses an event file descriptor.
  48  */
  49 class TriggerEvent : public TriggerEventInterface
  50 {
  51 public:
  52
  53   /**
  54    * Constructor
  55    * Creates an event file descriptor and starts a GSource which reads from the file
  56    * descriptor when there is data.
  57    *
  58    * @param[in]  functor to call
  59    * @param[in] options, trigger event options.
  60    */
  61   TriggerEvent( boost::function<void()> functor, TriggerEventInterface::Options options = TriggerEventInterface::NONE );
  62
  63   /**
  64    * Destructor
  65    */
  66   ~TriggerEvent();
  67
  68 public:
  69
  70   /**
  71    * Triggers the event.
  72    *
  73    * This can be called from one thread in order to wake up another thread.
  74    */
  75   void Trigger();
  76
  77 private:
  78
  79   /**
  80    * Called when our event file descriptor has been written to.
  81    */
  82   void Triggered();
  83
  84 private:
  85
  86   struct Source;
  87
  88 private:
  89
  90   FileDescriptorMonitor* mFileDescriptorMonitor;
  91   boost::function<void()> mFunctor; ///< Function object to call
  92   int mFileDescriptor;
  93   TriggerEventInterface::Options mOptions;
  94 };
  95
  96 } // namespace Adaptor
  97
  98 } // namespace Internal
  99
 100 } // namespace Dali
 101
 102 #endif // __DALI_INTERNAL_TRIGGER_EVENT_H__