Fix documentation for libinput_log_set_handler
[platform/upstream/libinput.git] / src / timer.h
1 /*
2  * Copyright © 2014 Red Hat, Inc.
3  *
4  * Permission to use, copy, modify, distribute, and sell this software and
5  * its documentation for any purpose is hereby granted without fee, provided
6  * that the above copyright notice appear in all copies and that both that
7  * copyright notice and this permission notice appear in supporting
8  * documentation, and that the name of the copyright holders not be used in
9  * advertising or publicity pertaining to distribution of the software
10  * without specific, written prior permission.  The copyright holders make
11  * no representations about the suitability of this software for any
12  * purpose.  It is provided "as is" without express or implied warranty.
13  *
14  * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
15  * SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
16  * FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
17  * SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER
18  * RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
19  * CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
20  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
21  */
22
23 #ifndef TIMER_H
24 #define TIMER_H
25
26 #include <stdint.h>
27
28 #include "libinput-util.h"
29
30 struct libinput;
31
32 struct libinput_timer {
33         struct libinput *libinput;
34         struct list link;
35         uint64_t expire; /* in absolute ms CLOCK_MONOTONIC */
36         void (*timer_func)(uint64_t now, void *timer_func_data);
37         void *timer_func_data;
38 };
39
40 void
41 libinput_timer_init(struct libinput_timer *timer, struct libinput *libinput,
42                     void (*timer_func)(uint64_t now, void *timer_func_data),
43                     void *timer_func_data);
44
45 /* Set timer expire time, in absolute ms CLOCK_MONOTONIC */
46 void
47 libinput_timer_set(struct libinput_timer *timer, uint64_t expire);
48
49 void
50 libinput_timer_cancel(struct libinput_timer *timer);
51
52 int
53 libinput_timer_subsys_init(struct libinput *libinput);
54
55 void
56 libinput_timer_subsys_destroy(struct libinput *libinput);
57
58 #endif