Thread.h

Go to the documentation of this file.

#ifndef ossimThread_HEADER
#define ossimThread_HEADER 1
#include <ossim/base/ossimConstants.h>
#include <ossim/base/Barrier.h>
#include <thread>
#include <mutex>
#include <condition_variable>
#include <atomic>
#include <string>

namespace ossim{

   class OSSIM_DLL Thread
   {
   public:
      class Interrupt : public std::exception{
      public:
         Interrupt(const std::string& what=""):m_what(what){}
         virtual const char* what() const throw(){return m_what.c_str();}
      protected:
         std::string m_what;
      };
      Thread();

      virtual ~Thread();

      void start();

      bool isRunning()const{return m_running.load(std::memory_order_relaxed);}

      bool isInterruptable()const{return m_interrupt.load(std::memory_order_relaxed);}

      virtual void cancel(){setCancel(true);}

      virtual void setCancel(bool flag);

      virtual void waitForCompletion();

      void pause();

      void resume();

      bool isPaused()const;

      static void sleepInSeconds(ossim_uint64 seconds);

      static void sleepInMilliSeconds(ossim_uint64 millis);

      static void sleepInMicroSeconds(ossim_uint64 micros);

      static std::thread::id getCurrentThreadId();

      static ossim_uint64 getNumberOfProcessors();
      static void yieldCurrentThread();

   protected:
      virtual void run()=0;

      virtual void interrupt();

      virtual void runInternal();

   private:
      std::shared_ptr<std::thread>    m_thread;
      std::atomic<bool>               m_running;
      std::atomic<bool>               m_interrupt;
      std::shared_ptr<ossim::Barrier> m_pauseBarrier;
      std::condition_variable         m_runningCondition;
      mutable std::mutex              m_runningMutex;

      void setInterruptable(bool flag);
   };
}

#endif