sysdeps: Document _dbus_daemon_unpublish_session_bus_address

Signed-off-by: Simon McVittie <smcv@collabora.com>
This commit is contained in:
Simon McVittie 2021-12-15 11:49:20 +00:00
parent 84a6147f80
commit aaa515f47d
2 changed files with 17 additions and 2 deletions

View file

@ -4632,11 +4632,10 @@ _dbus_append_keyring_directory_for_credentials (DBusString *directory,
return FALSE; return FALSE;
} }
//PENDING(kdab) docs /* Documented in dbus-sysdeps-win.c, does nothing on Unix */
void void
_dbus_daemon_unpublish_session_bus_address (void) _dbus_daemon_unpublish_session_bus_address (void)
{ {
} }
/** /**

View file

@ -3127,6 +3127,22 @@ _dbus_daemon_publish_session_bus_address (const char* address, const char *scope
return TRUE; return TRUE;
} }
/**
* Clear the platform-specific centralized location where the session
* bus address is published.
*
* This must only be called if \ref DBusServer.published_address is #TRUE,
* which is be the case if and only if platform-specific code has published
* the address centrally.
*
* On Windows, this is implemented by closing a global shared memory segment.
*
* On Unix, the session bus address is not published in a centralized
* location by libdbus, so this function does nothing. The closest
* equivalent on Unix is that the session bus address is published by the
* dbus-launch tool, and unpublished automatically when the dbus-launch
* tool exits.
*/
void void
_dbus_daemon_unpublish_session_bus_address (void) _dbus_daemon_unpublish_session_bus_address (void)
{ {