mirrors/wayland
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wayland/wayland.git synced 2025-10-29 05:40:16 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

client: Document best practices for event queue changes

Browse source 
Document the proper way to deal with event queue changes, in order to
guarantee proper handing of all events which were queued before the
queue change takes effect, especially in multi-threaded setups.

Make a special note about queue changes of newly created proxies,
which require the use of a proxy wrapper for thread safety.

Signed-off-by: Alexandros Frantzis <alexandros.frantzis@collabora.com>
Suggested-by: Pekka Paalanen <pekka.paalanen@collabora.com>
This commit is contained in:
Alexandros Frantzis 2022-05-26 12:05:15 +03:00 • committed by Simon Ser
parent 9434e8d69f
commit a8246a9f0f
1 changed files with 13 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

13
src/wayland-client.c
View file

@ -2311,6 +2311,19 @@ wl_proxy_get_class(struct wl_proxy *proxy)
* queued in \c queue from now. If queue is NULL, then the display's
* default queue is set to the proxy.
*
* In order to guarantee proper handing of all events which were queued
* before the queue change takes effect, it is required to dispatch the
* proxy's old event queue after setting a new event queue.
*
* This is particularly important for multi-threaded setups, where it is
* possible for events to be queued to the proxy's old queue from a
* different thread during the invocation of this function.
*
* To ensure that all events for a newly created proxy are dispatched
* on a particular queue, it is necessary to use a proxy wrapper if
* events are read and dispatched on more than one thread. See
* wl_proxy_create_wrapper() for more details.
*
* \note By default, the queue set in proxy is the one inherited from parent.
*
* \sa wl_display_dispatch_queue()