]>
code.delx.au - gnu-emacs/blob - src/atimer.h
2386977cf8717448904ce5dc8fffacdeac18f8ab
1 /* Asynchronous timers.
2 Copyright (C) 2000-2014 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
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.
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.
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/>. */
19 #ifndef EMACS_ATIMER_H
20 #define EMACS_ATIMER_H
24 /* Forward declaration. */
28 /* Types of timers. */
32 /* Timer is ripe at some absolute time. */
35 /* Timer is ripe at now plus an offset. */
38 /* Timer runs continuously. */
42 /* Type of timer callback functions. */
44 typedef void (* atimer_callback
) (struct atimer
*timer
);
46 /* Structure describing an asynchronous timer. */
50 /* The type of this timer. */
51 enum atimer_type type
;
53 /* Time when this timer is ripe. */
54 struct timespec expiration
;
56 /* Interval of this timer. */
57 struct timespec interval
;
59 /* Function to call when timer is ripe. Interrupt input is
60 guaranteed to not be blocked when this function is called. */
63 /* Additional user-specified data to pass to FN. */
66 /* Next in list of active or free atimers. */
70 /* Function prototypes. */
72 struct atimer
*start_atimer (enum atimer_type
, struct timespec
,
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 (bool);
78 void stop_other_atimers (struct atimer
*);
79 void run_all_atimers (void);
81 void timerfd_callback (int, void *);
84 #endif /* EMACS_ATIMER_H */