HCoop / bpt / emacs.git / blame
| Commit | Line | Data |
|---|---|---|
| e12489f9 | 1 | /* Asynchronous timers. |
| acaf905b | 2 | Copyright (C) 2000-2012 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 | ||
| 22 | #include "systime.h" /* for EMACS_TIME */ | |
| 23 | ||
| e12489f9 GM |
24 | /* Forward declaration. */ |
| 25 | ||
| 26 | struct atimer; | |
| 27 | ||
| 28 | /* Types of timers. */ | |
| 29 | ||
| 30 | enum atimer_type | |
| 31 | { | |
| 32 | /* Timer is ripe at some absolute time. */ | |
| 33 | ATIMER_ABSOLUTE, | |
| 34 | ||
| 35 | /* Timer is ripe at now plus an offset. */ | |
| 36 | ATIMER_RELATIVE, | |
| 37 | ||
| 66aa4eb3 | 38 | /* Timer runs continuously. */ |
| e12489f9 GM |
39 | ATIMER_CONTINUOUS |
| 40 | }; | |
| 41 | ||
| 42 | /* Type of timer callback functions. */ | |
| 43 | ||
| 383e0970 | 44 | typedef void (* atimer_callback) (struct atimer *timer); |
| e12489f9 GM |
45 | |
| 46 | /* Structure describing an asynchronous timer. */ | |
| 47 | ||
| 48 | struct atimer | |
| 49 | { | |
| 50 | /* The type of this timer. */ | |
| 51 | enum atimer_type type; | |
| 177c0ea7 | 52 | |
| e12489f9 GM |
53 | /* Time when this timer is ripe. */ |
| 54 | EMACS_TIME expiration; | |
| 55 | ||
| 56 | /* Interval of this timer. */ | |
| 57 | EMACS_TIME interval; | |
| 58 | ||
| 5f351ff1 PJ |
59 | /* Function to call when timer is ripe. Interrupt input is |
| 60 | guaranteed to not be blocked when this function is called. */ | |
| e12489f9 GM |
61 | atimer_callback fn; |
| 62 | ||
| 63 | /* Additional user-specified data to pass to FN. */ | |
| 64 | void *client_data; | |
| 65 | ||
| 66 | /* Next in list of active or free atimers. */ | |
| 67 | struct atimer *next; | |
| 68 | }; | |
| 69 | ||
| 70 | /* Function prototypes. */ | |
| 71 | ||
| 383e0970 J |
72 | struct atimer *start_atimer (enum atimer_type, EMACS_TIME, |
| 73 | atimer_callback, void *); | |
| 74 | void cancel_atimer (struct atimer *); | |
| 75 | void do_pending_atimers (void); | |
| 76 | void init_atimer (void); | |
| 77 | void turn_on_atimers (int); | |
| 78 | void stop_other_atimers (struct atimer *); | |
| 383e0970 | 79 | Lisp_Object unwind_stop_other_atimers (Lisp_Object); |
| e12489f9 | 80 | |
| ffd8f46e | 81 | #endif /* EMACS_ATIMER_H */ |