HCoop / bpt / emacs.git / blame
| Commit | Line | Data |
|---|---|---|
| e12489f9 | 1 | /* Asynchronous timers. |
| 429ab54e | 2 | Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, |
| 114f9c96 | 3 | 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc. |
| e12489f9 GM |
4 | |
| 5 | This file is part of GNU Emacs. | |
| 6 | ||
| b9b1cc14 | 7 | GNU Emacs is free software: you can redistribute it and/or modify |
| e12489f9 | 8 | it under the terms of the GNU General Public License as published by |
| b9b1cc14 GM |
9 | the Free Software Foundation, either version 3 of the License, or |
| 10 | (at your option) any later version. | |
| e12489f9 GM |
11 | |
| 12 | GNU Emacs is distributed in the hope that it will be useful, | |
| 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 15 | GNU General Public License for more details. | |
| 16 | ||
| 17 | You should have received a copy of the GNU General Public License | |
| b9b1cc14 | 18 | along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */ |
| e12489f9 | 19 | |
| ffd8f46e DL |
20 | #ifndef EMACS_ATIMER_H |
| 21 | #define EMACS_ATIMER_H | |
| 22 | ||
| 23 | #include "systime.h" /* for EMACS_TIME */ | |
| 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 GM |
54 | /* Time when this timer is ripe. */ |
| 55 | EMACS_TIME expiration; | |
| 56 | ||
| 57 | /* Interval of this timer. */ | |
| 58 | EMACS_TIME interval; | |
| 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 | ||
| 383e0970 J |
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 (int); | |
| 79 | void stop_other_atimers (struct atimer *); | |
| 80 | void run_all_atimers (void); | |
| 81 | Lisp_Object unwind_stop_other_atimers (Lisp_Object); | |
| e12489f9 | 82 | |
| ffd8f46e | 83 | #endif /* EMACS_ATIMER_H */ |
| ab5796a9 MB |
84 | |
| 85 | /* arch-tag: 02c7c1c8-45bd-4222-b874-4ca44662f60b | |
| 86 | (do not change this comment) */ |