dali/devel-api/threading/thread.h

   1 #ifndef DALI_THREAD_H
   2 #define DALI_THREAD_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 // INTERNAL INCLUDES
  22 #include <dali/public-api/common/dali-common.h>
  23
  24 /**
  25  * The top level DALi namespace
  26  */
  27 namespace Dali
  28 {
  29
  30 /*
  31  * @brief Abstract class for thread functionality. Can be used for worker threads.
  32  */
  33 class DALI_CORE_API Thread
  34 {
  35 public:
  36
  37   /**
  38    * @brief Creates a new thread and make it executable.
  39    */
  40   void Start();
  41
  42   /**
  43    * @brief Wait for thread termination.
  44    */
  45   void Join();
  46
  47 protected:
  48
  49   /**
  50    * @brief Constructor
  51    */
  52   Thread();
  53
  54   /**
  55    * @brief Destructor, virtual as this is used as base class
  56    */
  57   virtual ~Thread();
  58
  59   /**
  60    * The routine that the thread will execute once it is started.
  61    */
  62   virtual void Run() = 0;
  63
  64 private:
  65
  66   /**
  67    * Helper for the thread calling the entry function.
  68    * @param[in] This A pointer to the current thread object
  69    */
  70   static void InternalThreadEntryFunc( Thread& This );
  71
  72   // Undefined
  73   Thread( const Thread& );
  74   // Undefined
  75   const Thread& operator=( const Thread& );
  76
  77 private:
  78
  79   struct ThreadImpl;
  80   ThreadImpl* mImpl;
  81
  82 };
  83
  84 }
  85
  86 #endif // DALI_THREAD_H