dali/internal/system/common/trigger-event.h

   1 #ifndef DALI_INTERNAL_TRIGGER_EVENT_H
   2 #define DALI_INTERNAL_TRIGGER_EVENT_H
   3
   4 /*
   5  * Copyright (c) 2019 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 #include <dali/internal/system/common/file-descriptor-monitor.h>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali/public-api/dali-adaptor-common.h>
  27 #include <dali/integration-api/trigger-event-interface.h>
  28
  29 namespace Dali
  30 {
  31
  32 namespace Internal
  33 {
  34
  35 namespace Adaptor
  36 {
  37
  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] callback The callback to call
  59    * @param[in] options Trigger event options.
  60    * @note The ownership of callback is taken by this class.
  61    */
  62   TriggerEvent( CallbackBase* callback, TriggerEventInterface::Options options );
  63
  64   /**
  65    * Destructor
  66    */
  67   ~TriggerEvent();
  68
  69 public:
  70
  71   /**
  72    * Triggers the event.
  73    *
  74    * This can be called from one thread in order to wake up another thread.
  75    */
  76   void Trigger();
  77
  78 private:
  79
  80   /**
  81    * @brief Called when our event file descriptor has been written to.
  82    * @param[in] eventBitMask bit mask of events that occured on the file descriptor
  83    */
  84   void Triggered( FileDescriptorMonitor::EventType eventBitMask );
  85
  86 private:
  87
  88   struct Source;
  89
  90 private:
  91
  92   FileDescriptorMonitor* mFileDescriptorMonitor;
  93   CallbackBase* mCallback;
  94   int mFileDescriptor;
  95   TriggerEventInterface::Options mOptions;
  96 };
  97
  98 } // namespace Adaptor
  99
 100 } // namespace Internal
 101
 102 } // namespace Dali
 103
 104 #endif // DALI_INTERNAL_TRIGGER_EVENT_H