timers.h

   1 /*\r
   2     Copyright 2004-2005 Chris Tallon\r
   3 \r
   4     This file is part of VOMP.\r
   5 \r
   6     VOMP is free software; you can redistribute it and/or modify\r
   7     it under the terms of the GNU General Public License as published by\r
   8     the Free Software Foundation; either version 2 of the License, or\r
   9     (at your option) any later version.\r
  10 \r
  11     VOMP is distributed in the hope that it will be useful,\r
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  14     GNU General Public License for more details.\r
  15 \r
  16     You should have received a copy of the GNU General Public License\r
  17     along with VOMP; if not, write to the Free Software\r
  18     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
  19 */\r
  20 \r
  21 #ifndef TIMERS_H\r
  22 #define TIMERS_H\r
  23 \r
  24 #include <stdio.h>\r
  25 #include <pthread.h>\r
  26 #include <list>\r
  27 \r
  28 #include "defines.h"\r
  29 #include "log.h"\r
  30 #include "thread.h"\r
  31 #include "command.h"\r
  32 #include "timerreceiver.h"\r
  33 \r
  34 /*\r
  35 \r
  36 Timers documentation\r
  37 \r
  38 Call setTimer to set a timer.... cancelTimer to delete a running timer.\r
  39 Derive your object from TimerReceiver (timerreceiver.h), implement timercall() in your class\r
  40 and supply your 'this' pointer to setTimer.\r
  41 \r
  42 Once a timer has fired it does not exist anymore, you have to keep creating them if you want\r
  43 a constant pulse.\r
  44 \r
  45 clientReference is any int of your choice. It will be supplied back to you in the timercall()\r
  46 so you can identify which timer has fired if you have more than one.\r
  47 \r
  48 You can reset a timer by calling setTimer again. This will not create 2 timers, it will overwrite the first one.\r
  49 \r
  50 You must not allow a timer to fire on an object that has been deleted already, unless you want\r
  51 segfaulty hell.\r
  52 \r
  53 */\r
  54 \r
  55 class Timer\r
  56 {\r
  57   public:\r
  58     TimerReceiver* client;\r
  59     int clientReference;\r
  60     struct timespec requestedTime;\r
  61 };\r
  62 \r
  63 using namespace std;\r
  64 //using namespace __gnu_cxx;\r
  65 typedef list<Timer*> TimerList;\r
  66 \r
  67 class Timers : public Thread\r
  68 {\r
  69   public:\r
  70     Timers();\r
  71     virtual ~Timers();\r
  72     static Timers* getInstance();\r
  73 \r
  74     int init();\r
  75     int shutdown();\r
  76 \r
  77     int setTimer(TimerReceiver* client, int clientReference, long int requestedTime, long int requestedTimeNSEC=0);\r
  78     int setTimer(TimerReceiver* client, int clientReference, timespec duration);\r
  79     int cancelTimer(TimerReceiver* client, int clientReference);\r
  80 \r
  81     // Thread stuff\r
  82     virtual void threadMethod();\r
  83     virtual void threadPostStopCleanup() {};\r
  84 \r
  85   private:\r
  86     static Timers* instance;\r
  87     Log* logger;\r
  88     bool initted;\r
  89     TimerList timerList;\r
  90     bool resetThreadFlag;\r
  91 };\r
  92 \r
  93 #endif\r