EuRepeatingThread.h

Go to the documentation of this file.

#ifndef INC_EUREPEATINGTHREAD_H
#define INC_EUREPEATINGTHREAD_H
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
// includes
#include "EuToolTypes.h"
#include "EuCriticalSection.h"
#include <thread>
#include <condition_variable>
#include <mutex>
//-----------------------------------------------------------------------------
/* 'Bezeichner': Klasse 'Typ' benötigt eine DLL-Schnittstelle, die von... */
#ifdef _MSC_VER
  #pragma warning( disable : 4251 )
#endif
//-----------------------------------------------------------------------------
namespace eut
{
  //---------------------------------------------------------------------------
  class __tool_export_dll RepeatingThread
  {
    public:
      //============== local enums
      enum EuTHREADERROR
      {
 
        EuTHREAD_ERR_NO_THREAD = -10301,
        EuTHREAD_ERR_THREAD_ALREADY_WORKING = -10302,
        EuTHREAD_ERR_THREAD_BREAK_COUNT_LESS_THAN_ZERO = -10303,
        EuTHREAD_ERR_UNKNOWN = -10400,
      };
      //-----------------------------------------------------------------------
 
      //-----------------------------------------------------------------------
      enum STATUS
      {
        eAT_THE_START,
        eWORKING,
        ePAUSING,
        eENDING,
        eCOMPLETED
      };
      //-----------------------------------------------------------------------
      enum ORDER
      {
        eUNDEFINED,
        eDO_WORK,
        eEXIT
      };
      //-----------------------------------------------------------------------
 
    private:
      //============== Attribute
      //-----------------------------------------------------------------------
      STATUS m_eStatus;
      //-----------------------------------------------------------------------
      ORDER m_eOrder;
      //-----------------------------------------------------------------------
      std::thread * m_pThread;
      //-----------------------------------------------------------------------
      CriticalSection m_ExclusiveAccessSection;
      //-----------------------------------------------------------------------
      std::mutex m_WaitMutex;
      //-----------------------------------------------------------------------
      std::condition_variable m_InputCondVar;
      //-----------------------------------------------------------------------
      std::mutex m_BreakMutex;
      //-----------------------------------------------------------------------
      std::condition_variable m_BreakCondVar;
      //-----------------------------------------------------------------------
      int m_iBreakCounter;
      //-----------------------------------------------------------------------
      int m_iDataReady;
      //-----------------------------------------------------------------------
 
    #ifdef _DEBUG
      public:
        //============== Attribute
        //-----------------------------------------------------------------------
        std::string m_strDebugInfo;
        //-----------------------------------------------------------------------
    #endif
 
    public:
      //============== ctors & dtor
      //-----------------------------------------------------------------------
      RepeatingThread();
      //-----------------------------------------------------------------------
      virtual ~RepeatingThread();
      //-----------------------------------------------------------------------
 
    private:
      //-----------------------------------------------------------------------
      RepeatingThread( const RepeatingThread & );
      //-----------------------------------------------------------------------
 
    protected:
      //============== methods
      //-----------------------------------------------------------------------
      void threadWork();
      //-----------------------------------------------------------------------
      void setStatus( STATUS eStatus );
      //-----------------------------------------------------------------------
      STATUS getStatus();
      //-----------------------------------------------------------------------
      void toOrder( ORDER eOrder );
      //-----------------------------------------------------------------------
      ORDER getOrder();
      //-----------------------------------------------------------------------
      virtual void work() = 0;
      //-----------------------------------------------------------------------
 
    public:
      //============== methods
      //-----------------------------------------------------------------------
      virtual int start();
      //-----------------------------------------------------------------------
      virtual void cancel();
      //-----------------------------------------------------------------------
      bool testCancel();
      //-----------------------------------------------------------------------
      RepeatingThread::STATUS status() const;
      //-----------------------------------------------------------------------
      bool isInExclusiveAccess() const;
      //-----------------------------------------------------------------------
      void setExclusiveAccess();
      //-----------------------------------------------------------------------
      void unsetExclusiveAccess();
      //-----------------------------------------------------------------------
      int getBreakCounter();
      //-----------------------------------------------------------------------
      virtual void takeABreak();
      //-----------------------------------------------------------------------
      virtual void finishBreak();
      //-----------------------------------------------------------------------
      void waitForInput();
      //-----------------------------------------------------------------------
      void signalInput();
      //-----------------------------------------------------------------------
 
    private:
      //============== operators
      //-----------------------------------------------------------------------
      RepeatingThread & operator= ( const RepeatingThread & );
      //-----------------------------------------------------------------------
  };
  //---------------------------------------------------------------------------
  /* 'Bezeichner': Klasse 'Typ' benötigt eine DLL-Schnittstelle, die von... */
  #ifdef _MSC_VER
    #pragma warning( default : 4251 )
  #endif
  //---------------------------------------------------------------------------
} // namespace eut
#endif