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

   1 #ifndef foomainloophfoo
   2 #define foomainloophfoo
   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  *
  32  * A minimal main loop implementation based on the C library's poll()
  33  * function. Using the routines defined herein you may create a simple
  34  * main loop supporting the generic main loop abstraction layer as
  35  * defined in \ref mainloop-api.h. This implementation is thread safe
  36  * as long as you access the main loop object from a single thread only.*/
  37
  38 /** \struct pa_mainloop
  39  * An opaque main loop object
  40  */
  41 struct pa_mainloop;
  42
  43 /** Allocate a new main loop object */
  44 struct pa_mainloop *pa_mainloop_new(void);
  45
  46 /** Free a main loop object */
  47 void pa_mainloop_free(struct pa_mainloop* m);
  48
  49 /** Run a single iteration of the main loop. Returns a negative value
  50 on error or exit request. If block is nonzero, block for events if
  51 none are queued. Optionally return the return value as specified with
  52 the main loop's quit() routine in the integer variable retval points
  53 to. On success returns the number of source dispatched in this iteration. */
  54 int pa_mainloop_iterate(struct pa_mainloop *m, int block, int *retval);
  55
  56 /** Run unlimited iterations of the main loop object until the main loop's quit() routine is called. */
  57 int pa_mainloop_run(struct pa_mainloop *m, int *retval);
  58
  59 /** Return the abstract main loop abstraction layer vtable for this main loop. This calls pa_mainloop_iterate() iteratively.*/
  60 struct pa_mainloop_api* pa_mainloop_get_api(struct pa_mainloop*m);
  61
  62 /** Return non-zero when there are any deferred events pending. \since 0.5 */
  63 int pa_mainloop_deferred_pending(struct pa_mainloop *m);
  64
  65 PA_C_DECL_END
  66
  67 #endif