PulseAudio  5.0
mainloop-api.h
Go to the documentation of this file.
1 #ifndef foomainloopapihfoo
2 #define foomainloopapihfoo
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
12  published by the Free Software Foundation; either version 2.1 of the
13  License, 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  Lesser General Public License for more details.
19 
20  You should have received a copy of the GNU Lesser General Public
21  License along with PulseAudio; if not, write to the Free Software
22  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
23  USA.
24 ***/
25 
26 #include <sys/time.h>
27 
28 #include <pulse/cdecl.h>
29 #include <pulse/version.h>
30 
46 PA_C_DECL_BEGIN
47 
50 
52 typedef enum pa_io_event_flags {
59 
61 typedef struct pa_io_event pa_io_event;
63 typedef void (*pa_io_event_cb_t)(pa_mainloop_api*ea, pa_io_event* e, int fd, pa_io_event_flags_t events, void *userdata);
65 typedef void (*pa_io_event_destroy_cb_t)(pa_mainloop_api*a, pa_io_event *e, void *userdata);
66 
70 typedef void (*pa_time_event_cb_t)(pa_mainloop_api*a, pa_time_event* e, const struct timeval *tv, void *userdata);
72 typedef void (*pa_time_event_destroy_cb_t)(pa_mainloop_api*a, pa_time_event *e, void *userdata);
73 
77 typedef void (*pa_defer_event_cb_t)(pa_mainloop_api*a, pa_defer_event* e, void *userdata);
79 typedef void (*pa_defer_event_destroy_cb_t)(pa_mainloop_api*a, pa_defer_event *e, void *userdata);
80 
84  void *userdata;
85 
87  pa_io_event* (*io_new)(pa_mainloop_api*a, int fd, pa_io_event_flags_t events, pa_io_event_cb_t cb, void *userdata);
91  void (*io_free)(pa_io_event* e);
94 
96  pa_time_event* (*time_new)(pa_mainloop_api*a, const struct timeval *tv, pa_time_event_cb_t cb, void *userdata);
98  void (*time_restart)(pa_time_event* e, const struct timeval *tv);
103 
107  void (*defer_enable)(pa_defer_event* e, int b);
112 
114  void (*quit)(pa_mainloop_api*a, int retval);
115 };
116 
120 void pa_mainloop_api_once(pa_mainloop_api*m, void (*callback)(pa_mainloop_api*m, void *userdata), void *userdata);
121 
122 PA_C_DECL_END
123 
124 #endif
An abstract mainloop API vtable.
Definition: mainloop-api.h:82
void(* pa_defer_event_cb_t)(pa_mainloop_api *a, pa_defer_event *e, void *userdata)
A defer event callback prototype.
Definition: mainloop-api.h:77
void(* defer_enable)(pa_defer_event *e, int b)
Enable or disable a deferred event source temporarily.
Definition: mainloop-api.h:107
void * userdata
A pointer to some private, arbitrary data of the main loop implementation.
Definition: mainloop-api.h:84
No event.
Definition: mainloop-api.h:53
void(* io_enable)(pa_io_event *e, pa_io_event_flags_t events)
Enable or disable IO events on this object.
Definition: mainloop-api.h:89
void pa_mainloop_api_once(pa_mainloop_api *m, void(*callback)(pa_mainloop_api *m, void *userdata), void *userdata)
Run the specified callback function once from the main loop using an anonymous defer event...
void(* io_set_destroy)(pa_io_event *e, pa_io_event_destroy_cb_t cb)
Set a function that is called when the IO event source is destroyed.
Definition: mainloop-api.h:93
struct pa_io_event pa_io_event
An opaque IO event source object.
Definition: mainloop-api.h:61
void(* time_free)(pa_time_event *e)
Free a deferred timer event source object.
Definition: mainloop-api.h:100
void(* pa_io_event_destroy_cb_t)(pa_mainloop_api *a, pa_io_event *e, void *userdata)
A IO event destroy callback prototype \ since 0.9.3.
Definition: mainloop-api.h:65
void(* time_restart)(pa_time_event *e, const struct timeval *tv)
Restart a running or expired timer event source with a new Unix time.
Definition: mainloop-api.h:98
Output event.
Definition: mainloop-api.h:55
void(* io_free)(pa_io_event *e)
Free a IO event source object.
Definition: mainloop-api.h:91
void(* defer_free)(pa_defer_event *e)
Free a deferred event source object.
Definition: mainloop-api.h:109
Input event.
Definition: mainloop-api.h:54
void(* pa_time_event_cb_t)(pa_mainloop_api *a, pa_time_event *e, const struct timeval *tv, void *userdata)
A time event callback prototype.
Definition: mainloop-api.h:70
void(* quit)(pa_mainloop_api *a, int retval)
Exit the main loop and return the specified retval.
Definition: mainloop-api.h:114
Define header version.
pa_io_event_flags
A bitmask for IO events.
Definition: mainloop-api.h:52
void(* defer_set_destroy)(pa_defer_event *e, pa_defer_event_destroy_cb_t cb)
Set a function that is called when the deferred event source is destroyed.
Definition: mainloop-api.h:111
struct pa_time_event pa_time_event
An opaque timer event source object.
Definition: mainloop-api.h:68
enum pa_io_event_flags pa_io_event_flags_t
A bitmask for IO events.
void(* pa_io_event_cb_t)(pa_mainloop_api *ea, pa_io_event *e, int fd, pa_io_event_flags_t events, void *userdata)
An IO event callback prototype.
Definition: mainloop-api.h:63
Error event.
Definition: mainloop-api.h:57
Hangup event.
Definition: mainloop-api.h:56
void(* time_set_destroy)(pa_time_event *e, pa_time_event_destroy_cb_t cb)
Set a function that is called when the timer event source is destroyed.
Definition: mainloop-api.h:102
void(* pa_time_event_destroy_cb_t)(pa_mainloop_api *a, pa_time_event *e, void *userdata)
A time event destroy callback prototype \ since 0.9.3.
Definition: mainloop-api.h:72
void(* pa_defer_event_destroy_cb_t)(pa_mainloop_api *a, pa_defer_event *e, void *userdata)
A defer event destroy callback prototype \ since 0.9.3.
Definition: mainloop-api.h:79
struct pa_defer_event pa_defer_event
An opaque deferred event source object.
Definition: mainloop-api.h:75