summaryrefslogtreecommitdiffstats
path: root/src/polyp/mainloop-api.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/polyp/mainloop-api.h')
-rw-r--r--src/polyp/mainloop-api.h118
1 files changed, 0 insertions, 118 deletions
diff --git a/src/polyp/mainloop-api.h b/src/polyp/mainloop-api.h
deleted file mode 100644
index 12d74aa1..00000000
--- a/src/polyp/mainloop-api.h
+++ /dev/null
@@ -1,118 +0,0 @@
-#ifndef foomainloopapihfoo
-#define foomainloopapihfoo
-
-/* $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.1 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
- Lesser 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 <sys/time.h>
-#include <time.h>
-
-#include <polyp/cdecl.h>
-
-/** \file
- *
- * Main loop abstraction layer. Both the polypaudio core and the
- * polypaudio client library use a main loop abstraction layer. Due to
- * this it is possible to embed polypaudio into other
- * applications easily. Two main loop implemenations are
- * currently available:
- * \li A minimal implementation based on the C library's poll() function (See \ref mainloop.h)
- * \li A wrapper around the GLIB main loop. Use this to embed polypaudio into your GLIB/GTK+/GNOME programs (See \ref glib-mainloop.h)
- *
- * The structure pa_mainloop_api is used as vtable for the main loop abstraction.
- *
- * This mainloop abstraction layer has no direct support for UNIX signals. Generic, mainloop implementation agnostic support is available throught \ref mainloop-signal.h.
- * */
-
-PA_C_DECL_BEGIN
-
-/** A bitmask for IO events */
-typedef enum pa_io_event_flags {
- PA_IO_EVENT_NULL = 0, /**< No event */
- PA_IO_EVENT_INPUT = 1, /**< Input event */
- PA_IO_EVENT_OUTPUT = 2, /**< Output event */
- PA_IO_EVENT_HANGUP = 4, /**< Hangup event */
- PA_IO_EVENT_ERROR = 8 /**< Error event */
-} pa_io_event_flags_t;
-
-/** An opaque IO event source object */
-typedef struct pa_io_event pa_io_event;
-
-/** An opaque deferred event source object. Events of this type are triggered once in every main loop iteration */
-typedef struct pa_defer_event pa_defer_event;
-
-/** An opaque timer event source object */
-typedef struct pa_time_event pa_time_event;
-
-/** An abstract mainloop API vtable */
-typedef struct pa_mainloop_api pa_mainloop_api;
-
-/** An abstract mainloop API vtable */
-struct pa_mainloop_api {
- /** A pointer to some private, arbitrary data of the main loop implementation */
- void *userdata;
-
- /** Create a new IO event source object */
- pa_io_event* (*io_new)(pa_mainloop_api*a, int fd, pa_io_event_flags_t events, void (*callback) (pa_mainloop_api*a, pa_io_event* e, int fd, pa_io_event_flags_t events, void *userdata), void *userdata);
-
- /** Enable or disable IO events on this object */
- void (*io_enable)(pa_io_event* e, pa_io_event_flags_t events);
-
- /** Free a IO event source object */
- void (*io_free)(pa_io_event* e);
-
- /** Set a function that is called when the IO event source is destroyed. Use this to free the userdata argument if required */
- void (*io_set_destroy)(pa_io_event *e, void (*callback) (pa_mainloop_api*a, pa_io_event *e, void *userdata));
-
- /** Create a new timer event source object for the specified Unix time */
- pa_time_event* (*time_new)(pa_mainloop_api*a, const struct timeval *tv, void (*callback) (pa_mainloop_api*a, pa_time_event* e, const struct timeval *tv, void *userdata), void *userdata);
-
- /** Restart a running or expired timer event source with a new Unix time */
- void (*time_restart)(pa_time_event* e, const struct timeval *tv);
-
- /** Free a deferred timer event source object */
- void (*time_free)(pa_time_event* e);
-
- /** Set a function that is called when the timer event source is destroyed. Use this to free the userdata argument if required */
- void (*time_set_destroy)(pa_time_event *e, void (*callback) (pa_mainloop_api*a, pa_time_event *e, void *userdata));
-
- /** Create a new deferred event source object */
- pa_defer_event* (*defer_new)(pa_mainloop_api*a, void (*callback) (pa_mainloop_api*a, pa_defer_event* e, void *userdata), void *userdata);
-
- /** Enable or disable a deferred event source temporarily */
- void (*defer_enable)(pa_defer_event* e, int b);
-
- /** Free a deferred event source object */
- void (*defer_free)(pa_defer_event* e);
-
- /** Set a function that is called when the deferred event source is destroyed. Use this to free the userdata argument if required */
- void (*defer_set_destroy)(pa_defer_event *e, void (*callback) (pa_mainloop_api*a, pa_defer_event *e, void *userdata));
-
- /** Exit the main loop and return the specfied retval*/
- void (*quit)(pa_mainloop_api*a, int retval);
-};
-
-/** Run the specified callback function once from the main loop using an anonymous defer event. */
-void pa_mainloop_api_once(pa_mainloop_api*m, void (*callback)(pa_mainloop_api*m, void *userdata), void *userdata);
-
-PA_C_DECL_END
-
-#endif