1/* Async events for the GDB event loop.
2   Copyright (C) 1999-2020 Free Software Foundation, Inc.
3
4   This file is part of GDB.
5
6   This program 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.
10
11   This program 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
17   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
18
19#ifndef ASYNC_EVENT_H
20#define ASYNC_EVENT_H
21
22#include "gdbsupport/event-loop.h"
23
24struct async_signal_handler;
25struct async_event_handler;
26typedef void (sig_handler_func) (gdb_client_data);
27typedef void (async_event_handler_func) (gdb_client_data);
28
29extern struct async_signal_handler *
30  create_async_signal_handler (sig_handler_func *proc,
31			       gdb_client_data client_data);
32extern void delete_async_signal_handler (struct async_signal_handler **);
33
34/* Call the handler from HANDLER the next time through the event
35   loop.  */
36extern void mark_async_signal_handler (struct async_signal_handler *handler);
37
38/* Returns true if HANDLER is marked ready.  */
39
40extern int
41  async_signal_handler_is_marked (struct async_signal_handler *handler);
42
43/* Mark HANDLER as NOT ready.  */
44
45extern void clear_async_signal_handler (struct async_signal_handler *handler);
46
47/* Create and register an asynchronous event source in the event loop,
48   and set PROC as its callback.  CLIENT_DATA is passed as argument to
49   PROC upon its invocation.  Returns a pointer to an opaque structure
50   used to mark as ready and to later delete this event source from
51   the event loop.  */
52extern struct async_event_handler *
53  create_async_event_handler (async_event_handler_func *proc,
54			      gdb_client_data client_data);
55
56/* Remove the event source pointed by HANDLER_PTR created by
57   CREATE_ASYNC_EVENT_HANDLER from the event loop, and release it.  */
58extern void
59  delete_async_event_handler (struct async_event_handler **handler_ptr);
60
61/* Call the handler from HANDLER the next time through the event
62   loop.  */
63extern void mark_async_event_handler (struct async_event_handler *handler);
64
65/* Mark the handler (ASYNC_HANDLER_PTR) as NOT ready.  */
66
67extern void clear_async_event_handler (struct async_event_handler *handler);
68
69extern void initialize_async_signal_handlers (void);
70
71#endif /* ASYNC_EVENT_H */
72