code.delx.au - pulseaudio/blob - polyp/mainloop-signal.h

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