1 module pulse.mainloopsignal;
2 
3 version(linux):
4 
5 import pulse.mainloopapi;
6 
7 extern (C):
8 
9 /***
10   This file is part of PulseAudio.
11 
12   Copyright 2004-2008 Lennart Poettering
13   Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
14 
15   PulseAudio is free software; you can redistribute it and/or modify
16   it under the terms of the GNU Lesser General Public License as published
17   by the Free Software Foundation; either version 2.1 of the License,
18   or (at your option) any later version.
19 
20   PulseAudio is distributed in the hope that it will be useful, but
21   WITHOUT ANY WARRANTY; without even the implied warranty of
22   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
23   General Public License for more details.
24 
25   You should have received a copy of the GNU Lesser General Public License
26   along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
27 ***/
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 */
39 struct pa_signal_event;
40 
41 /** Callback prototype for signal events */
42 alias pa_signal_cb_t = void function (pa_mainloop_api* api, pa_signal_event* e, int sig, void* userdata);
43 
44 /** Destroy callback prototype for signal events */
45 alias pa_signal_destroy_cb_t = void function (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 */
48 int pa_signal_init (pa_mainloop_api* api);
49 
50 /** Cleanup the signal subsystem */
51 void pa_signal_done ();
52 
53 /** Create a new UNIX signal event source object */
54 pa_signal_event* pa_signal_new (int sig, pa_signal_cb_t callback, void* userdata);
55 
56 /** Free a UNIX signal event source object */
57 void 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 */
60 void pa_signal_set_destroy (pa_signal_event* e, pa_signal_destroy_cb_t callback);
61