From: Tanu Kaskinen Date: Sat, 15 Mar 2014 07:52:07 +0000 (+0200) Subject: mainloop-api: Improve pa_mainloop_api_once() documentation X-Git-Url: https://code.delx.au/pulseaudio/commitdiff_plain/ee9037829a9ec7ec0c810a574fa41f789afb1b02 mainloop-api: Improve pa_mainloop_api_once() documentation --- diff --git a/src/pulse/mainloop-api.h b/src/pulse/mainloop-api.h index b4eccb1a..d03e0e6c 100644 --- a/src/pulse/mainloop-api.h +++ b/src/pulse/mainloop-api.h @@ -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