src/lib/platform/threads/threads.h

   1 #pragma once
   2 /*
   3  * This file is part of the libCEC(R) library.
   4  *
   5  * libCEC(R) is Copyright (C) 2011-2012 Pulse-Eight Limited.  All rights reserved.
   6  * libCEC(R) is an original work, containing original code.
   7  *
   8  * libCEC(R) is a trademark of Pulse-Eight Limited.
   9  *
  10  * This program is dual-licensed; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  23  *
  24  *
  25  * Alternatively, you can license this library under a commercial license,
  26  * please contact Pulse-Eight Licensing for more information.
  27  *
  28  * For more information contact:
  29  * Pulse-Eight Licensing       <license@pulse-eight.com>
  30  *     http://www.pulse-eight.com/
  31  *     http://www.pulse-eight.net/
  32  */
  33
  34 #include "mutex.h"
  35
  36 namespace PLATFORM
  37 {
  38   class CThread
  39   {
  40   public:
  41     CThread(void) :
  42         m_bStop(false),
  43         m_bRunning(false),
  44         m_bStopped(false) {}
  45
  46     virtual ~CThread(void)
  47     {
  48       StopThread(0);
  49     }
  50
  51     static void *ThreadHandler(CThread *thread)
  52     {
  53       void *retVal = NULL;
  54
  55       if (thread)
  56       {
  57         {
  58           CLockObject lock(thread->m_threadMutex);
  59           thread->m_bRunning = true;
  60           thread->m_bStopped = false;
  61           thread->m_threadCondition.Broadcast();
  62         }
  63
  64         retVal = thread->Process();
  65
  66         {
  67           CLockObject lock(thread->m_threadMutex);
  68           thread->m_bRunning = false;
  69           thread->m_bStopped = true;
  70           thread->m_threadCondition.Broadcast();
  71         }
  72       }
  73
  74       return retVal;
  75     }
  76
  77     virtual bool IsRunning(void)
  78     {
  79       CLockObject lock(m_threadMutex);
  80       return m_bRunning;
  81     }
  82
  83     virtual bool IsStopped(void)
  84     {
  85       CLockObject lock(m_threadMutex);
  86       return m_bStop;
  87     }
  88
  89     virtual bool CreateThread(bool bWait = true)
  90     {
  91         bool bReturn(false);
  92         CLockObject lock(m_threadMutex);
  93         if (!IsRunning())
  94         {
  95           m_bStop = false;
  96           if (ThreadsCreate(m_thread, CThread::ThreadHandler, ((void*)static_cast<CThread *>(this))))
  97           {
  98             if (bWait)
  99               m_threadCondition.Wait(m_threadMutex, m_bRunning);
 100             bReturn = true;
 101           }
 102         }
 103       return bReturn;
 104     }
 105
 106     /*!
 107      * @brief Stop the thread
 108      * @param iWaitMs negative = don't wait, 0 = infinite, or the amount of ms to wait
 109      */
 110     virtual bool StopThread(int iWaitMs = 5000)
 111     {
 112       bool bReturn(true);
 113       bool bRunning(false);
 114       {
 115         CLockObject lock(m_threadMutex);
 116         bRunning = IsRunning();
 117         m_bStop = true;
 118       }
 119
 120       if (bRunning && iWaitMs >= 0)
 121       {
 122         CLockObject lock(m_threadMutex);
 123         bReturn = m_threadCondition.Wait(m_threadMutex, m_bStopped, iWaitMs);
 124       }
 125       else
 126       {
 127         bReturn = true;
 128       }
 129
 130       return bReturn;
 131     }
 132
 133     virtual bool Sleep(uint32_t iTimeout)
 134     {
 135       CLockObject lock(m_threadMutex);
 136       return m_bStop ? false : m_threadCondition.Wait(m_threadMutex, m_bStopped, iTimeout);
 137     }
 138
 139     virtual void *Process(void) = 0;
 140
 141   protected:
 142     void SetRunning(bool bSetTo);
 143
 144   private:
 145     bool             m_bStop;
 146     bool             m_bRunning;
 147     bool             m_bStopped;
 148     CCondition<bool> m_threadCondition;
 149     CMutex           m_threadMutex;
 150     thread_t         m_thread;
 151   };
 152 };