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

server: Document wl_display_add_socket_auto

Browse source 
The exact sequence of names tried has de facto become part of the API.

Signed-off-by: Manuel Stoeckl <code@mstoeckl.com>
This commit is contained in:
Manuel Stoeckl 2021-03-02 23:24:16 -05:00 • committed by Simon Ser
parent 0de833da29
commit 387adc6a79
1 changed files with 18 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

18
src/wayland-server.c
View file

@ -1808,6 +1808,24 @@ _wl_display_add_socket(struct wl_display *display, struct wl_socket *s)
return 0; return 0;
} }
/** Automatically pick a Wayland display socket for the clients to connect to.
*
* \param display Wayland display to which the socket should be added.
* \return The socket name if success. NULL if failed.
*
* This adds a Unix socket to Wayland display which can be used by clients to
* connect to Wayland display. The name of the socket is chosen automatically
* as the first available name in the sequence "wayland-0", "wayland-1",
* "wayland-2", ..., "wayland-32".
*
* The string returned by this function is owned by the library and should
* not be freed.
*
* \sa wl_display_add_socket
*
* \memberof wl_display
*/
WL_EXPORT const char * WL_EXPORT const char *
wl_display_add_socket_auto(struct wl_display *display) wl_display_add_socket_auto(struct wl_display *display)
{ {