|
27433
|
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 /* Forward declaration. */
|
|
|
22
|
|
|
23 struct atimer;
|
|
|
24
|
|
|
25 /* Types of timers. */
|
|
|
26
|
|
|
27 enum atimer_type
|
|
|
28 {
|
|
|
29 /* Timer is ripe at some absolute time. */
|
|
|
30 ATIMER_ABSOLUTE,
|
|
|
31
|
|
|
32 /* Timer is ripe at now plus an offset. */
|
|
|
33 ATIMER_RELATIVE,
|
|
|
34
|
|
|
35 /* Timer runs continously. */
|
|
|
36 ATIMER_CONTINUOUS
|
|
|
37 };
|
|
|
38
|
|
|
39 /* Type of timer callback functions. */
|
|
|
40
|
|
|
41 typedef void (* atimer_callback) P_ ((struct atimer *timer));
|
|
|
42
|
|
|
43 /* Structure describing an asynchronous timer. */
|
|
|
44
|
|
|
45 struct atimer
|
|
|
46 {
|
|
|
47 /* The type of this timer. */
|
|
|
48 enum atimer_type type;
|
|
|
49
|
|
|
50 /* Time when this timer is ripe. */
|
|
|
51 EMACS_TIME expiration;
|
|
|
52
|
|
|
53 /* Interval of this timer. */
|
|
|
54 EMACS_TIME interval;
|
|
|
55
|
|
|
56 /* Function to call when timer is ripe. Interupt input is
|
|
|
57 garanteed to not be blocked when this function is called. */
|
|
|
58 atimer_callback fn;
|
|
|
59
|
|
|
60 /* Additional user-specified data to pass to FN. */
|
|
|
61 void *client_data;
|
|
|
62
|
|
|
63 /* Next in list of active or free atimers. */
|
|
|
64 struct atimer *next;
|
|
|
65 };
|
|
|
66
|
|
|
67 /* Function prototypes. */
|
|
|
68
|
|
|
69 struct atimer *start_atimer P_ ((enum atimer_type, EMACS_TIME,
|
|
|
70 atimer_callback, void *));
|
|
|
71 void cancel_atimer P_ ((struct atimer *));
|
|
|
72 void do_pending_atimers P_ ((void));
|
|
|
73 void init_atimer P_ ((void));
|
|
|
74 void turn_on_atimers P_ ((int));
|
|
|
75
|
