cxTimer.h

Go to the documentation of this file.

// Copyright (c) 2026 Eric N. Oulashin
#ifndef __CXTIMER_H__
#define __CXTIMER_H__
 
// Copyright (c) 2005-2007 Michael H. Kinney
 
#include "cxFunction.h"
#include <string>
#include <memory>
#include <mutex>
#include <atomic>
 
namespace cx {
 
class cxTimer
{
   public:
      cxTimer(const std::shared_ptr<cxFunction>& pFuncPtr, unsigned int pDelayMS, bool pWaitInSeparateThread = true);
 
      virtual ~cxTimer();
 
      virtual void function(const std::shared_ptr<cxFunction>& pFuncPtr);
 
      virtual std::shared_ptr<cxFunction> function() const;
 
      virtual void delay(unsigned int pDelay);
 
      virtual unsigned int delay() const;
 
      virtual void waitInSeparateThread(bool pWaitInSeparateThread);
 
      virtual bool waitInSeparateThread() const;
 
      virtual void start();
 
      virtual void stop(bool pRunFunction = true);
 
      virtual bool isWaiting() const;
 
      virtual std::string cxTypeStr() const;
 
   private:
      std::shared_ptr<cxFunction> mFunction; // The function to run after the delay
      unsigned int mDelay;                   // The delay in MS
      bool mWaitInSeparateThread;            // Whether or not to wait in a separate thread
      //int mPID = -1;                         // The process ID of wait()
      std::atomic<bool> mIsWaiting{false};               // Status indicator for whether the timer is currently waiting for time to elapse
      std::atomic<bool> mRunFunctionAfterWaiting{true};  // Control for whether to run the function after the time elapses
      std::mutex mWaitMutex;                 // Mutex to be used in wait(), to lock anything used in there
 
      // Waits a number of milliseconds equal to mDelay
      // and then runs the function.
      void wait();
};
 
} // namespace cx
 
#endif