src/atimer.h

   1 /* Asynchronous timers.
   2    Copyright (C) 2000 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Emacs.
   5
   6 GNU Emacs is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Emacs is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Emacs; see the file COPYING.  If not, write to
  18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19 Boston, MA 02111-1307, USA.  */
  20
  21 #ifndef EMACS_ATIMER_H
  22 #define EMACS_ATIMER_H
  23
  24 /* Building alloca.o includes us, and we need lisp.h for the P_ macro
  25    in that case.  */
  26 #include "lisp.h"
  27 #include "systime.h"            /* for EMACS_TIME */
  28
  29 /* Forward declaration.  */
  30
  31 struct atimer;
  32
  33 /* Types of timers.  */
  34
  35 enum atimer_type
  36 {
  37   /* Timer is ripe at some absolute time.  */
  38   ATIMER_ABSOLUTE,
  39
  40   /* Timer is ripe at now plus an offset.  */
  41   ATIMER_RELATIVE,
  42
  43   /* Timer runs continously.  */
  44   ATIMER_CONTINUOUS
  45 };
  46
  47 /* Type of timer callback functions.  */
  48
  49 typedef void (* atimer_callback) P_ ((struct atimer *timer));
  50
  51 /* Structure describing an asynchronous timer.  */
  52
  53 struct atimer
  54 {
  55   /* The type of this timer.  */
  56   enum atimer_type type;
  57
  58   /* Time when this timer is ripe.  */
  59   EMACS_TIME expiration;
  60
  61   /* Interval of this timer.  */
  62   EMACS_TIME interval;
  63
  64   /* Function to call when timer is ripe.  Interrupt input is
  65      guaranteed to not be blocked when this function is called.  */
  66   atimer_callback fn;
  67
  68   /* Additional user-specified data to pass to FN.  */
  69   void *client_data;
  70
  71   /* Next in list of active or free atimers.  */
  72   struct atimer *next;
  73 };
  74
  75 /* Function prototypes.  */
  76
  77 struct atimer *start_atimer P_ ((enum atimer_type, EMACS_TIME,
  78                                  atimer_callback, void *));
  79 void cancel_atimer P_ ((struct atimer *));
  80 void do_pending_atimers P_ ((void));
  81 void init_atimer P_ ((void));
  82 void turn_on_atimers P_ ((int));
  83 void stop_other_atimers P_ ((struct atimer *));
  84 void run_all_atimers P_ ((void));
  85 Lisp_Object unwind_stop_other_atimers P_ ((Lisp_Object));
  86
  87 #endif /* EMACS_ATIMER_H */
  88
  89 /* arch-tag: 02c7c1c8-45bd-4222-b874-4ca44662f60b
  90    (do not change this comment) */