mirrors/pulseaudio
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pulseaudio/pulseaudio.git synced 2025-11-07 13:30:03 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

mainloop-api: Improve pa_mainloop_api_once() documentation

Browse source
This commit is contained in:
Tanu Kaskinen 2014-03-15 09:52:07 +02:00
parent 868a9d03ad
commit ee9037829a
1 changed files with 5 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

8
src/pulse/mainloop-api.h
View file

@ -114,9 +114,11 @@ struct pa_mainloop_api {
void (*quit)(pa_mainloop_api*a, int retval);
};
/** Run the specified callback function once from the main loop using an anonymous defer event. Note that this performs
* multiple mainloop operations non-atomically. If, for example, you are using a \ref pa_threaded_mainloop, you will need to
* take the mainloop lock before this call. */
/** Run the specified callback function once from the main loop using an
* anonymous defer event. If the mainloop runs in a different thread, you need
* to follow the mainloop implementation's rules regarding how to safely create
* defer events. In particular, if you're using \ref pa_threaded_mainloop, you
* must lock the mainloop before calling this function. */
void pa_mainloop_api_once(pa_mainloop_api*m, void (*callback)(pa_mainloop_api*m, void *userdata), void *userdata);
PA_C_DECL_END