PulseAudio  9.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, see <http://www.gnu.org/licenses/>.
22 ***/
23 
24 #include <sys/time.h>
25 
26 #include <pulse/cdecl.h>
27 #include <pulse/version.h>
28 
44 PA_C_DECL_BEGIN
45 
48 
50 typedef enum pa_io_event_flags {
57 
59 typedef struct pa_io_event pa_io_event;
61 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);
63 typedef void (*pa_io_event_destroy_cb_t)(pa_mainloop_api*a, pa_io_event *e, void *userdata);
64 
68 typedef void (*pa_time_event_cb_t)(pa_mainloop_api*a, pa_time_event* e, const struct timeval *tv, void *userdata);
70 typedef void (*pa_time_event_destroy_cb_t)(pa_mainloop_api*a, pa_time_event *e, void *userdata);
71 
75 typedef void (*pa_defer_event_cb_t)(pa_mainloop_api*a, pa_defer_event* e, void *userdata);
77 typedef void (*pa_defer_event_destroy_cb_t)(pa_mainloop_api*a, pa_defer_event *e, void *userdata);
78 
82  void *userdata;
83 
85  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);
89  void (*io_free)(pa_io_event* e);
92 
94  pa_time_event* (*time_new)(pa_mainloop_api*a, const struct timeval *tv, pa_time_event_cb_t cb, void *userdata);
96  void (*time_restart)(pa_time_event* e, const struct timeval *tv);
98  void (*time_free)(pa_time_event* e);
101 
105  void (*defer_enable)(pa_defer_event* e, int b);
110 
112  void (*quit)(pa_mainloop_api*a, int retval);
113 };
114 
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
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:96
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:91
An abstract mainloop API vtable.
Definition: mainloop-api.h:80
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:75
void * userdata
A pointer to some private, arbitrary data of the main loop implementation.
Definition: mainloop-api.h:82
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:68
void(* pa_time_event_destroy_cb_t)(pa_mainloop_api *a, pa_time_event *e, void *userdata)
A time event destroy callback prototype.
Definition: mainloop-api.h:70
No event.
Definition: mainloop-api.h:51
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...
struct pa_io_event pa_io_event
An opaque IO event source object.
Definition: mainloop-api.h:59
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:61
Output 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:87
void(* pa_defer_event_destroy_cb_t)(pa_mainloop_api *a, pa_defer_event *e, void *userdata)
A defer event destroy callback prototype.
Definition: mainloop-api.h:77
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:100
void(* io_free)(pa_io_event *e)
Free a IO event source object.
Definition: mainloop-api.h:89
Input event.
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:109
Define header version.
void(* pa_io_event_destroy_cb_t)(pa_mainloop_api *a, pa_io_event *e, void *userdata)
A IO event destroy callback prototype.
Definition: mainloop-api.h:63
void(* quit)(pa_mainloop_api *a, int retval)
Exit the main loop and return the specified retval.
Definition: mainloop-api.h:112
pa_io_event_flags
A bitmask for IO events.
Definition: mainloop-api.h:50
void(* defer_free)(pa_defer_event *e)
Free a deferred event source object.
Definition: mainloop-api.h:107
struct pa_time_event pa_time_event
An opaque timer event source object.
Definition: mainloop-api.h:66
enum pa_io_event_flags pa_io_event_flags_t
A bitmask for IO events.
void(* defer_enable)(pa_defer_event *e, int b)
Enable or disable a deferred event source temporarily.
Definition: mainloop-api.h:105
Error event.
Definition: mainloop-api.h:55
Hangup event.
Definition: mainloop-api.h:54
void(* time_free)(pa_time_event *e)
Free a deferred timer event source object.
Definition: mainloop-api.h:98
struct pa_defer_event pa_defer_event
An opaque deferred event source object.
Definition: mainloop-api.h:73