summaryrefslogtreecommitdiffstats
path: root/src/polyp/mainloop.h
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2006-06-19 21:53:48 +0000
committerLennart Poettering <lennart@poettering.net>2006-06-19 21:53:48 +0000
commitf44ba092651aa75055e109e04b4164ea92ae7fdc (patch)
tree5dfe076191b32946e78edf64d584d0a65f320013 /src/polyp/mainloop.h
parentdd21f11deda64e65a6f75817496534c2c9dda1a8 (diff)
big s/polyp/pulse/g
git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@1033 fefdeb5f-60dc-0310-8127-8f9354f1896f
Diffstat (limited to 'src/polyp/mainloop.h')
-rw-r--r--src/polyp/mainloop.h127
1 files changed, 0 insertions, 127 deletions
diff --git a/src/polyp/mainloop.h b/src/polyp/mainloop.h
deleted file mode 100644
index 4681912b..00000000
--- a/src/polyp/mainloop.h
+++ /dev/null
@@ -1,127 +0,0 @@
-#ifndef foomainloophfoo
-#define foomainloophfoo
-
-/* $Id$ */
-
-/***
- This file is part of polypaudio.
-
- polypaudio is free software; you can redistribute it and/or modify
- it under the terms of the GNU Lesser General Public License as published
- by the Free Software Foundation; either version 2 of the License,
- or (at your option) any later version.
-
- polypaudio is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU Lesser General Public License
- along with polypaudio; if not, write to the Free Software
- Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- USA.
-***/
-
-#include <polyp/mainloop-api.h>
-#include <polyp/cdecl.h>
-
-PA_C_DECL_BEGIN
-
-struct pollfd;
-
-/** \page mainloop Main Loop
- *
- * \section overv_sec Overview
- *
- * The built-in main loop implementation is based on the poll() system call.
- * It supports the functions defined in the main loop abstraction and very
- * little else.
- *
- * The main loop is created using pa_mainloop_new() and destroyed using
- * pa_mainloop_free(). To get access to the main loop abstraction,
- * pa_mainloop_get_api() is used.
- *
- * \section iter_sec Iteration
- *
- * The main loop is designed around the concept of iterations. Each iteration
- * consists of three steps that repeat during the application's entire
- * lifetime:
- *
- * -# Prepare - Build a list of file descriptors
- * that need to be monitored and calculate the next timeout.
- * -# Poll - Execute the actuall poll() system call.
- * -# Dispatch - Dispatch any events that have fired.
- *
- * When using the main loop, the application can either execute each
- * iteration, one at a time, using pa_mainloop_iterate(), or let the library
- * iterate automatically using pa_mainloop_run().
- *
- * \section thread_sec Threads
- *
- * The main loop functions are designed to be thread safe, but the objects
- * are not. What this means is that multiple main loops can be used, but only
- * one object per thread.
- *
- */
-
-/** \file
- *
- * A minimal main loop implementation based on the C library's poll()
- * function. Using the routines defined herein you may create a simple
- * main loop supporting the generic main loop abstraction layer as
- * defined in \ref mainloop-api.h. This implementation is thread safe
- * as long as you access the main loop object from a single thread only.*/
-
-/** An opaque main loop object */
-typedef struct pa_mainloop pa_mainloop;
-
-/** Allocate a new main loop object */
-pa_mainloop *pa_mainloop_new(void);
-
-/** Free a main loop object */
-void pa_mainloop_free(pa_mainloop* m);
-
-/** Prepare for a single iteration of the main loop. Returns a negative value
-on error or exit request. timeout specifies a maximum timeout for the subsequent
-poll, or -1 for blocking behaviour. .*/
-int pa_mainloop_prepare(pa_mainloop *m, int timeout);
-
-/** Execute the previously prepared poll. Returns a negative value on error.*/
-int pa_mainloop_poll(pa_mainloop *m);
-
-/** Dispatch timeout, io and deferred events from the previously executed poll. Returns
-a negative value on error. On success returns the number of source dispatched. */
-int pa_mainloop_dispatch(pa_mainloop *m);
-
-/** Return the return value as specified with the main loop's quit() routine. */
-int pa_mainloop_get_retval(pa_mainloop *m);
-
-/** Run a single iteration of the main loop. This is a convenience function
-for pa_mainloop_prepare(), pa_mainloop_poll() and pa_mainloop_dispatch().
-Returns a negative value on error or exit request. If block is nonzero,
-block for events if none are queued. Optionally return the return value as
-specified with the main loop's quit() routine in the integer variable retval points
-to. On success returns the number of sources dispatched in this iteration. */
-int pa_mainloop_iterate(pa_mainloop *m, int block, int *retval);
-
-/** Run unlimited iterations of the main loop object until the main loop's quit() routine is called. */
-int pa_mainloop_run(pa_mainloop *m, int *retval);
-
-/** Return the abstract main loop abstraction layer vtable for this main loop. */
-pa_mainloop_api* pa_mainloop_get_api(pa_mainloop*m);
-
-/** Shutdown the main loop */
-void pa_mainloop_quit(pa_mainloop *m, int r);
-
-/** Interrupt a running poll (for threaded systems) */
-void pa_mainloop_wakeup(pa_mainloop *m);
-
-/** Generic prototype of a poll() like function */
-typedef int (*pa_poll_func)(struct pollfd *ufds, unsigned long nfds, int timeout, void*userdata);
-
-/** Change the poll() implementation */
-void pa_mainloop_set_poll_func(pa_mainloop *m, pa_poll_func poll_func, void *userdata);
-
-PA_C_DECL_END
-
-#endif