timers.h

   1
   2
   3
   4
   5
   6
   7
   8
   9
  10 /*
  11
  12
  13 FYI
  14
  15 Fixed:
  16
  17 The main problem was that timers only seemed to launch messages which went into The Big Mutex.
  18 This has been fixed a different way by implementing locking in BoxStack - meaning timercalls
  19 can now draw and update their displays without locking The Big Mutex. Problem solved. I think
  20 the whole program might move more towards classes keeping more mutexes and rely less on The
  21 Big Mutex.
  22
  23
  24
  25 >      Timers ... deprecated. Maybe.
  26
  27 >      This whole thing will be replaced with a timed-message idea. It will be possible
  28 >      to send yourself (or whoever) a message with a delay, or delivery time. The message
  29 >      will be handed to Command as usual, but command will do the right thing. The messages
  30 >      will be delivered to the recipient _with the gui mutex locked_, meaning updates can
  31 >      be done there and then in the message handler.
  32
  33 >      Good points:
  34 >      * Cuts down on code lines
  35 >      * Most (all?) timercall()s eventually send a message to command in order to
  36 >        do something within The Big Mutex. This makes it easier and simpler code wise
  37 >      * Gets rid of Timers.
  38
  39 >      Bad points:
  40 >      * Timers become gui only features. Solve this with a MessageReceiver interface and
  41 >        have command deliver messages straight to the recipients rather than through BoxStack.
  42 >      * Timer delivery accuracy becomes dependant on everything that uses The Big Mutex.
  43 >        It will become more important to not block The Big Mutex.
  44 >      * Cancelling timers... hmm
  45
  46 >      If you have any comments about the new design, like, "It's just as flawed as the old one",
  47 >      then I'd appreciate hearing it before I start writing it all :)
  48
  49
  50 */
  51
  52
  53
  54
  55
  56 /*
  57     Copyright 2004-2005 Chris Tallon
  58
  59     This file is part of VOMP.
  60
  61     VOMP is free software; you can redistribute it and/or modify
  62     it under the terms of the GNU General Public License as published by
  63     the Free Software Foundation; either version 2 of the License, or
  64     (at your option) any later version.
  65
  66     VOMP is distributed in the hope that it will be useful,
  67     but WITHOUT ANY WARRANTY; without even the implied warranty of
  68     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  69     GNU General Public License for more details.
  70
  71     You should have received a copy of the GNU General Public License
  72     along with VOMP; if not, write to the Free Software
  73     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  74 */
  75
  76 #ifndef TIMERS_H
  77 #define TIMERS_H
  78
  79 #include <stdio.h>
  80 #include <list>
  81
  82 #include "threadsystem.h"
  83
  84 #include "defines.h"
  85
  86
  87 class Log;
  88 class TimerReceiver;
  89
  90 /*
  91
  92 Timers documentation
  93
  94 Call setTimer to set a timer.... cancelTimer to delete a running timer.
  95 Derive your object from TimerReceiver (timerreceiver.h), implement timercall() in your class
  96 and supply your 'this' pointer to setTimer.
  97
  98 Once a timer has fired it does not exist anymore, you have to keep creating them if you want
  99 a constant pulse.
 100
 101 clientReference is any int of your choice. It will be supplied back to you in the timercall()
 102 so you can identify which timer has fired if you have more than one.
 103
 104 You can reset a timer by calling setTimer again. This will not create 2 timers, it will overwrite the first one.
 105
 106 You must not allow a timer to fire on an object that has been deleted already, unless you want
 107 segfaulty hell.
 108
 109 ??
 110
 111 You must call cancelTimer before deleting object. cancelTimer guarantees that timercall
 112 will not be called again.
 113
 114 */
 115
 116 class TimerEvent : public Thread_TYPE
 117 {
 118   public:
 119     TimerEvent();
 120
 121     virtual void run();
 122     virtual void threadMethod();
 123     virtual void threadPostStopCleanup() {};
 124
 125     TimerReceiver* client;
 126     int clientReference;
 127     struct timespec requestedTime;
 128
 129     bool running;
 130     bool restartAfterFinish;
 131 };
 132
 133
 134 typedef std::list<TimerEvent*> TimerList;
 135
 136 class Timers : public Thread_TYPE
 137 {
 138   public:
 139     Timers();
 140     virtual ~Timers();
 141     static Timers* getInstance();
 142
 143     int init();
 144     int shutdown();
 145
 146     bool setTimerT(TimerReceiver* client, int clientReference, long int requestedTime, long int requestedTimeNSEC=0);
 147     bool setTimerD(TimerReceiver* client, int clientReference, long int requestedSecs, long int requestedNSecs=0);
 148     bool cancelTimer(TimerReceiver* client, int clientReference);
 149
 150     // Thread stuff
 151     virtual void threadMethod();
 152     virtual void threadPostStopCleanup() {};
 153
 154     void timerEventFinished(TimerEvent* timerEvent); // internal use only, does not return
 155
 156   private:
 157     static Timers* instance;
 158     Log* logger;
 159     bool initted;
 160     TimerList timerList;
 161     bool resetThreadFlag;
 162 };
 163
 164 #endif