• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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.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, see <http://www.gnu.org/licenses/>.
22 ***/
23 
24 #include <glib.h>
25 
26 #include <pulse/mainloop-api.h>
27 #include <pulse/cdecl.h>
28 #include <pulse/version.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  * See also \subpage glib-mainloop
45  */
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
61     object. No need to free the API as it is owned by the loop
62     and is destroyed when the loop is freed. */
63 pa_mainloop_api* pa_glib_mainloop_get_api(pa_glib_mainloop *g);
64 
65 PA_C_DECL_END
66 
67 #endif
68