Home | History | Annotate | Download | only in pulse
      1 #ifndef fooglibmainloophfoo
      2 #define fooglibmainloophfoo
      3 
      4 /* $Id: glib-mainloop.h 1426 2007-02-13 15:35:19Z ossman $ */
      5 
      6 /***
      7   This file is part of PulseAudio.
      8 
      9   Copyright 2004-2006 Lennart Poettering
     10   Copyright 2006 Pierre Ossman <ossman (at) cendio.se> for Cendio AB
     11 
     12   PulseAudio is free software; you can redistribute it and/or modify
     13   it under the terms of the GNU Lesser General Public License as published
     14   by the Free Software Foundation; either version 2 of the License,
     15   or (at your option) any later version.
     16 
     17   PulseAudio is distributed in the hope that it will be useful, but
     18   WITHOUT ANY WARRANTY; without even the implied warranty of
     19   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
     20   General Public License for more details.
     21 
     22   You should have received a copy of the GNU Lesser General Public License
     23   along with PulseAudio; if not, write to the Free Software
     24   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
     25   USA.
     26 ***/
     27 
     28 #include <glib.h>
     29 
     30 #include <pulse/mainloop-api.h>
     31 #include <pulse/cdecl.h>
     32 
     33 /** \page glib-mainloop GLIB Main Loop Bindings
     34  *
     35  * \section overv_sec Overview
     36  *
     37  * The GLIB main loop bindings are extremely easy to use. All that is
     38  * required is to create a pa_glib_mainloop object using
     39  * pa_glib_mainloop_new(). When the main loop abstraction is needed, it is
     40  * provided by pa_glib_mainloop_get_api().
     41  *
     42  */
     43 
     44 /** \file
     45  * GLIB main loop support */
     46 
     47 PA_C_DECL_BEGIN
     48 
     49 /** An opaque GLIB main loop object */
     50 typedef struct pa_glib_mainloop pa_glib_mainloop;
     51 
     52 /** Create a new GLIB main loop object for the specified GLIB main
     53  * loop context. Takes an argument c for the
     54  * GMainContext to use. If c is NULL the default context is used. */
     55 pa_glib_mainloop *pa_glib_mainloop_new(GMainContext *c);
     56 
     57 /** Free the GLIB main loop object */
     58 void pa_glib_mainloop_free(pa_glib_mainloop* g);
     59 
     60 /** Return the abstract main loop API vtable for the GLIB main loop object */
     61 pa_mainloop_api* pa_glib_mainloop_get_api(pa_glib_mainloop *g);
     62 
     63 PA_C_DECL_END
     64 
     65 #endif
     66