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 "opsysdll.h"

#include <basis/object_base.h>

// forward.
class driven_objects_list;
class signalling_thread;
class timed_object;


class OPSYSTEM_CLASS_STYLE timer_driver : public virtual object_base
{
public:
  timer_driver();
  virtual ~timer_driver();

  IMPLEMENT_CLASS_NAME("timer_driver");


  // main methods for controlling timed_objects.

  bool set_timer(int duration, timed_object *to_invoke);

  bool zap_timer(timed_object *to_drop);



  // internal methods.

#ifdef __WIN32__
  u_int *real_timer_id();
#endif

  void handle_system_timer();

  static timer_driver &global_timer_driver();

private:
  driven_objects_list *_timers;  
  mutex *_lock;  
#ifdef __UNIX__
  signalling_thread *_prompter;  
#endif
#ifdef __WIN32__
  u_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()




class OPSYSTEM_CLASS_STYLE timed_object
{
public:
  virtual ~timed_object();
  virtual void handle_timer_callback() = 0;
};


#endif

---