[pulseaudio-commits] [Git][pulseaudio/pulseaudio][master] thread-mainloop: Extend the locking documentation a bit

[Tanu Kaskinen]

Tanu Kaskinen pushed to branch master at PulseAudio / pulseaudio


Commits:
3dc525df by Tanu Kaskinen at 2020-05-27T09:41:40+03:00
thread-mainloop: Extend the locking documentation a bit

Make it more clear which objects require locking. I remember talking to
multiple people for whom that wasn't immediately clear from the
documentation.

- - - - -


1 changed file:

- src/pulse/thread-mainloop.h


Changes:

=====================================
src/pulse/thread-mainloop.h
=====================================
@@ -66,9 +66,11 @@ PA_C_DECL_BEGIN
  * number of times you called pa_threaded_mainloop_lock().
  *
  * The lock needs to be held whenever you call any PulseAudio function that
- * uses an object associated with this main loop. Make sure you do not hold
- * on to the lock more than necessary though, as the threaded main loop stops
- * while the lock is held.
+ * uses an object associated with this main loop. Those objects include
+ * pa_mainloop, pa_context, pa_stream and pa_operation, and the various event
+ * objects (pa_io_event, pa_time_event, pa_defer_event). Make sure you do not
+ * hold on to the lock more than necessary though, as the threaded main loop
+ * stops while the lock is held.
  *
  * Example:
  *



View it on GitLab: https://gitlab.freedesktop.org/pulseaudio/pulseaudio/-/commit/3dc525df5de96c744d523d674a1a453d829e9d78

-- 
View it on GitLab: https://gitlab.freedesktop.org/pulseaudio/pulseaudio/-/commit/3dc525df5de96c744d523d674a1a453d829e9d78
You're receiving this email because of your account on gitlab.freedesktop.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.freedesktop.org/archives/pulseaudio-commits/attachments/20200527/75588fdd/attachment.htm>