src/pulse/glib-mainloop.h

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