timer_driver.h

Go to the documentation of this file.

#ifndef TIMER_DRIVER_CLASS
#define TIMER_DRIVER_CLASS
 
/*****************************************************************************\
*                                                                             *
*  Name   : timer_driver                                                      *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*******************************************************************************
* Copyright (c) 2003-$now By Author.  This program is free software; you can  *
* redistribute it and/or modify it under the terms of the GNU General Public  *
* License as published by the Free Software Foundation; either version 2 of   *
* the License or (at your option) any later version.  This is online at:      *
*     http://www.fsf.org/copyleft/gpl.html                                    *
* Please send any updates to: fred@gruntose.com                               *
\*****************************************************************************/
 
#include <basis/astring.h>
#include <basis/definitions.h>
#include <basis/mutex.h>
 
namespace timely {
 
// forward.
class driven_objects_list;
class signalling_thread;
 
 
 
class timeable : public virtual basis::root_object
{
public:
  virtual void handle_timer_callback() = 0;
};
 
 
 
class timer_driver : public virtual basis::root_object
{
public:
  timer_driver();
  virtual ~timer_driver();
 
  DEFINE_CLASS_NAME("timer_driver");
 
  // main methods for controlling timeables.
 
  bool set_timer(int duration, timeable *to_invoke);
 
  bool zap_timer(timeable *to_drop);
 
  // internal methods.
 
/*
#if defined(_MSC_VER)
  basis::un_int *real_timer_id();
#endif
*/
 
  void handle_system_timer();
 
  static timer_driver &global_timer_driver();
 
private:
  driven_objects_list *_timers;  
  basis::mutex *_lock;  
#if defined(__UNIX__) || defined(__GNU_WINDOWS__)
  signalling_thread *_prompter;  
#else
  basis::un_int *_real_timer_id;  
#endif
  bool _in_timer;  
 
  // these do the low-level system magic required to get a function hooked
  // to a timer.
  void hookup_OS_timer(int duration);
  void reset_OS_timer(int next_hit);
 
  void unhook_OS_timer();
};
 
 
#define program_wide_timer() timer_driver::global_timer_driver()
 
} //namespace.
 
#endif