Time/event.hxx

   1 // event.hxx -- Flight Gear periodic event scheduler
   2 //
   3 // Written by Curtis Olson, started December 1997.
   4 //
   5 // Copyright (C) 1997  Curtis L. Olson  - curt@infoplane.com
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 //
  21 // $Id$
  22 // (Log is kept at end of this file)
  23
  24
  25 #ifndef _EVENT_HXX
  26 #define _EVENT_HXX
  27
  28
  29 #ifndef __cplusplus
  30 # error This library requires C++
  31 #endif
  32
  33
  34 #ifdef __sun__
  35 extern "C" void *memmove(void *, const void *, size_t);
  36 extern "C" void *memset(void *, int, size_t);
  37 #endif
  38
  39
  40 #include <deque>        // STL double ended queue
  41 #include <list>         // STL list
  42
  43 #include "fg_time.hxx"
  44
  45
  46 #define FG_EVENT_SUSP 0
  47 #define FG_EVENT_READY 1
  48 #define FG_EVENT_QUEUED 2
  49
  50
  51 typedef struct {
  52     char description[256];
  53
  54     void (*event)( void );  // pointer to function
  55     int status;       // status flag
  56
  57     long interval;    // interval in ms between each iteration of this event
  58
  59     fg_timestamp last_run;
  60     fg_timestamp current;
  61     fg_timestamp next_run;
  62
  63     long cum_time;    // cumulative processor time of this event
  64     long min_time;    // time of quickest execution
  65     long max_time;    // time of slowest execution
  66     long count;       // number of times executed
  67 } fgEVENT;
  68
  69
  70 class fgEVENT_MGR {
  71
  72     // Event table
  73     deque < fgEVENT > event_table;
  74
  75     // Run Queue
  76     list < fgEVENT * > run_queue;
  77
  78 public:
  79
  80     // Constructor
  81     fgEVENT_MGR ( void );
  82
  83     // Initialize the scheduling subsystem
  84     void Init( void );
  85
  86     // Register an event with the scheduler
  87     void Register(char *desc, void (*event)( void ), int status,
  88                          int interval);
  89
  90     // Update the scheduling parameters for an event
  91     void Update( void );
  92
  93     // Delete a scheduled event
  94     void Delete( void );
  95
  96     // Temporarily suspend scheduling of an event
  97     void Suspend( void );
  98
  99     // Resume scheduling and event
 100     void Resume( void );
 101
 102     // Dump scheduling stats
 103     void PrintStats( void );
 104
 105     // Add pending jobs to the run queue and run the job at the front
 106     // of the queue
 107     void Process( void );
 108
 109     // Destructor
 110     ~fgEVENT_MGR ( void );
 111 };
 112
 113
 114 // Wrapper to dump scheduling stats
 115 void fgEventPrintStats( void );
 116
 117 extern fgEVENT_MGR global_events;
 118
 119
 120 #endif // _EVENT_HXX
 121
 122
 123 // $Log$
 124 // Revision 1.4  1998/06/12 00:59:52  curt
 125 // Build only static libraries.
 126 // Declare memmove/memset for Sloaris.
 127 // Rewrote fg_time.c routine to get LST start seconds to better handle
 128 //   Solaris, and be easier to port, and understand the GMT vs. local
 129 //   timezone issues.
 130 //
 131 // Revision 1.3  1998/06/03 00:48:12  curt
 132 // No .h for STL includes.
 133 //
 134 // Revision 1.2  1998/05/22 21:14:54  curt
 135 // Rewrote event.cxx in C++ as a class using STL for the internal event list
 136 // and run queue this removes the arbitrary list sizes and makes things much
 137 // more dynamic.  Because this is C++-classified we can now have multiple
 138 // event_tables if we'd ever want them.
 139 //
 140 // Revision 1.1  1998/04/24 00:52:26  curt
 141 // Wrapped "#include <config.h>" in "#ifdef HAVE_CONFIG_H"
 142 // Fog color fixes.
 143 // Separated out lighting calcs into their own file.
 144 //
 145 // Revision 1.4  1998/04/21 17:01:43  curt
 146 // Fixed a problems where a pointer to a function was being passed around.  In
 147 // one place this functions arguments were defined as ( void ) while in another
 148 // place they were defined as ( int ).  The correct answer was ( int ).
 149 //
 150 // Prepairing for C++ integration.
 151 //
 152 // Revision 1.3  1998/01/22 02:59:43  curt
 153 // Changed #ifdef FILE_H to #ifdef _FILE_H
 154 //
 155 // Revision 1.2  1998/01/19 18:40:39  curt
 156 // Tons of little changes to clean up the code and to remove fatal errors
 157 // when building with the c++ compiler.
 158 //
 159 // Revision 1.1  1997/12/30 04:19:22  curt
 160 // Initial revision.
 161