mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2024-11-12 20:36:15 +01:00
docs: Add links to D-Bus specification for D-Bus address format
In an attempt to clarify the format a little.
This commit is contained in:
parent
4b75333c83
commit
78fba90f65
@ -63,8 +63,9 @@
|
|||||||
* @include: gio/gio.h
|
* @include: gio/gio.h
|
||||||
*
|
*
|
||||||
* Routines for working with D-Bus addresses. A D-Bus address is a string
|
* Routines for working with D-Bus addresses. A D-Bus address is a string
|
||||||
* like "unix:tmpdir=/tmp/my-app-name". The exact format of addresses
|
* like `unix:tmpdir=/tmp/my-app-name`. The exact format of addresses
|
||||||
* is explained in detail in the [D-Bus specification](http://dbus.freedesktop.org/doc/dbus-specification.html\#addresses).
|
* is explained in detail in the
|
||||||
|
* [D-Bus specification](http://dbus.freedesktop.org/doc/dbus-specification.html#addresses).
|
||||||
*/
|
*/
|
||||||
|
|
||||||
static gchar *get_session_address_platform_specific (GError **error);
|
static gchar *get_session_address_platform_specific (GError **error);
|
||||||
@ -76,7 +77,8 @@ static gchar *get_session_address_dbus_launch (GError **error);
|
|||||||
* g_dbus_is_address:
|
* g_dbus_is_address:
|
||||||
* @string: A string.
|
* @string: A string.
|
||||||
*
|
*
|
||||||
* Checks if @string is a D-Bus address.
|
* Checks if @string is a
|
||||||
|
* [D-Bus address](https://dbus.freedesktop.org/doc/dbus-specification.html#addresses).
|
||||||
*
|
*
|
||||||
* This doesn't check if @string is actually supported by #GDBusServer
|
* This doesn't check if @string is actually supported by #GDBusServer
|
||||||
* or #GDBusConnection - use g_dbus_is_supported_address() to do more
|
* or #GDBusConnection - use g_dbus_is_supported_address() to do more
|
||||||
@ -370,7 +372,8 @@ is_valid_tcp (const gchar *address_entry,
|
|||||||
*
|
*
|
||||||
* Like g_dbus_is_address() but also checks if the library suppors the
|
* Like g_dbus_is_address() but also checks if the library suppors the
|
||||||
* transports in @string and that key/value pairs for each transport
|
* transports in @string and that key/value pairs for each transport
|
||||||
* are valid.
|
* are valid. See the specification of the
|
||||||
|
* [D-Bus address format](https://dbus.freedesktop.org/doc/dbus-specification.html#addresses).
|
||||||
*
|
*
|
||||||
* Returns: %TRUE if @string is a valid D-Bus address that is
|
* Returns: %TRUE if @string is a valid D-Bus address that is
|
||||||
* supported by this library, %FALSE if @error is set.
|
* supported by this library, %FALSE if @error is set.
|
||||||
@ -839,7 +842,8 @@ get_stream_thread_func (GTask *task,
|
|||||||
*
|
*
|
||||||
* Asynchronously connects to an endpoint specified by @address and
|
* Asynchronously connects to an endpoint specified by @address and
|
||||||
* sets up the connection so it is in a state to run the client-side
|
* sets up the connection so it is in a state to run the client-side
|
||||||
* of the D-Bus authentication conversation.
|
* of the D-Bus authentication conversation. @address must be in the
|
||||||
|
* [D-Bus address format](https://dbus.freedesktop.org/doc/dbus-specification.html#addresses).
|
||||||
*
|
*
|
||||||
* When the operation is finished, @callback will be invoked. You can
|
* When the operation is finished, @callback will be invoked. You can
|
||||||
* then call g_dbus_address_get_stream_finish() to get the result of
|
* then call g_dbus_address_get_stream_finish() to get the result of
|
||||||
@ -917,7 +921,8 @@ g_dbus_address_get_stream_finish (GAsyncResult *res,
|
|||||||
*
|
*
|
||||||
* Synchronously connects to an endpoint specified by @address and
|
* Synchronously connects to an endpoint specified by @address and
|
||||||
* sets up the connection so it is in a state to run the client-side
|
* sets up the connection so it is in a state to run the client-side
|
||||||
* of the D-Bus authentication conversation.
|
* of the D-Bus authentication conversation. @address must be in the
|
||||||
|
* [D-Bus address format](https://dbus.freedesktop.org/doc/dbus-specification.html#addresses).
|
||||||
*
|
*
|
||||||
* This is a synchronous failable function. See
|
* This is a synchronous failable function. See
|
||||||
* g_dbus_address_get_stream() for the asynchronous version.
|
* g_dbus_address_get_stream() for the asynchronous version.
|
||||||
@ -1549,6 +1554,9 @@ get_session_address_platform_specific (GError **error)
|
|||||||
* bus instance specified by @bus_type. This may involve using various
|
* bus instance specified by @bus_type. This may involve using various
|
||||||
* platform specific mechanisms.
|
* platform specific mechanisms.
|
||||||
*
|
*
|
||||||
|
* The returned address will be in the
|
||||||
|
* [D-Bus address format](https://dbus.freedesktop.org/doc/dbus-specification.html#addresses).
|
||||||
|
*
|
||||||
* Returns: a valid D-Bus address string for @bus_type or %NULL if
|
* Returns: a valid D-Bus address string for @bus_type or %NULL if
|
||||||
* @error is set
|
* @error is set
|
||||||
*
|
*
|
||||||
|
@ -2798,7 +2798,8 @@ g_dbus_connection_new_sync (GIOStream *stream,
|
|||||||
*
|
*
|
||||||
* Asynchronously connects and sets up a D-Bus client connection for
|
* Asynchronously connects and sets up a D-Bus client connection for
|
||||||
* exchanging D-Bus messages with an endpoint specified by @address
|
* exchanging D-Bus messages with an endpoint specified by @address
|
||||||
* which must be in the D-Bus address format.
|
* which must be in the
|
||||||
|
* [D-Bus address format](https://dbus.freedesktop.org/doc/dbus-specification.html#addresses).
|
||||||
*
|
*
|
||||||
* This constructor can only be used to initiate client-side
|
* This constructor can only be used to initiate client-side
|
||||||
* connections - use g_dbus_connection_new() if you need to act as the
|
* connections - use g_dbus_connection_new() if you need to act as the
|
||||||
@ -2884,7 +2885,8 @@ g_dbus_connection_new_for_address_finish (GAsyncResult *res,
|
|||||||
*
|
*
|
||||||
* Synchronously connects and sets up a D-Bus client connection for
|
* Synchronously connects and sets up a D-Bus client connection for
|
||||||
* exchanging D-Bus messages with an endpoint specified by @address
|
* exchanging D-Bus messages with an endpoint specified by @address
|
||||||
* which must be in the D-Bus address format.
|
* which must be in the
|
||||||
|
* [D-Bus address format](https://dbus.freedesktop.org/doc/dbus-specification.html#addresses).
|
||||||
*
|
*
|
||||||
* This constructor can only be used to initiate client-side
|
* This constructor can only be used to initiate client-side
|
||||||
* connections - use g_dbus_connection_new_sync() if you need to act
|
* connections - use g_dbus_connection_new_sync() if you need to act
|
||||||
|
@ -504,8 +504,9 @@ g_dbus_server_new_sync (const gchar *address,
|
|||||||
* g_dbus_server_get_client_address:
|
* g_dbus_server_get_client_address:
|
||||||
* @server: A #GDBusServer.
|
* @server: A #GDBusServer.
|
||||||
*
|
*
|
||||||
* Gets a D-Bus address string that can be used by clients to connect
|
* Gets a
|
||||||
* to @server.
|
* [D-Bus address](https://dbus.freedesktop.org/doc/dbus-specification.html#addresses)
|
||||||
|
* string that can be used by clients to connect to @server.
|
||||||
*
|
*
|
||||||
* Returns: A D-Bus address string. Do not free, the string is owned
|
* Returns: A D-Bus address string. Do not free, the string is owned
|
||||||
* by @server.
|
* by @server.
|
||||||
|
Loading…
Reference in New Issue
Block a user