Commit | Line | Data |
---|---|---|
e12489f9 | 1 | /* Asynchronous timers. |
ab422c4d | 2 | Copyright (C) 2000-2013 Free Software Foundation, Inc. |
e12489f9 GM |
3 | |
4 | This file is part of GNU Emacs. | |
5 | ||
b9b1cc14 | 6 | GNU Emacs is free software: you can redistribute it and/or modify |
e12489f9 | 7 | it under the terms of the GNU General Public License as published by |
b9b1cc14 GM |
8 | the Free Software Foundation, either version 3 of the License, or |
9 | (at your option) any later version. | |
e12489f9 GM |
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 | |
b9b1cc14 | 17 | along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */ |
e12489f9 | 18 | |
ffd8f46e DL |
19 | #ifndef EMACS_ATIMER_H |
20 | #define EMACS_ATIMER_H | |
21 | ||
b1bb8011 | 22 | #include <stdbool.h> |
43aac990 | 23 | #include <time.h> |
ffd8f46e | 24 | |
e12489f9 GM |
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 | ||
66aa4eb3 | 39 | /* Timer runs continuously. */ |
e12489f9 GM |
40 | ATIMER_CONTINUOUS |
41 | }; | |
42 | ||
43 | /* Type of timer callback functions. */ | |
44 | ||
383e0970 | 45 | typedef void (* atimer_callback) (struct atimer *timer); |
e12489f9 GM |
46 | |
47 | /* Structure describing an asynchronous timer. */ | |
48 | ||
49 | struct atimer | |
50 | { | |
51 | /* The type of this timer. */ | |
52 | enum atimer_type type; | |
177c0ea7 | 53 | |
e12489f9 | 54 | /* Time when this timer is ripe. */ |
43aac990 | 55 | struct timespec expiration; |
e12489f9 GM |
56 | |
57 | /* Interval of this timer. */ | |
43aac990 | 58 | struct timespec interval; |
e12489f9 | 59 | |
5f351ff1 PJ |
60 | /* Function to call when timer is ripe. Interrupt input is |
61 | guaranteed to not be blocked when this function is called. */ | |
e12489f9 GM |
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 | ||
43aac990 | 73 | struct atimer *start_atimer (enum atimer_type, struct timespec, |
383e0970 J |
74 | atimer_callback, void *); |
75 | void cancel_atimer (struct atimer *); | |
76 | void do_pending_atimers (void); | |
77 | void init_atimer (void); | |
b1bb8011 | 78 | void turn_on_atimers (bool); |
383e0970 | 79 | void stop_other_atimers (struct atimer *); |
27e498e6 | 80 | void run_all_atimers (void); |
e12489f9 | 81 | |
ffd8f46e | 82 | #endif /* EMACS_ATIMER_H */ |