1#ifndef foomainloopsignalhfoo
2#define foomainloopsignalhfoo
3
4/***
5 This file is part of PulseAudio.
6
7 Copyright 2004-2008 Lennart Poettering
8 Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
9
10 PulseAudio is free software; you can redistribute it and/or modify
11 it under the terms of the GNU Lesser General Public License as published
12 by the Free Software Foundation; either version 2.1 of the License,
13 or (at your option) any later version.
14
15 PulseAudio is distributed in the hope that it will be useful, but
16 WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 General Public License for more details.
19
20 You should have received a copy of the GNU Lesser General Public License
21 along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
22***/
23
24#include <pulse/mainloop-api.h>
25#include <pulse/cdecl.h>
26
27PA_C_DECL_BEGIN
28
29/** \file
30 * UNIX signal support for main loops. In contrast to other
31 * main loop event sources such as timer and IO events, UNIX signal
32 * support requires modification of the global process
33 * environment. Due to this the generic main loop abstraction layer as
34 * defined in \ref mainloop-api.h doesn't have direct support for UNIX
35 * signals. However, you may hook signal support into an abstract main loop via the routines defined herein.
36 */
37
38/** An opaque UNIX signal event source object */
39typedef struct pa_signal_event pa_signal_event;
40
41/** Callback prototype for signal events */
42typedef void (*pa_signal_cb_t) (pa_mainloop_api *api, pa_signal_event*e, int sig, void *userdata);
43
44/** Destroy callback prototype for signal events */
45typedef void (*pa_signal_destroy_cb_t) (pa_mainloop_api *api, pa_signal_event*e, void *userdata);
46
47/** Initialize the UNIX signal subsystem and bind it to the specified main loop */
48int pa_signal_init(pa_mainloop_api *api);
49
50/** Cleanup the signal subsystem */
51void pa_signal_done(void);
52
53/** Create a new UNIX signal event source object */
54pa_signal_event* pa_signal_new(int sig, pa_signal_cb_t callback, void *userdata);
55
56/** Free a UNIX signal event source object */
57void pa_signal_free(pa_signal_event *e);
58
59/** Set a function that is called when the signal event source is destroyed. Use this to free the userdata argument if required */
60void pa_signal_set_destroy(pa_signal_event *e, pa_signal_destroy_cb_t callback);
61
62PA_C_DECL_END
63
64#endif
65