blob: 896400ad5246828e415b4a6a94c1316de6e82c28 [file] [log] [blame]
David 'Digit' Turnerb1c2c952009-05-18 17:07:46 +02001/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef __FDEVENT_H
18#define __FDEVENT_H
19
Yabin Cui2ce9d562015-09-15 16:27:09 -070020#include <stddef.h>
David 'Digit' Turner1f1efb52009-05-18 17:36:28 +020021#include <stdint.h> /* for int64_t */
22
Josh Gao764f8c52017-05-03 14:10:39 -070023#include <functional>
24
David 'Digit' Turnerb1c2c952009-05-18 17:07:46 +020025/* events that may be observed */
26#define FDE_READ 0x0001
27#define FDE_WRITE 0x0002
28#define FDE_ERROR 0x0004
29
30/* features that may be set (via the events set/add/del interface) */
31#define FDE_DONT_CLOSE 0x0080
32
David 'Digit' Turnerb1c2c952009-05-18 17:07:46 +020033typedef void (*fd_func)(int fd, unsigned events, void *userdata);
34
Yabin Cui2ce9d562015-09-15 16:27:09 -070035struct fdevent {
36 fdevent *next;
37 fdevent *prev;
38
39 int fd;
40 int force_eof;
41
42 uint16_t state;
43 uint16_t events;
44
45 fd_func func;
46 void *arg;
47};
48
David 'Digit' Turnerb1c2c952009-05-18 17:07:46 +020049/* Allocate and initialize a new fdevent object
David 'Digit' Turner1f1efb52009-05-18 17:36:28 +020050 * Note: use FD_TIMER as 'fd' to create a fd-less object
51 * (used to implement timers).
David 'Digit' Turnerb1c2c952009-05-18 17:07:46 +020052*/
53fdevent *fdevent_create(int fd, fd_func func, void *arg);
54
55/* Uninitialize and deallocate an fdevent object that was
56** created by fdevent_create()
57*/
58void fdevent_destroy(fdevent *fde);
59
60/* Initialize an fdevent object that was externally allocated
61*/
62void fdevent_install(fdevent *fde, int fd, fd_func func, void *arg);
63
64/* Uninitialize an fdevent object that was initialized by
65** fdevent_install()
66*/
67void fdevent_remove(fdevent *item);
68
69/* Change which events should cause notifications
70*/
71void fdevent_set(fdevent *fde, unsigned events);
72void fdevent_add(fdevent *fde, unsigned events);
73void fdevent_del(fdevent *fde, unsigned events);
74
David 'Digit' Turner1f1efb52009-05-18 17:36:28 +020075void fdevent_set_timeout(fdevent *fde, int64_t timeout_ms);
76
David 'Digit' Turnerb1c2c952009-05-18 17:07:46 +020077/* loop forever, handling events.
78*/
79void fdevent_loop();
80
Yabin Cui3cf1b362017-03-10 16:01:01 -080081void check_main_thread();
82
Josh Gao764f8c52017-05-03 14:10:39 -070083// Queue an operation to run on the main thread.
84void fdevent_run_on_main_thread(std::function<void()> fn);
85
Josh Gao511763b2016-02-10 14:49:00 -080086// The following functions are used only for tests.
87void fdevent_terminate_loop();
Yabin Cui2ce9d562015-09-15 16:27:09 -070088size_t fdevent_installed_count();
Yabin Cui2ce9d562015-09-15 16:27:09 -070089void fdevent_reset();
Yabin Cui3cf1b362017-03-10 16:01:01 -080090void set_main_thread();
David 'Digit' Turnerb1c2c952009-05-18 17:07:46 +020091
David 'Digit' Turnerb1c2c952009-05-18 17:07:46 +020092#endif