src/pulse/glib-mainloop.h

   1 #ifndef fooglibmainloophfoo
   2 #define fooglibmainloophfoo
   3
   4 /***
   5   This file is part of PulseAudio.
   6
   7   Copyright 2004-2006 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 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 <glib.h>
  27
  28 #include <pulse/mainloop-api.h>
  29 #include <pulse/cdecl.h>
  30
  31 /** \page glib-mainloop GLIB Main Loop Bindings
  32  *
  33  * \section overv_sec Overview
  34  *
  35  * The GLIB main loop bindings are extremely easy to use. All that is
  36  * required is to create a pa_glib_mainloop object using
  37  * pa_glib_mainloop_new(). When the main loop abstraction is needed, it is
  38  * provided by pa_glib_mainloop_get_api().
  39  *
  40  */
  41
  42 /** \file
  43  * GLIB main loop support */
  44
  45 PA_C_DECL_BEGIN
  46
  47 /** An opaque GLIB main loop object */
  48 typedef struct pa_glib_mainloop pa_glib_mainloop;
  49
  50 /** Create a new GLIB main loop object for the specified GLIB main
  51  * loop context. Takes an argument c for the
  52  * GMainContext to use. If c is NULL the default context is used. */
  53 pa_glib_mainloop *pa_glib_mainloop_new(GMainContext *c);
  54
  55 /** Free the GLIB main loop object */
  56 void pa_glib_mainloop_free(pa_glib_mainloop* g);
  57
  58 /** Return the abstract main loop API vtable for the GLIB main loop object */
  59 pa_mainloop_api* pa_glib_mainloop_get_api(pa_glib_mainloop *g);
  60
  61 PA_C_DECL_END
  62
  63 #endif