timedthread.h

Go to the documentation of this file.

// ##########################################################################
// ####                                                                  ####
// ####                      RTP Audio Server Project                    ####
// ####                    ============================                  ####
// ####                                                                  ####
// #### Timed Thread                                                     ####
// ####                                                                  ####
// #### Version 1.00  --  February 16, 2001                              ####
// ####                                                                  ####
// #### Copyright (C) 1999  Thomas Dreibholz                             ####
// ####               2000  Universität Bonn, Abt. IV                    ####
// ####               2001  EMail: dreibh@iem.uni-due.de                 ####
// ####                     WWW:   https://www.uni-due.de/~be0001        ####
// ####                                                                  ####
// ##########################################################################


#ifndef TIMEDTHREAD_H
#define TIMEDTHREAD_H


#include "system.h"
#include "thread.h"


#include <signal.h>


#if _NSIG <= 31
#error Your Kernel does not support more than 32 signals => SIGUSR1 reserved! Kernel update required!
#endif


namespace Coral {


class TimedThread : public Thread
{
   // ====== Constructor/Destructor =========================================
   public:
   TimedThread(const card64 usec, const cardinal flags = ThreadCancelAsynchronous);
   
   ~TimedThread();


   // ====== Interval functions =============================================
   inline card64 getInterval() const;
   
   void setInterval(const card64 usec);

   inline cardinal getTimerCorrection() const;
    
   inline void setTimerCorrection(const cardinal maxCorrection = 0);

   inline void leaveCorrectionLoop();

   inline void setFastStart(const bool on);

   inline bool getFastStart() const;

   void stop();

   inline bool pendingTimerEvent() const;


   // ====== timerEvent() to be implemented by subclass =====================
   protected:
   virtual void timerEvent() = 0;


   // ====== Private data ===================================================
   private:
   void run();


   card64   Interval;
   cardinal TimerCorrection;
   bool     AlarmHandlerInitialized;
   bool     FastStart;
   bool     NewInterval;
   bool     LeaveCorrectionLoop;
};


}


#include "timedthread.icc"


#endif