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

doc: Added API documentation for wl_display_destroy and wl_display_add_socket functions.

Browse source 
Signed-off-by: Srivardhan Hebbar <sri.hebbar@samsung.com>
[Pekka Paalanen: minor re-wording.]
Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
This commit is contained in:
Srivardhan Hebbar 2014-10-15 14:51:27 +05:30 • committed by Bryce Harrington
parent 3170fdfbc3
commit b03167e01f
1 changed files with 38 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

38
src/wayland-server.c
View file

@ -862,6 +862,20 @@ wl_socket_alloc(void)
return s;
}
/** Destroy Wayland display object.
*
* \param display The Wayland display object which should be destroyed.
* \return None.
*
* This function emits the wl_display destroy signal, releases
* all the sockets added to this display, free's all the globals associated
* with this display, free's memory of additional shared memory formats and
* destroy the display object.
*
* \sa wl_display_add_destroy_listener
*
* \memberof wl_display
*/
WL_EXPORT void
wl_display_destroy(struct wl_display *display)
{
@ -1181,6 +1195,30 @@ wl_display_add_socket_auto(struct wl_display *display)
return NULL;
}
/** Add a socket to Wayland display for the clients to connect.
*
* \param display Wayland display to which the socket should be added.
* \param name Name of the Unix socket.
* \return 0 if success. -1 if failed.
*
* This adds a Unix socket to Wayland display which can be used by clients to
* connect to Wayland display.
*
* If NULL is passed as name, then it would look for WAYLAND_DISPLAY env
* variable for the socket name. If WAYLAND_DISPLAY is not set, then default
* wayland-0 is used.
*
* The Unix socket will be created in the directory pointed to by environment
* variable XDG_RUNTIME_DIR. If XDG_RUNTIME_DIR is not set, then this function
* fails and returns -1.
*
* The length of socket path, i.e., the path set in XDG_RUNTIME_DIR and the
* socket name, must not exceed the maxium length of a Unix socket path.
* The function also fails if the user do not have write permission in the
* XDG_RUNTIME_DIR path or if the socket name is already in use.
*
* \memberof wl_display
*/
WL_EXPORT int
wl_display_add_socket(struct wl_display *display, const char *name)
{