luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-07-17 23:47:52 +02:00
Code Issues Packages Projects Releases Wiki Activity

GDBusConnection: Convert docs to markdown

Browse Source 
And straighten out capitalization across the file.
This commit is contained in:
Matthias Clasen
2014-01-31 23:42:40 -05:00
parent fee9194ade
commit 3247d11704
1 changed files with 368 additions and 356 deletions
Download Patch File Download Diff File Expand all files Collapse all files

542
gio/gdbusconnection.c
View File

@@ -1021,29 +1021,23 @@ g_dbus_connection_class_init (GDBusConnectionClass *klass)
/** /**
* GDBusConnection::closed: * GDBusConnection::closed:
* @connection: The #GDBusConnection emitting the signal. * @connection: the #GDBusConnection emitting the signal
* @remote_peer_vanished: %TRUE if @connection is closed because the * @remote_peer_vanished: %TRUE if @connection is closed because the
* remote peer closed its end of the connection. * remote peer closed its end of the connection
* @error: (allow-none): A #GError with more details about the event or %NULL. * @error: (allow-none): a #GError with more details about the event or %NULL
* *
* Emitted when the connection is closed. * Emitted when the connection is closed.
* *
* The cause of this event can be * The cause of this event can be
* <itemizedlist> *
* <listitem><para> * - If g_dbus_connection_close() is called. In this case
* If g_dbus_connection_close() is called. In this case
* @remote_peer_vanished is set to %FALSE and @error is %NULL. * @remote_peer_vanished is set to %FALSE and @error is %NULL.
* </para></listitem> *
* <listitem><para> * - If the remote peer closes the connection. In this case
* If the remote peer closes the connection. In this case
* @remote_peer_vanished is set to %TRUE and @error is set. * @remote_peer_vanished is set to %TRUE and @error is set.
* </para></listitem> *
* <listitem><para> * - If the remote peer sends invalid or malformed data. In this
* If the remote peer sends invalid or malformed data. In this * case @remote_peer_vanished is set to %FALSE and @error is set.
* case @remote_peer_vanished is set to %FALSE and @error
* is set.
* </para></listitem>
* </itemizedlist>
* *
* Upon receiving this signal, you should give up your reference to * Upon receiving this signal, you should give up your reference to
* @connection. You are guaranteed that this signal is emitted only * @connection. You are guaranteed that this signal is emitted only
@@ -1133,7 +1127,7 @@ g_dbus_connection_get_stream (GDBusConnection *connection)
/** /**
* g_dbus_connection_start_message_processing: * g_dbus_connection_start_message_processing:
* @connection: A #GDBusConnection. * @connection: a #GDBusConnection
* *
* If @connection was created with * If @connection was created with
* %G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING, this method * %G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING, this method
@@ -1157,11 +1151,11 @@ g_dbus_connection_start_message_processing (GDBusConnection *connection)
/** /**
* g_dbus_connection_is_closed: * g_dbus_connection_is_closed:
* @connection: A #GDBusConnection. * @connection: a #GDBusConnection
* *
* Gets whether @connection is closed. * Gets whether @connection is closed.
* *
* Returns: %TRUE if the connection is closed, %FALSE otherwise. * Returns: %TRUE if the connection is closed, %FALSE otherwise
* *
* Since: 2.26 * Since: 2.26
*/ */
@@ -1179,11 +1173,11 @@ g_dbus_connection_is_closed (GDBusConnection *connection)
/** /**
* g_dbus_connection_get_capabilities: * g_dbus_connection_get_capabilities:
* @connection: A #GDBusConnection. * @connection: a #GDBusConnection
* *
* Gets the capabilities negotiated with the remote peer * Gets the capabilities negotiated with the remote peer
* *
* Returns: Zero or more flags from the #GDBusCapabilityFlags enumeration. * Returns: zero or more flags from the #GDBusCapabilityFlags enumeration
* *
* Since: 2.26 * Since: 2.26
*/ */
@@ -1218,19 +1212,18 @@ flush_in_thread_func (GSimpleAsyncResult *res,
/** /**
* g_dbus_connection_flush: * g_dbus_connection_flush:
* @connection: A #GDBusConnection. * @connection: a #GDBusConnection
* @cancellable: (allow-none): A #GCancellable or %NULL. * @cancellable: (allow-none): a #GCancellable or %NULL
* @callback: (allow-none): A #GAsyncReadyCallback to call when the request is * @callback: (allow-none): a #GAsyncReadyCallback to call when the
* satisfied or %NULL if you don't care about the result. * request is satisfied or %NULL if you don't care about the result
* @user_data: The data to pass to @callback. * @user_data: The data to pass to @callback
* *
* Asynchronously flushes @connection, that is, writes all queued * Asynchronously flushes @connection, that is, writes all queued
* outgoing message to the transport and then flushes the transport * outgoing message to the transport and then flushes the transport
* (using g_output_stream_flush_async()). This is useful in programs * (using g_output_stream_flush_async()). This is useful in programs
* that wants to emit a D-Bus signal and then exit * that wants to emit a D-Bus signal and then exit immediately. Without
* immediately. Without flushing the connection, there is no guarantee * flushing the connection, there is no guaranteed that the message has
* that the message has been sent to the networking buffers in the OS * been sent to the networking buffers in the OS kernel.
* kernel.
* *
* This is an asynchronous method. When the operation is finished, * This is an asynchronous method. When the operation is finished,
* @callback will be invoked in the <link * @callback will be invoked in the <link
@@ -1266,13 +1259,14 @@ g_dbus_connection_flush (GDBusConnection *connection,
/** /**
* g_dbus_connection_flush_finish: * g_dbus_connection_flush_finish:
* @connection: A #GDBusConnection. * @connection: a #GDBusConnection
* @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_flush(). * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed
* @error: Return location for error or %NULL. * to g_dbus_connection_flush()
* @error: return location for error or %NULL
* *
* Finishes an operation started with g_dbus_connection_flush(). * Finishes an operation started with g_dbus_connection_flush().
* *
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set. * Returns: %TRUE if the operation succeeded, %FALSE if @error is set
* *
* Since: 2.26 * Since: 2.26
*/ */
@@ -1303,16 +1297,16 @@ g_dbus_connection_flush_finish (GDBusConnection *connection,
/** /**
* g_dbus_connection_flush_sync: * g_dbus_connection_flush_sync:
* @connection: A #GDBusConnection. * @connection: a #GDBusConnection
* @cancellable: (allow-none): A #GCancellable or %NULL. * @cancellable: (allow-none): a #GCancellable or %NULL
* @error: Return location for error or %NULL. * @error: return location for error or %NULL
* *
* Synchronously flushes @connection. The calling thread is blocked * Synchronously flushes @connection. The calling thread is blocked
* until this is done. See g_dbus_connection_flush() for the * until this is done. See g_dbus_connection_flush() for the
* asynchronous version of this method and more details about what it * asynchronous version of this method and more details about what it
* does. * does.
* *
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set. * Returns: %TRUE if the operation succeeded, %FALSE if @error is set
* *
* Since: 2.26 * Since: 2.26
*/ */
@@ -1417,11 +1411,11 @@ schedule_closed_unlocked (GDBusConnection *connection,
/** /**
* g_dbus_connection_close: * g_dbus_connection_close:
* @connection: A #GDBusConnection. * @connection: a #GDBusConnection
* @cancellable: (allow-none): A #GCancellable or %NULL. * @cancellable: (allow-none): a #GCancellable or %NULL
* @callback: (allow-none): A #GAsyncReadyCallback to call when the request is * @callback: (allow-none): a #GAsyncReadyCallback to call when the request is
* satisfied or %NULL if you don't care about the result. * satisfied or %NULL if you don't care about the result
* @user_data: The data to pass to @callback. * @user_data: The data to pass to @callback
* *
* Closes @connection. Note that this never causes the process to * Closes @connection. Note that this never causes the process to
* exit (this might only happen if the other end of a shared message * exit (this might only happen if the other end of a shared message
@@ -1477,13 +1471,14 @@ g_dbus_connection_close (GDBusConnection *connection,
/** /**
* g_dbus_connection_close_finish: * g_dbus_connection_close_finish:
* @connection: A #GDBusConnection. * @connection: a #GDBusConnection
* @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_close(). * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed
* @error: Return location for error or %NULL. * to g_dbus_connection_close()
* @error: return location for error or %NULL
* *
* Finishes an operation started with g_dbus_connection_close(). * Finishes an operation started with g_dbus_connection_close().
* *
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set. * Returns: %TRUE if the operation succeeded, %FALSE if @error is set
* *
* Since: 2.26 * Since: 2.26
*/ */
@@ -1531,16 +1526,16 @@ sync_close_cb (GObject *source_object,
/** /**
* g_dbus_connection_close_sync: * g_dbus_connection_close_sync:
* @connection: A #GDBusConnection. * @connection: a #GDBusConnection
* @cancellable: (allow-none): A #GCancellable or %NULL. * @cancellable: (allow-none): a #GCancellable or %NULL
* @error: Return location for error or %NULL. * @error: return location for error or %NULL
* *
* Synchronously closees @connection. The calling thread is blocked * Synchronously closees @connection. The calling thread is blocked
* until this is done. See g_dbus_connection_close() for the * until this is done. See g_dbus_connection_close() for the
* asynchronous version of this method and more details about what it * asynchronous version of this method and more details about what it
* does. * does.
* *
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set. * Returns: %TRUE if the operation succeeded, %FALSE if @error is set
* *
* Since: 2.26 * Since: 2.26
*/ */
@@ -1583,7 +1578,7 @@ g_dbus_connection_close_sync (GDBusConnection *connection,
/** /**
* g_dbus_connection_get_last_serial: * g_dbus_connection_get_last_serial:
* @connection: A #GDBusConnection. * @connection: a #GDBusConnection
* *
* Retrieves the last serial number assigned to a #GDBusMessage on * Retrieves the last serial number assigned to a #GDBusMessage on
* the current thread. This includes messages sent via both low-level * the current thread. This includes messages sent via both low-level
@@ -1592,7 +1587,7 @@ g_dbus_connection_close_sync (GDBusConnection *connection,
* g_dbus_connection_call() or g_dbus_proxy_call(). * g_dbus_connection_call() or g_dbus_proxy_call().
* *
* Returns: the last used serial or zero when no message has been sent * Returns: the last used serial or zero when no message has been sent
* within the current thread. * within the current thread
* *
* Since: 2.34 * Since: 2.34
*/ */
@@ -1716,12 +1711,12 @@ g_dbus_connection_send_message_unlocked (GDBusConnection *connection,
/** /**
* g_dbus_connection_send_message: * g_dbus_connection_send_message:
* @connection: A #GDBusConnection. * @connection: a #GDBusConnection
* @message: A #GDBusMessage * @message: a #GDBusMessage
* @flags: Flags affecting how the message is sent. * @flags: flags affecting how the message is sent
* @out_serial: (out) (allow-none): Return location for serial number assigned * @out_serial: (out) (allow-none): return location for serial number assigned
* to @message when sending it or %NULL. * to @message when sending it or %NULL
* @error: Return location for error or %NULL. * @error: Return location for error or %NULL
* *
* Asynchronously sends @message to the peer represented by @connection. * Asynchronously sends @message to the peer represented by @connection.
* *
@@ -1744,7 +1739,7 @@ g_dbus_connection_send_message_unlocked (GDBusConnection *connection,
* %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag. * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag.
* *
* Returns: %TRUE if the message was well-formed and queued for * Returns: %TRUE if the message was well-formed and queued for
* transmission, %FALSE if @error is set. * transmission, %FALSE if @error is set
* *
* Since: 2.26 * Since: 2.26
*/ */
@@ -2029,17 +2024,17 @@ g_dbus_connection_send_message_with_reply_unlocked (GDBusConnection *connect
/** /**
* g_dbus_connection_send_message_with_reply: * g_dbus_connection_send_message_with_reply:
* @connection: A #GDBusConnection. * @connection: a #GDBusConnection
* @message: A #GDBusMessage. * @message: a #GDBusMessage
* @flags: Flags affecting how the message is sent. * @flags: flags affecting how the message is sent
* @timeout_msec: The timeout in milliseconds, -1 to use the default * @timeout_msec: the timeout in milliseconds, -1 to use the default
* timeout or %G_MAXINT for no timeout. * timeout or %G_MAXINT for no timeout
* @out_serial: (out) (allow-none): Return location for serial number assigned * @out_serial: (out) (allow-none): return location for serial number assigned
* to @message when sending it or %NULL. * to @message when sending it or %NULL
* @cancellable: (allow-none): A #GCancellable or %NULL. * @cancellable: (allow-none): a #GCancellable or %NULL
* @callback: (allow-none): A #GAsyncReadyCallback to call when the request is * @callback: (allow-none): a #GAsyncReadyCallback to call when the request
* satisfied or %NULL if you don't care about the result. * is satisfied or %NULL if you don't care about the result
* @user_data: The data to pass to @callback. * @user_data: The data to pass to @callback
* *
* Asynchronously sends @message to the peer represented by @connection. * Asynchronously sends @message to the peer represented by @connection.
* *
@@ -2100,8 +2095,9 @@ g_dbus_connection_send_message_with_reply (GDBusConnection *connection,
/** /**
* g_dbus_connection_send_message_with_reply_finish: * g_dbus_connection_send_message_with_reply_finish:
* @connection: a #GDBusConnection * @connection: a #GDBusConnection
* @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_send_message_with_reply(). * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* @error: Return location for error or %NULL. * g_dbus_connection_send_message_with_reply()
* @error: teturn location for error or %NULL
* *
* Finishes an operation started with g_dbus_connection_send_message_with_reply(). * Finishes an operation started with g_dbus_connection_send_message_with_reply().
* *
@@ -2114,7 +2110,7 @@ g_dbus_connection_send_message_with_reply (GDBusConnection *connection,
* linkend="gdbus-unix-fd-client"/> for an example of how to use this * linkend="gdbus-unix-fd-client"/> for an example of how to use this
* low-level API to send and receive UNIX file descriptors. * low-level API to send and receive UNIX file descriptors.
* *
* Returns: (transfer full): A locked #GDBusMessage or %NULL if @error is set. * Returns: (transfer full): a locked #GDBusMessage or %NULL if @error is set
* *
* Since: 2.26 * Since: 2.26
*/ */
@@ -2164,15 +2160,15 @@ send_message_with_reply_sync_cb (GDBusConnection *connection,
/** /**
* g_dbus_connection_send_message_with_reply_sync: * g_dbus_connection_send_message_with_reply_sync:
* @connection: A #GDBusConnection. * @connection: a #GDBusConnection
* @message: A #GDBusMessage. * @message: a #GDBusMessage
* @flags: Flags affecting how the message is sent. * @flags: flags affecting how the message is sent.
* @timeout_msec: The timeout in milliseconds, -1 to use the default * @timeout_msec: the timeout in milliseconds, -1 to use the default
* timeout or %G_MAXINT for no timeout. * timeout or %G_MAXINT for no timeout
* @out_serial: (out) (allow-none): Return location for serial number assigned * @out_serial: (out) (allow-none): return location for serial number
* to @message when sending it or %NULL. * assigned to @message when sending it or %NULL
* @cancellable: (allow-none): A #GCancellable or %NULL. * @cancellable: (allow-none): a #GCancellable or %NULL
* @error: Return location for error or %NULL. * @error: return location for error or %NULL
* *
* Synchronously sends @message to the peer represented by @connection * Synchronously sends @message to the peer represented by @connection
* and blocks the calling thread until a reply is received or the * and blocks the calling thread until a reply is received or the
@@ -2203,7 +2199,8 @@ send_message_with_reply_sync_cb (GDBusConnection *connection,
* Note that @message must be unlocked, unless @flags contain the * Note that @message must be unlocked, unless @flags contain the
* %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag. * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag.
* *
* Returns: (transfer full): A locked #GDBusMessage that is the reply to @message or %NULL if @error is set. * Returns: (transfer full): a locked #GDBusMessage that is the reply
* to @message or %NULL if @error is set
* *
* Since: 2.26 * Since: 2.26
*/ */
@@ -2713,13 +2710,13 @@ async_initable_iface_init (GAsyncInitableIface *async_initable_iface)
/** /**
* g_dbus_connection_new: * g_dbus_connection_new:
* @stream: A #GIOStream. * @stream: a #GIOStream
* @guid: (allow-none): The GUID to use if a authenticating as a server or %NULL. * @guid: (allow-none): the GUID to use if a authenticating as a server or %NULL
* @flags: Flags describing how to make the connection. * @flags: flags describing how to make the connection
* @observer: (allow-none): A #GDBusAuthObserver or %NULL. * @observer: (allow-none): a #GDBusAuthObserver or %NULL
* @cancellable: (allow-none): A #GCancellable or %NULL. * @cancellable: (allow-none): a #GCancellable or %NULL
* @callback: A #GAsyncReadyCallback to call when the request is satisfied. * @callback: a #GAsyncReadyCallback to call when the request is satisfied
* @user_data: The data to pass to @callback. * @user_data: the data to pass to @callback
* *
* Asynchronously sets up a D-Bus connection for exchanging D-Bus messages * Asynchronously sets up a D-Bus connection for exchanging D-Bus messages
* with the end represented by @stream. * with the end represented by @stream.
@@ -2768,12 +2765,14 @@ g_dbus_connection_new (GIOStream *stream,
/** /**
* g_dbus_connection_new_finish: * g_dbus_connection_new_finish:
* @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_new(). * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback
* @error: Return location for error or %NULL. * passed to g_dbus_connection_new().
* @error: return location for error or %NULL
* *
* Finishes an operation started with g_dbus_connection_new(). * Finishes an operation started with g_dbus_connection_new().
* *
* Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref(). * Returns: a #GDBusConnection or %NULL if @error is set. Free
* with g_object_unref().
* *
* Since: 2.26 * Since: 2.26
*/ */
@@ -2801,12 +2800,12 @@ g_dbus_connection_new_finish (GAsyncResult *res,
/** /**
* g_dbus_connection_new_sync: * g_dbus_connection_new_sync:
* @stream: A #GIOStream. * @stream: a #GIOStream
* @guid: (allow-none): The GUID to use if a authenticating as a server or %NULL. * @guid: (allow-none): the GUID to use if a authenticating as a server or %NULL
* @flags: Flags describing how to make the connection. * @flags: flags describing how to make the connection
* @observer: (allow-none): A #GDBusAuthObserver or %NULL. * @observer: (allow-none): a #GDBusAuthObserver or %NULL
* @cancellable: (allow-none): A #GCancellable or %NULL. * @cancellable: (allow-none): a #GCancellable or %NULL
* @error: Return location for error or %NULL. * @error: return location for error or %NULL
* *
* Synchronously sets up a D-Bus connection for exchanging D-Bus messages * Synchronously sets up a D-Bus connection for exchanging D-Bus messages
* with the end represented by @stream. * with the end represented by @stream.
@@ -2824,7 +2823,7 @@ g_dbus_connection_new_finish (GAsyncResult *res,
* This is a synchronous failable constructor. See * This is a synchronous failable constructor. See
* g_dbus_connection_new() for the asynchronous version. * g_dbus_connection_new() for the asynchronous version.
* *
* Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref(). * Returns: a #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
* *
* Since: 2.26 * Since: 2.26
*/ */
@@ -2852,12 +2851,12 @@ g_dbus_connection_new_sync (GIOStream *stream,
/** /**
* g_dbus_connection_new_for_address: * g_dbus_connection_new_for_address:
* @address: A D-Bus address. * @address: a D-Bus address
* @flags: Flags describing how to make the connection. * @flags: flags describing how to make the connection
* @observer: (allow-none): A #GDBusAuthObserver or %NULL. * @observer: (allow-none): a #GDBusAuthObserver or %NULL
* @cancellable: (allow-none): A #GCancellable or %NULL. * @cancellable: (allow-none): a #GCancellable or %NULL
* @callback: A #GAsyncReadyCallback to call when the request is satisfied. * @callback: a #GAsyncReadyCallback to call when the request is satisfied
* @user_data: The data to pass to @callback. * @user_data: the data to pass to @callback
* *
* 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
@@ -2904,12 +2903,14 @@ g_dbus_connection_new_for_address (const gchar *address,
/** /**
* g_dbus_connection_new_for_address_finish: * g_dbus_connection_new_for_address_finish:
* @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_new(). * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed
* @error: Return location for error or %NULL. * to g_dbus_connection_new()
* @error: return location for error or %NULL
* *
* Finishes an operation started with g_dbus_connection_new_for_address(). * Finishes an operation started with g_dbus_connection_new_for_address().
* *
* Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref(). * Returns: a #GDBusConnection or %NULL if @error is set. Free with
* g_object_unref().
* *
* Since: 2.26 * Since: 2.26
*/ */
@@ -2937,11 +2938,11 @@ g_dbus_connection_new_for_address_finish (GAsyncResult *res,
/** /**
* g_dbus_connection_new_for_address_sync: * g_dbus_connection_new_for_address_sync:
* @address: A D-Bus address. * @address: a D-Bus address
* @flags: Flags describing how to make the connection. * @flags: flags describing how to make the connection
* @observer: (allow-none): A #GDBusAuthObserver or %NULL. * @observer: (allow-none): a #GDBusAuthObserver or %NULL
* @cancellable: (allow-none): A #GCancellable or %NULL. * @cancellable: (allow-none): a #GCancellable or %NULL
* @error: Return location for error or %NULL. * @error: return location for error or %NULL
* *
* 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
@@ -2959,7 +2960,8 @@ g_dbus_connection_new_for_address_finish (GAsyncResult *res,
* If @observer is not %NULL it may be used to control the * If @observer is not %NULL it may be used to control the
* authentication process. * authentication process.
* *
* Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref(). * Returns: a #GDBusConnection or %NULL if @error is set. Free with
* g_object_unref().
* *
* Since: 2.26 * Since: 2.26
*/ */
@@ -2985,9 +2987,9 @@ g_dbus_connection_new_for_address_sync (const gchar *address,
/** /**
* g_dbus_connection_set_exit_on_close: * g_dbus_connection_set_exit_on_close:
* @connection: A #GDBusConnection. * @connection: a #GDBusConnection
* @exit_on_close: Whether the process should be terminated * @exit_on_close: whether the process should be terminated
* when @connection is closed by the remote peer. * when @connection is closed by the remote peer
* *
* Sets whether the process should be terminated when @connection is * Sets whether the process should be terminated when @connection is
* closed by the remote peer. See #GDBusConnection:exit-on-close for * closed by the remote peer. See #GDBusConnection:exit-on-close for
@@ -3017,14 +3019,14 @@ g_dbus_connection_set_exit_on_close (GDBusConnection *connection,
/** /**
* g_dbus_connection_get_exit_on_close: * g_dbus_connection_get_exit_on_close:
* @connection: A #GDBusConnection. * @connection: a #GDBusConnection
* *
* Gets whether the process is terminated when @connection is * Gets whether the process is terminated when @connection is
* closed by the remote peer. See * closed by the remote peer. See
* #GDBusConnection:exit-on-close for more details. * #GDBusConnection:exit-on-close for more details.
* *
* Returns: Whether the process is terminated when @connection is * Returns: whether the process is terminated when @connection is
* closed by the remote peer. * closed by the remote peer
* *
* Since: 2.26 * Since: 2.26
*/ */
@@ -3041,7 +3043,7 @@ g_dbus_connection_get_exit_on_close (GDBusConnection *connection)
/** /**
* g_dbus_connection_get_guid: * g_dbus_connection_get_guid:
* @connection: A #GDBusConnection. * @connection: a #GDBusConnection
* *
* The GUID of the peer performing the role of server when * The GUID of the peer performing the role of server when
* authenticating. See #GDBusConnection:guid for more details. * authenticating. See #GDBusConnection:guid for more details.
@@ -3060,13 +3062,13 @@ g_dbus_connection_get_guid (GDBusConnection *connection)
/** /**
* g_dbus_connection_get_unique_name: * g_dbus_connection_get_unique_name:
* @connection: A #GDBusConnection. * @connection: a #GDBusConnection
* *
* Gets the unique name of @connection as assigned by the message * Gets the unique name of @connection as assigned by the message
* bus. This can also be used to figure out if @connection is a * bus. This can also be used to figure out if @connection is a
* message bus connection. * message bus connection.
* *
* Returns: The unique name or %NULL if @connection is not a message * Returns: the unique name or %NULL if @connection is not a message
* bus connection. Do not free this string, it is owned by * bus connection. Do not free this string, it is owned by
* @connection. * @connection.
* *
@@ -3086,7 +3088,7 @@ g_dbus_connection_get_unique_name (GDBusConnection *connection)
/** /**
* g_dbus_connection_get_peer_credentials: * g_dbus_connection_get_peer_credentials:
* @connection: A #GDBusConnection. * @connection: a #GDBusConnection
* *
* Gets the credentials of the authenticated peer. This will always * Gets the credentials of the authenticated peer. This will always
* return %NULL unless @connection acted as a server * return %NULL unless @connection acted as a server
@@ -3098,8 +3100,8 @@ g_dbus_connection_get_unique_name (GDBusConnection *connection)
* each application is a client. So this method will always return * each application is a client. So this method will always return
* %NULL for message bus clients. * %NULL for message bus clients.
* *
* Returns: (transfer none): A #GCredentials or %NULL if not available. Do not free * Returns: (transfer none): a #GCredentials or %NULL if not available.
* this object, it is owned by @connection. * Do not free this object, it is owned by @connection.
* *
* Since: 2.26 * Since: 2.26
*/ */
@@ -3121,11 +3123,11 @@ static guint _global_filter_id = 1;
/** /**
* g_dbus_connection_add_filter: * g_dbus_connection_add_filter:
* @connection: A #GDBusConnection. * @connection: a #GDBusConnection
* @filter_function: A filter function. * @filter_function: a filter function
* @user_data: User data to pass to @filter_function. * @user_data: user data to pass to @filter_function
* @user_data_free_func: Function to free @user_data with when filter * @user_data_free_func: function to free @user_data with when filter
* is removed or %NULL. * is removed or %NULL
* *
* Adds a message filter. Filters are handlers that are run on all * Adds a message filter. Filters are handlers that are run on all
* incoming and outgoing messages, prior to standard dispatch. Filters * incoming and outgoing messages, prior to standard dispatch. Filters
@@ -3148,8 +3150,8 @@ static guint _global_filter_id = 1;
* message. Similary, if a filter consumes an outgoing message, the * message. Similary, if a filter consumes an outgoing message, the
* message will not be sent to the other peer. * message will not be sent to the other peer.
* *
* Returns: A filter identifier that can be used with * Returns: a filter identifier that can be used with
* g_dbus_connection_remove_filter(). * g_dbus_connection_remove_filter()
* *
* Since: 2.26 * Since: 2.26
*/ */
@@ -3397,24 +3399,26 @@ is_signal_data_for_name_lost_or_acquired (SignalData *signal_data)
/** /**
* g_dbus_connection_signal_subscribe: * g_dbus_connection_signal_subscribe:
* @connection: A #GDBusConnection. * @connection: a #GDBusConnection
* @sender: (allow-none): Sender name to match on (unique or well-known name) * @sender: (allow-none): sender name to match on (unique or well-known name)
* or %NULL to listen from all senders. * or %NULL to listen from all senders
* @interface_name: (allow-none): D-Bus interface name to match on or %NULL to * @interface_name: (allow-none): D-Bus interface name to match on or %NULL to
* match on all interfaces. * match on all interfaces
* @member: (allow-none): D-Bus signal name to match on or %NULL to match on all signals. * @member: (allow-none): D-Bus signal name to match on or %NULL to match on
* @object_path: (allow-none): Object path to match on or %NULL to match on all object paths. * all signals
* @arg0: (allow-none): Contents of first string argument to match on or %NULL * @object_path: (allow-none): object path to match on or %NULL to match on
* to match on all kinds of arguments. * all object paths
* @flags: Flags describing how to subscribe to the signal (currently unused). * @arg0: (allow-none): contents of first string argument to match on or %NULL
* @callback: Callback to invoke when there is a signal matching the requested data. * to match on all kinds of arguments
* @user_data: User data to pass to @callback. * @flags: flags describing how to subscribe to the signal (currently unused)
* @user_data_free_func: (allow-none): Function to free @user_data with when * @callback: callback to invoke when there is a signal matching the requested data
* subscription is removed or %NULL. * @user_data: user data to pass to @callback
* @user_data_free_func: (allow-none): function to free @user_data with when
* subscription is removed or %NULL
* *
* Subscribes to signals on @connection and invokes @callback with a * Subscribes to signals on @connection and invokes @callback with a
* whenever the signal is received. Note that @callback * whenever the signal is received. Note that @callback will be invoked
* will be invoked in the <link * in the <link
* linkend="g-main-context-push-thread-default">thread-default main * linkend="g-main-context-push-thread-default">thread-default main
* loop</link> of the thread you are calling this method from. * loop</link> of the thread you are calling this method from.
* *
@@ -3433,7 +3437,7 @@ is_signal_data_for_name_lost_or_acquired (SignalData *signal_data)
* interpreted as part of a namespace or path. The first argument * interpreted as part of a namespace or path. The first argument
* of a signal is matched against that part as specified by D-Bus. * of a signal is matched against that part as specified by D-Bus.
* *
* Returns: A subscription identifier that can be used with g_dbus_connection_signal_unsubscribe(). * Returns: a subscription identifier that can be used with g_dbus_connection_signal_unsubscribe()
* *
* Since: 2.26 * Since: 2.26
*/ */
@@ -3633,8 +3637,9 @@ unsubscribe_id_internal (GDBusConnection *connection,
/** /**
* g_dbus_connection_signal_unsubscribe: * g_dbus_connection_signal_unsubscribe:
* @connection: A #GDBusConnection. * @connection: a #GDBusConnection
* @subscription_id: A subscription id obtained from g_dbus_connection_signal_subscribe(). * @subscription_id: a subscription id obtained from
* g_dbus_connection_signal_subscribe()
* *
* Unsubscribes from signals. * Unsubscribes from signals.
* *
@@ -5075,13 +5080,13 @@ obj_message_func (GDBusConnection *connection,
/** /**
* g_dbus_connection_register_object: * g_dbus_connection_register_object:
* @connection: A #GDBusConnection. * @connection: a #GDBusConnection
* @object_path: The object path to register at. * @object_path: the object path to register at
* @interface_info: Introspection data for the interface. * @interface_info: introspection data for the interface
* @vtable: (allow-none): A #GDBusInterfaceVTable to call into or %NULL. * @vtable: (allow-none): a #GDBusInterfaceVTable to call into or %NULL
* @user_data: (allow-none): Data to pass to functions in @vtable. * @user_data: (allow-none): data to pass to functions in @vtable
* @user_data_free_func: Function to call when the object path is unregistered. * @user_data_free_func: function to call when the object path is unregistered
* @error: Return location for error or %NULL. * @error: return location for error or %NULL
* *
* Registers callbacks for exported objects at @object_path with the * Registers callbacks for exported objects at @object_path with the
* D-Bus interface that is described in @interface_info. * D-Bus interface that is described in @interface_info.
@@ -5122,7 +5127,7 @@ obj_message_func (GDBusConnection *connection,
* See <xref linkend="gdbus-server"/> for an example of how to use this method. * See <xref linkend="gdbus-server"/> for an example of how to use this method.
* *
* Returns: 0 if @error is set, otherwise a registration id (never 0) * Returns: 0 if @error is set, otherwise a registration id (never 0)
* that can be used with g_dbus_connection_unregister_object() . * that can be used with g_dbus_connection_unregister_object()
* *
* Since: 2.26 * Since: 2.26
*/ */
@@ -5203,12 +5208,13 @@ g_dbus_connection_register_object (GDBusConnection *connection,
/** /**
* g_dbus_connection_unregister_object: * g_dbus_connection_unregister_object:
* @connection: A #GDBusConnection. * @connection: a #GDBusConnection
* @registration_id: A registration id obtained from g_dbus_connection_register_object(). * @registration_id: a registration id obtained from
* g_dbus_connection_register_object()
* *
* Unregisters an object. * Unregisters an object.
* *
* Returns: %TRUE if the object was unregistered, %FALSE otherwise. * Returns: %TRUE if the object was unregistered, %FALSE otherwise
* *
* Since: 2.26 * Since: 2.26
*/ */
@@ -5253,15 +5259,15 @@ g_dbus_connection_unregister_object (GDBusConnection *connection,
/** /**
* g_dbus_connection_emit_signal: * g_dbus_connection_emit_signal:
* @connection: A #GDBusConnection. * @connection: a #GDBusConnection
* @destination_bus_name: (allow-none): The unique bus name for the destination * @destination_bus_name: (allow-none): the unique bus name for the destination
* for the signal or %NULL to emit to all listeners. * for the signal or %NULL to emit to all listeners
* @object_path: Path of remote object. * @object_path: path of remote object
* @interface_name: D-Bus interface to emit a signal on. * @interface_name: D-Bus interface to emit a signal on
* @signal_name: The name of the signal to emit. * @signal_name: the name of the signal to emit
* @parameters: (allow-none): A #GVariant tuple with parameters for the signal * @parameters: (allow-none): a #GVariant tuple with parameters for the signal
* or %NULL if not passing parameters. * or %NULL if not passing parameters
* @error: Return location for error or %NULL. * @error: Return location for error or %NULL
* *
* Emits a signal. * Emits a signal.
* *
@@ -5269,7 +5275,7 @@ g_dbus_connection_unregister_object (GDBusConnection *connection,
* *
* This can only fail if @parameters is not compatible with the D-Bus protocol. * This can only fail if @parameters is not compatible with the D-Bus protocol.
* *
* Returns: %TRUE unless @error is set. * Returns: %TRUE unless @error is set
* *
* Since: 2.26 * Since: 2.26
*/ */
@@ -5754,23 +5760,23 @@ g_dbus_connection_call_sync_internal (GDBusConnection *connection,
/** /**
* g_dbus_connection_call: * g_dbus_connection_call:
* @connection: A #GDBusConnection. * @connection: a #GDBusConnection
* @bus_name: (allow-none): A unique or well-known bus name or %NULL if * @bus_name: (allow-none): a unique or well-known bus name or %NULL if
* @connection is not a message bus connection. * @connection is not a message bus connection
* @object_path: Path of remote object. * @object_path: path of remote object
* @interface_name: D-Bus interface to invoke method on. * @interface_name: D-Bus interface to invoke method on
* @method_name: The name of the method to invoke. * @method_name: the name of the method to invoke
* @parameters: (allow-none): A #GVariant tuple with parameters for the method * @parameters: (allow-none): a #GVariant tuple with parameters for the method
* or %NULL if not passing parameters. * or %NULL if not passing parameters
* @reply_type: (allow-none): The expected type of the reply, or %NULL. * @reply_type: (allow-none): the expected type of the reply, or %NULL
* @flags: Flags from the #GDBusCallFlags enumeration. * @flags: flags from the #GDBusCallFlags enumeration
* @timeout_msec: The timeout in milliseconds, -1 to use the default * @timeout_msec: the timeout in milliseconds, -1 to use the default
* timeout or %G_MAXINT for no timeout. * timeout or %G_MAXINT for no timeout
* @cancellable: (allow-none): A #GCancellable or %NULL. * @cancellable: (allow-none): a #GCancellable or %NULL
* @callback: (allow-none): A #GAsyncReadyCallback to call when the request is * @callback: (allow-none): a #GAsyncReadyCallback to call when the request
* satisfied or %NULL if you don't care about the result of the * is satisfied or %NULL if you don't care about the result of the
* method invocation. * method invocation
* @user_data: The data to pass to @callback. * @user_data: the data to pass to @callback
* *
* Asynchronously invokes the @method_name method on the * Asynchronously invokes the @method_name method on the
* @interface_name D-Bus interface on the remote object at * @interface_name D-Bus interface on the remote object at
@@ -5836,9 +5842,9 @@ g_dbus_connection_call (GDBusConnection *connection,
/** /**
* g_dbus_connection_call_finish: * g_dbus_connection_call_finish:
* @connection: A #GDBusConnection. * @connection: a #GDBusConnection
* @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_call(). * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_call()
* @error: Return location for error or %NULL. * @error: return location for error or %NULL
* *
* Finishes an operation started with g_dbus_connection_call(). * Finishes an operation started with g_dbus_connection_call().
* *
@@ -5857,20 +5863,20 @@ g_dbus_connection_call_finish (GDBusConnection *connection,
/** /**
* g_dbus_connection_call_sync: * g_dbus_connection_call_sync:
* @connection: A #GDBusConnection. * @connection: a #GDBusConnection
* @bus_name: (allow-none): A unique or well-known bus name or %NULL if * @bus_name: (allow-none): a unique or well-known bus name or %NULL if
* @connection is not a message bus connection. * @connection is not a message bus connection
* @object_path: Path of remote object. * @object_path: path of remote object
* @interface_name: D-Bus interface to invoke method on. * @interface_name: D-Bus interface to invoke method on
* @method_name: The name of the method to invoke. * @method_name: the name of the method to invoke
* @parameters: (allow-none): A #GVariant tuple with parameters for the method * @parameters: (allow-none): a #GVariant tuple with parameters for the method
* or %NULL if not passing parameters. * or %NULL if not passing parameters
* @reply_type: (allow-none): The expected type of the reply, or %NULL. * @reply_type: (allow-none): the expected type of the reply, or %NULL
* @flags: Flags from the #GDBusCallFlags enumeration. * @flags: flags from the #GDBusCallFlags enumeration
* @timeout_msec: The timeout in milliseconds, -1 to use the default * @timeout_msec: the timeout in milliseconds, -1 to use the default
* timeout or %G_MAXINT for no timeout. * timeout or %G_MAXINT for no timeout
* @cancellable: (allow-none): A #GCancellable or %NULL. * @cancellable: (allow-none): a #GCancellable or %NULL
* @error: Return location for error or %NULL. * @error: return location for error or %NULL
* *
* Synchronously invokes the @method_name method on the * Synchronously invokes the @method_name method on the
* @interface_name D-Bus interface on the remote object at * @interface_name D-Bus interface on the remote object at
@@ -5936,23 +5942,23 @@ g_dbus_connection_call_sync (GDBusConnection *connection,
/** /**
* g_dbus_connection_call_with_unix_fd_list: * g_dbus_connection_call_with_unix_fd_list:
* @connection: A #GDBusConnection. * @connection: a #GDBusConnection
* @bus_name: (allow-none): A unique or well-known bus name or %NULL if * @bus_name: (allow-none): a unique or well-known bus name or %NULL if
* @connection is not a message bus connection. * @connection is not a message bus connection
* @object_path: Path of remote object. * @object_path: path of remote object
* @interface_name: D-Bus interface to invoke method on. * @interface_name: D-Bus interface to invoke method on
* @method_name: The name of the method to invoke. * @method_name: the name of the method to invoke
* @parameters: (allow-none): A #GVariant tuple with parameters for the method * @parameters: (allow-none): a #GVariant tuple with parameters for the method
* or %NULL if not passing parameters. * or %NULL if not passing parameters
* @reply_type: (allow-none): The expected type of the reply, or %NULL. * @reply_type: (allow-none): the expected type of the reply, or %NULL
* @flags: Flags from the #GDBusCallFlags enumeration. * @flags: flags from the #GDBusCallFlags enumeration
* @timeout_msec: The timeout in milliseconds, -1 to use the default * @timeout_msec: the timeout in milliseconds, -1 to use the default
* timeout or %G_MAXINT for no timeout. * timeout or %G_MAXINT for no timeout
* @fd_list: (allow-none): A #GUnixFDList or %NULL. * @fd_list: (allow-none): a #GUnixFDList or %NULL
* @cancellable: (allow-none): A #GCancellable or %NULL. * @cancellable: (allow-none): a #GCancellable or %NULL
* @callback: (allow-none): A #GAsyncReadyCallback to call when the request is * @callback: (allow-none): a #GAsyncReadyCallback to call when the request is
* satisfied or %NULL if you don't * care about the result of the * satisfied or %NULL if you don't * care about the result of the
* method invocation. * method invocation
* @user_data: The data to pass to @callback. * @user_data: The data to pass to @callback.
* *
* Like g_dbus_connection_call() but also takes a #GUnixFDList object. * Like g_dbus_connection_call() but also takes a #GUnixFDList object.
@@ -5981,10 +5987,11 @@ g_dbus_connection_call_with_unix_fd_list (GDBusConnection *connection,
/** /**
* g_dbus_connection_call_with_unix_fd_list_finish: * g_dbus_connection_call_with_unix_fd_list_finish:
* @connection: A #GDBusConnection. * @connection: a #GDBusConnection
* @out_fd_list: (out) (allow-none): Return location for a #GUnixFDList or %NULL. * @out_fd_list: (out) (allow-none): return location for a #GUnixFDList or %NULL
* @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_call_with_unix_fd_list(). * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* @error: Return location for error or %NULL. * g_dbus_connection_call_with_unix_fd_list()
* @error: return location for error or %NULL
* *
* Finishes an operation started with g_dbus_connection_call_with_unix_fd_list(). * Finishes an operation started with g_dbus_connection_call_with_unix_fd_list().
* *
@@ -6004,22 +6011,22 @@ g_dbus_connection_call_with_unix_fd_list_finish (GDBusConnection *connection,
/** /**
* g_dbus_connection_call_with_unix_fd_list_sync: * g_dbus_connection_call_with_unix_fd_list_sync:
* @connection: A #GDBusConnection. * @connection: a #GDBusConnection
* @bus_name: (allow-none): A unique or well-known bus name or %NULL if * @bus_name: (allow-none): a unique or well-known bus name or %NULL
* @connection is not a message bus connection. * if @connection is not a message bus connection
* @object_path: Path of remote object. * @object_path: path of remote object
* @interface_name: D-Bus interface to invoke method on. * @interface_name: D-Bus interface to invoke method on
* @method_name: The name of the method to invoke. * @method_name: the name of the method to invoke
* @parameters: (allow-none): A #GVariant tuple with parameters for the method * @parameters: (allow-none): a #GVariant tuple with parameters for
* or %NULL if not passing parameters. * the method or %NULL if not passing parameters
* @reply_type: (allow-none): The expected type of the reply, or %NULL. * @reply_type: (allow-none): the expected type of the reply, or %NULL
* @flags: Flags from the #GDBusCallFlags enumeration. * @flags: flags from the #GDBusCallFlags enumeration
* @timeout_msec: The timeout in milliseconds, -1 to use the default * @timeout_msec: the timeout in milliseconds, -1 to use the default
* timeout or %G_MAXINT for no timeout. * timeout or %G_MAXINT for no timeout
* @fd_list: (allow-none): A #GUnixFDList or %NULL. * @fd_list: (allow-none): a #GUnixFDList or %NULL
* @out_fd_list: (out) (allow-none): Return location for a #GUnixFDList or %NULL. * @out_fd_list: (out) (allow-none): return location for a #GUnixFDList or %NULL
* @cancellable: (allow-none): A #GCancellable or %NULL. * @cancellable: (allow-none): a #GCancellable or %NULL
* @error: Return location for error or %NULL. * @error: return location for error or %NULL
* *
* Like g_dbus_connection_call_sync() but also takes and returns #GUnixFDList objects. * Like g_dbus_connection_call_sync() but also takes and returns #GUnixFDList objects.
* *
@@ -6491,13 +6498,14 @@ subtree_message_func (GDBusConnection *connection,
/** /**
* g_dbus_connection_register_subtree: * g_dbus_connection_register_subtree:
* @connection: A #GDBusConnection. * @connection: a #GDBusConnection
* @object_path: The object path to register the subtree at. * @object_path: the object path to register the subtree at
* @vtable: A #GDBusSubtreeVTable to enumerate, introspect and dispatch nodes in the subtree. * @vtable: a #GDBusSubtreeVTable to enumerate, introspect and
* @flags: Flags used to fine tune the behavior of the subtree. * dispatch nodes in the subtree
* @user_data: Data to pass to functions in @vtable. * @flags: flags used to fine tune the behavior of the subtree
* @user_data_free_func: Function to call when the subtree is unregistered. * @user_data: data to pass to functions in @vtable
* @error: Return location for error or %NULL. * @user_data_free_func: function to call when the subtree is unregistered
* @error: return location for error or %NULL
* *
* Registers a whole subtree of <quote>dynamic</quote> objects. * Registers a whole subtree of <quote>dynamic</quote> objects.
* *
@@ -6600,12 +6608,13 @@ g_dbus_connection_register_subtree (GDBusConnection *connection,
/** /**
* g_dbus_connection_unregister_subtree: * g_dbus_connection_unregister_subtree:
* @connection: A #GDBusConnection. * @connection: a #GDBusConnection
* @registration_id: A subtree registration id obtained from g_dbus_connection_register_subtree(). * @registration_id: a subtree registration id obtained from
* g_dbus_connection_register_subtree()
* *
* Unregisters a subtree. * Unregisters a subtree.
* *
* Returns: %TRUE if the subtree was unregistered, %FALSE otherwise. * Returns: %TRUE if the subtree was unregistered, %FALSE otherwise
* *
* Since: 2.26 * Since: 2.26
*/ */
@@ -6981,9 +6990,9 @@ _g_bus_get_singleton_if_exists (GBusType bus_type)
/** /**
* g_bus_get_sync: * g_bus_get_sync:
* @bus_type: A #GBusType. * @bus_type: a #GBusType
* @cancellable: (allow-none): A #GCancellable or %NULL. * @cancellable: (allow-none): a #GCancellable or %NULL
* @error: Return location for error or %NULL. * @error: return location for error or %NULL
* *
* Synchronously connects to the message bus specified by @bus_type. * Synchronously connects to the message bus specified by @bus_type.
* Note that the returned object may shared with other callers, * Note that the returned object may shared with other callers,
@@ -7002,7 +7011,8 @@ _g_bus_get_singleton_if_exists (GBusType bus_type)
* Note that the returned #GDBusConnection object will (usually) have * Note that the returned #GDBusConnection object will (usually) have
* the #GDBusConnection:exit-on-close property set to %TRUE. * the #GDBusConnection:exit-on-close property set to %TRUE.
* *
* Returns: (transfer full): A #GDBusConnection or %NULL if @error is set. Free with g_object_unref(). * Returns: (transfer full): a #GDBusConnection or %NULL if @error is set.
* Free with g_object_unref().
* *
* Since: 2.26 * Since: 2.26
*/ */
@@ -7058,10 +7068,10 @@ bus_get_async_initable_cb (GObject *source_object,
/** /**
* g_bus_get: * g_bus_get:
* @bus_type: A #GBusType. * @bus_type: a #GBusType
* @cancellable: (allow-none): A #GCancellable or %NULL. * @cancellable: (allow-none): a #GCancellable or %NULL
* @callback: A #GAsyncReadyCallback to call when the request is satisfied. * @callback: a #GAsyncReadyCallback to call when the request is satisfied
* @user_data: The data to pass to @callback. * @user_data: the data to pass to @callback
* *
* Asynchronously connects to the message bus specified by @bus_type. * Asynchronously connects to the message bus specified by @bus_type.
* *
@@ -7110,8 +7120,9 @@ g_bus_get (GBusType bus_type,
/** /**
* g_bus_get_finish: * g_bus_get_finish:
* @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_bus_get(). * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed
* @error: Return location for error or %NULL. * to g_bus_get()
* @error: return location for error or %NULL
* *
* Finishes an operation started with g_bus_get(). * Finishes an operation started with g_bus_get().
* *
@@ -7124,7 +7135,8 @@ g_bus_get (GBusType bus_type,
* Note that the returned #GDBusConnection object will (usually) have * Note that the returned #GDBusConnection object will (usually) have
* the #GDBusConnection:exit-on-close property set to %TRUE. * the #GDBusConnection:exit-on-close property set to %TRUE.
* *
* Returns: (transfer full): A #GDBusConnection or %NULL if @error is set. Free with g_object_unref(). * Returns: (transfer full): a #GDBusConnection or %NULL if @error is set.
* Free with g_object_unref().
* *
* Since: 2.26 * Since: 2.26
*/ */