Core Wayland window system code and protocol
Find a file
Thomas Lukaszewicz a86fd86b5e wayland-server: Add wl_client_add_event_dispatch_listener
The patch adds a listener called after an event has been dispatched
by the server.

Wayland servers that incorporate the Wayland display into their own
event loops may dispatch multiple Wayland events to clients as they
work through their task queues.

For e.g. if system display state changes the Wayland server may
emit several output / surface Wayland events to connected clients.

Currently an explicit flush is performd immediately after each
individual Wayland event is dispatched to make sure these are
propagated to clients in a deterministic / reliable manner.

This results in hard to maintain / easy to break code. Contributors
must make sure to explicitly flush when dispatching Wayland events
to clients - or otherwise wait for some other server event to flush
the client buffer later on. In the latter case behavior is not
deterministic and makes testing the server code much harder.

The client event_dispatch_listener added in this patch allows the
server to track if the processing of a server event has resulted in
the dispatch of one or more Wayland events to clients - and ensure
the buffer is appropriately flushed.

This eliminates the need to flush in many different areas of the
codebase, making the server easier to maintain and test.

Signed-off-by: Thomas Lukaszewicz <thomaslukaszewicz@gmail.com>
2024-01-04 03:48:22 +00:00
.gitlab/issue_templates gitlab: make issue template the default 2023-11-21 15:44:31 +00:00
cursor cursor: check return value of snprintf() 2023-08-02 16:47:07 +02:00
doc Document which type are nullable, and wire format for null value 2022-07-14 08:38:49 -07:00
egl build: define tests in egl/meson.build when the 'tests' option is enabled 2023-12-10 14:58:04 +00:00
protocol protocol: wl_subsurface will never be focused 2023-12-27 18:02:07 +00:00
src wayland-server: Add wl_client_add_event_dispatch_listener 2024-01-04 03:48:22 +00:00
tests wayland-server: Add wl_client_add_event_dispatch_listener 2024-01-04 03:48:22 +00:00
.editorconfig editorconfig: add settings for the .gitlab-ci.yml file 2020-06-05 08:22:34 +10:00
.gitignore build: drop autotools 2021-03-05 09:15:04 +00:00
.gitlab-ci.yml ci: upgrade FreeBSD to 13.2 2023-08-02 16:47:07 +02:00
.mailmap Add a .mailmap file 2023-03-25 11:17:32 -05:00
.triage-policies.yml Add a triage-policies file for bugbot 2023-07-07 21:18:08 +10:00
CONTRIBUTING.md CONTRIBUTING: fix typo "excercising" 2020-12-17 16:03:14 -05:00
COPYING COPYING: Update to MIT Expat License rather than MIT X License 2015-06-12 15:31:21 -07:00
meson.build build: re-open main branch for regular development 2023-04-04 13:38:18 +02:00
meson_options.txt meson: Use proper type for bools 2022-04-02 17:04:08 +03:00
README.md readme: convert to Markdown 2023-02-13 19:57:15 +01:00
release.sh release.sh: Don't push *all* tags 2023-01-16 10:03:54 +00:00
releasing.txt Add release.sh 2022-07-14 08:04:43 +00:00
wayland-scanner.m4 build: check wayland-scanner version 2020-01-16 17:25:06 +01:00
wayland-scanner.mk Pass input/output files as arguments to wayland-scanner 2017-08-18 15:20:24 +03:00

Wayland

Wayland is a project to define a protocol for a compositor to talk to its clients as well as a library implementation of the protocol. The compositor can be a standalone display server running on Linux kernel modesetting and evdev input devices, an X application, or a wayland client itself. The clients can be traditional applications, X servers (rootless or fullscreen) or other display servers.

The wayland protocol is essentially only about input handling and buffer management. The compositor receives input events and forwards them to the relevant client. The clients creates buffers and renders into them and notifies the compositor when it needs to redraw. The protocol also handles drag and drop, selections, window management and other interactions that must go through the compositor. However, the protocol does not handle rendering, which is one of the features that makes wayland so simple. All clients are expected to handle rendering themselves, typically through cairo or OpenGL.

Building the wayland libraries is fairly simple, aside from libffi, they don't have many dependencies:

$ git clone https://gitlab.freedesktop.org/wayland/wayland
$ cd wayland
$ meson build/ --prefix=PREFIX
$ ninja -C build/ install

where PREFIX is where you want to install the libraries.

See https://wayland.freedesktop.org for documentation.