summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSimon Ser <contact@emersion.fr>2023-06-05 11:59:31 +0200
committerSimon Ser <contact@emersion.fr>2024-05-22 08:55:03 +0000
commit4bade6293806986500c517d3b0df571b1bf95d2d (patch)
tree5d8a1c296c64f0373cfffbe292b394d65ac8823e
parentserver: Clarify fd ownership in wl_client_create() (diff)
downloadwayland-4bade6293806986500c517d3b0df571b1bf95d2d.tar
wayland-4bade6293806986500c517d3b0df571b1bf95d2d.tar.gz
wayland-4bade6293806986500c517d3b0df571b1bf95d2d.tar.bz2
wayland-4bade6293806986500c517d3b0df571b1bf95d2d.tar.lz
wayland-4bade6293806986500c517d3b0df571b1bf95d2d.tar.xz
wayland-4bade6293806986500c517d3b0df571b1bf95d2d.tar.zst
wayland-4bade6293806986500c517d3b0df571b1bf95d2d.zip
server: document wl_display_add_socket_fd() ownership
wl_socket_destroy() will close the socket. Signed-off-by: Simon Ser <contact@emersion.fr>
-rw-r--r--src/wayland-server.c3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/wayland-server.c b/src/wayland-server.c
index 0b5b13b..2e18563 100644
--- a/src/wayland-server.c
+++ b/src/wayland-server.c
@@ -1811,6 +1811,9 @@ wl_display_add_socket_auto(struct wl_display *display)
* The fd must be properly set to CLOEXEC and bound to a socket file
* with both bind() and listen() already called.
*
+ * On success, the socket fd ownership is transferred to libwayland:
+ * libwayland will close the socket when the display is destroyed.
+ *
* \memberof wl_display
*/
WL_EXPORT int