code.delx.au - pulseaudio/blob - src/pulse/mainloop-signal.h

   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, write to the Free Software
  22   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  23   USA.
  24 ***/
  25
  26 #include <pulse/mainloop-api.h>
  27 #include <pulse/cdecl.h>
  28
  29 PA_C_DECL_BEGIN
  30
  31 /** \file
  32  * UNIX signal support for main loops. In contrast to other
  33  * main loop event sources such as timer and IO events, UNIX signal
  34  * support requires modification of the global process
  35  * environment. Due to this the generic main loop abstraction layer as
  36  * defined in \ref mainloop-api.h doesn't have direct support for UNIX
  37  * signals. However, you may hook signal support into an abstract main loop via the routines defined herein.
  38  */
  39
  40 /** An opaque UNIX signal event source object */
  41 typedef struct pa_signal_event pa_signal_event;
  42
  43 /** Callback prototype for signal events */
  44 typedef void (*pa_signal_cb_t) (pa_mainloop_api *api, pa_signal_event*e, int sig, void *userdata);
  45
  46 /** Destroy callback prototype for signal events */
  47 typedef void (*pa_signal_destroy_cb_t) (pa_mainloop_api *api, pa_signal_event*e, void *userdata);
  48
  49 /** Initialize the UNIX signal subsystem and bind it to the specified main loop */
  50 int pa_signal_init(pa_mainloop_api *api);
  51
  52 /** Cleanup the signal subsystem */
  53 void pa_signal_done(void);
  54
  55 /** Create a new UNIX signal event source object */
  56 pa_signal_event* pa_signal_new(int sig, pa_signal_cb_t callback, void *userdata);
  57
  58 /** Free a UNIX signal event source object */
  59 void pa_signal_free(pa_signal_event *e);
  60
  61 /** Set a function that is called when the signal event source is destroyed. Use this to free the userdata argument if required */
  62 void pa_signal_set_destroy(pa_signal_event *e, pa_signal_destroy_cb_t callback);
  63
  64 PA_C_DECL_END
  65
  66 #endif