src/atimer.h

   1 /* Asynchronous timers.
   2    Copyright (C) 2000-2013 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 3 of the License, or
   9 (at your option) 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.  If not, see <http://www.gnu.org/licenses/>.  */
  18
  19 #ifndef EMACS_ATIMER_H
  20 #define EMACS_ATIMER_H
  21
  22 #include "systime.h"            /* for EMACS_TIME */
  23 #include <stdbool.h>
  24
  25 /* Forward declaration.  */
  26
  27 struct atimer;
  28
  29 /* Types of timers.  */
  30
  31 enum atimer_type
  32 {
  33   /* Timer is ripe at some absolute time.  */
  34   ATIMER_ABSOLUTE,
  35
  36   /* Timer is ripe at now plus an offset.  */
  37   ATIMER_RELATIVE,
  38
  39   /* Timer runs continuously.  */
  40   ATIMER_CONTINUOUS
  41 };
  42
  43 /* Type of timer callback functions.  */
  44
  45 typedef void (* atimer_callback) (struct atimer *timer);
  46
  47 /* Structure describing an asynchronous timer.  */
  48
  49 struct atimer
  50 {
  51   /* The type of this timer.  */
  52   enum atimer_type type;
  53
  54   /* Time when this timer is ripe.  */
  55   EMACS_TIME expiration;
  56
  57   /* Interval of this timer.  */
  58   EMACS_TIME interval;
  59
  60   /* Function to call when timer is ripe.  Interrupt input is
  61      guaranteed to not be blocked when this function is called.  */
  62   atimer_callback fn;
  63
  64   /* Additional user-specified data to pass to FN.  */
  65   void *client_data;
  66
  67   /* Next in list of active or free atimers.  */
  68   struct atimer *next;
  69 };
  70
  71 /* Function prototypes.  */
  72
  73 struct atimer *start_atimer (enum atimer_type, EMACS_TIME,
  74                              atimer_callback, void *);
  75 void cancel_atimer (struct atimer *);
  76 void do_pending_atimers (void);
  77 void init_atimer (void);
  78 void turn_on_atimers (bool);
  79 void stop_other_atimers (struct atimer *);
  80 Lisp_Object unwind_stop_other_atimers (Lisp_Object);
  81
  82 #endif /* EMACS_ATIMER_H */