Add "Since: 2.26" to all new GDBus API

This commit is contained in:
David Zeuthen 2010-05-06 16:02:08 -04:00
parent c490c14f4e
commit 0fd6498cd8
31 changed files with 611 additions and 27 deletions

View File

@ -135,7 +135,6 @@
<xi:include href="xml/gdbusmessage.xml"/> <xi:include href="xml/gdbusmessage.xml"/>
<xi:include href="xml/gdbusconnection.xml"/> <xi:include href="xml/gdbusconnection.xml"/>
<xi:include href="xml/gdbusmethodinvocation.xml"/> <xi:include href="xml/gdbusmethodinvocation.xml"/>
<xi:include href="xml/gdbusproxy.xml"/>
<xi:include href="xml/gdbusserver.xml"/> <xi:include href="xml/gdbusserver.xml"/>
<xi:include href="xml/gdbusauthobserver.xml"/> <xi:include href="xml/gdbusauthobserver.xml"/>
</chapter> </chapter>
@ -144,6 +143,7 @@
<xi:include href="xml/gdbusnameowning.xml"/> <xi:include href="xml/gdbusnameowning.xml"/>
<xi:include href="xml/gdbusnamewatching.xml"/> <xi:include href="xml/gdbusnamewatching.xml"/>
<xi:include href="xml/gdbusproxywatching.xml"/> <xi:include href="xml/gdbusproxywatching.xml"/>
<xi:include href="xml/gdbusproxy.xml"/>
</chapter> </chapter>
<chapter id="utils"> <chapter id="utils">
<title>Utilities</title> <title>Utilities</title>

View File

@ -100,6 +100,8 @@ g_credentials_init (GCredentials *credentials)
* Creates a new empty credentials object. * Creates a new empty credentials object.
* *
* Returns: A #GCredentials. Free with g_object_unref(). * Returns: A #GCredentials. Free with g_object_unref().
*
* Since: 2.26
*/ */
GCredentials * GCredentials *
g_credentials_new (void) g_credentials_new (void)
@ -132,6 +134,8 @@ g_credentials_new_for_unix_process (void)
* platform. * platform.
* *
* Returns: A #GCredentials. Free with g_object_unref(). * Returns: A #GCredentials. Free with g_object_unref().
*
* Since: 2.26
*/ */
GCredentials * GCredentials *
g_credentials_new_for_process (void) g_credentials_new_for_process (void)
@ -157,6 +161,8 @@ g_credentials_new_for_process (void)
* *
* Returns: A #GCredentials or %NULL if @error is set. The return * Returns: A #GCredentials or %NULL if @error is set. The return
* object must be freed with g_object_unref(). * object must be freed with g_object_unref().
*
* Since: 2.26
*/ */
GCredentials * GCredentials *
g_credentials_new_for_string (const gchar *str, g_credentials_new_for_string (const gchar *str,
@ -212,6 +218,8 @@ g_credentials_new_for_string (const gchar *str,
* g_credentials_new_for_string(). * g_credentials_new_for_string().
* *
* Returns: A string that should be freed with g_free(). * Returns: A string that should be freed with g_free().
*
* Since: 2.26
*/ */
gchar * gchar *
g_credentials_to_string (GCredentials *credentials) g_credentials_to_string (GCredentials *credentials)
@ -244,6 +252,8 @@ g_credentials_to_string (GCredentials *credentials)
* Checks if @credentials has a UNIX user credential. * Checks if @credentials has a UNIX user credential.
* *
* Returns: %TRUE if @credentials has this type of credential, %FALSE otherwise. * Returns: %TRUE if @credentials has this type of credential, %FALSE otherwise.
*
* Since: 2.26
*/ */
gboolean gboolean
g_credentials_has_unix_user (GCredentials *credentials) g_credentials_has_unix_user (GCredentials *credentials)
@ -259,6 +269,8 @@ g_credentials_has_unix_user (GCredentials *credentials)
* Gets the UNIX user identifier from @credentials. * Gets the UNIX user identifier from @credentials.
* *
* Returns: The identifier or -1 if unset. * Returns: The identifier or -1 if unset.
*
* Since: 2.26
*/ */
gint64 gint64
g_credentials_get_unix_user (GCredentials *credentials) g_credentials_get_unix_user (GCredentials *credentials)
@ -273,6 +285,8 @@ g_credentials_get_unix_user (GCredentials *credentials)
* @user_id: A UNIX user identifier (typically type #uid_t) or -1 to unset it. * @user_id: A UNIX user identifier (typically type #uid_t) or -1 to unset it.
* *
* Sets the UNIX user identifier. * Sets the UNIX user identifier.
*
* Since: 2.26
*/ */
void void
g_credentials_set_unix_user (GCredentials *credentials, g_credentials_set_unix_user (GCredentials *credentials,
@ -291,6 +305,8 @@ g_credentials_set_unix_user (GCredentials *credentials,
* Checks if @credentials has a UNIX group credential. * Checks if @credentials has a UNIX group credential.
* *
* Returns: %TRUE if @credentials has this type of credential, %FALSE otherwise. * Returns: %TRUE if @credentials has this type of credential, %FALSE otherwise.
*
* Since: 2.26
*/ */
gboolean gboolean
g_credentials_has_unix_group (GCredentials *credentials) g_credentials_has_unix_group (GCredentials *credentials)
@ -306,6 +322,8 @@ g_credentials_has_unix_group (GCredentials *credentials)
* Gets the UNIX group identifier from @credentials. * Gets the UNIX group identifier from @credentials.
* *
* Returns: The identifier or -1 if unset. * Returns: The identifier or -1 if unset.
*
* Since: 2.26
*/ */
gint64 gint64
g_credentials_get_unix_group (GCredentials *credentials) g_credentials_get_unix_group (GCredentials *credentials)
@ -320,6 +338,8 @@ g_credentials_get_unix_group (GCredentials *credentials)
* @group_id: A UNIX group identifier (typically type #gid_t) or -1 to unset. * @group_id: A UNIX group identifier (typically type #gid_t) or -1 to unset.
* *
* Sets the UNIX group identifier. * Sets the UNIX group identifier.
*
* Since: 2.26
*/ */
void void
g_credentials_set_unix_group (GCredentials *credentials, g_credentials_set_unix_group (GCredentials *credentials,
@ -338,6 +358,8 @@ g_credentials_set_unix_group (GCredentials *credentials,
* Checks if @credentials has a UNIX process credential. * Checks if @credentials has a UNIX process credential.
* *
* Returns: %TRUE if @credentials has this type of credential, %FALSE otherwise. * Returns: %TRUE if @credentials has this type of credential, %FALSE otherwise.
*
* Since: 2.26
*/ */
gboolean gboolean
g_credentials_has_unix_process (GCredentials *credentials) g_credentials_has_unix_process (GCredentials *credentials)
@ -353,6 +375,8 @@ g_credentials_has_unix_process (GCredentials *credentials)
* Gets the UNIX process identifier from @credentials. * Gets the UNIX process identifier from @credentials.
* *
* Returns: The identifier or -1 if unset. * Returns: The identifier or -1 if unset.
*
* Since: 2.26
*/ */
gint64 gint64
g_credentials_get_unix_process (GCredentials *credentials) g_credentials_get_unix_process (GCredentials *credentials)
@ -367,6 +391,8 @@ g_credentials_get_unix_process (GCredentials *credentials)
* @process_id: A UNIX process identifier (typically type #pid_t/#GPid) or -1 to unset. * @process_id: A UNIX process identifier (typically type #pid_t/#GPid) or -1 to unset.
* *
* Sets the UNIX process identifier. * Sets the UNIX process identifier.
*
* Since: 2.26
*/ */
void void
g_credentials_set_unix_process (GCredentials *credentials, g_credentials_set_unix_process (GCredentials *credentials,
@ -385,6 +411,8 @@ g_credentials_set_unix_process (GCredentials *credentials,
* Checks if @credentials has a Windows user SID (Security Identifier). * Checks if @credentials has a Windows user SID (Security Identifier).
* *
* Returns: %TRUE if @credentials has this type of credential, %FALSE otherwise. * Returns: %TRUE if @credentials has this type of credential, %FALSE otherwise.
*
* Since: 2.26
*/ */
gboolean gboolean
g_credentials_has_windows_user (GCredentials *credentials) g_credentials_has_windows_user (GCredentials *credentials)
@ -400,6 +428,8 @@ g_credentials_has_windows_user (GCredentials *credentials)
* Gets the Windows User SID from @credentials. * Gets the Windows User SID from @credentials.
* *
* Returns: A string or %NULL if unset. Do not free, the string is owned by @credentials. * Returns: A string or %NULL if unset. Do not free, the string is owned by @credentials.
*
* Since: 2.26
*/ */
const gchar * const gchar *
g_credentials_get_windows_user (GCredentials *credentials) g_credentials_get_windows_user (GCredentials *credentials)
@ -414,6 +444,8 @@ g_credentials_get_windows_user (GCredentials *credentials)
* @user_sid: The Windows User SID or %NULL to unset. * @user_sid: The Windows User SID or %NULL to unset.
* *
* Sets the Windows User SID. * Sets the Windows User SID.
*
* Since: 2.26
*/ */
void void
g_credentials_set_windows_user (GCredentials *credentials, g_credentials_set_windows_user (GCredentials *credentials,

View File

@ -42,6 +42,8 @@ typedef struct _GCredentialsPrivate GCredentialsPrivate;
* *
* The #GCredentials structure contains only private data and * The #GCredentials structure contains only private data and
* should only be accessed using the provided API. * should only be accessed using the provided API.
*
* Since: 2.26
*/ */
struct _GCredentials struct _GCredentials
{ {
@ -54,6 +56,8 @@ struct _GCredentials
* GCredentialsClass: * GCredentialsClass:
* *
* Class structure for #GCredentials. * Class structure for #GCredentials.
*
* Since: 2.26
*/ */
struct _GCredentialsClass struct _GCredentialsClass
{ {

View File

@ -58,6 +58,8 @@
* checks. * checks.
* *
* Returns: %TRUE if @string is a valid D-Bus address, %FALSE otherwise. * Returns: %TRUE if @string is a valid D-Bus address, %FALSE otherwise.
*
* Since: 2.26
*/ */
gboolean gboolean
g_dbus_is_address (const gchar *string) g_dbus_is_address (const gchar *string)
@ -335,6 +337,8 @@ is_valid_tcp (const gchar *address_entry,
* *
* 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.
*
* Since: 2.26
*/ */
gboolean gboolean
g_dbus_is_supported_address (const gchar *string, g_dbus_is_supported_address (const gchar *string,
@ -759,6 +763,8 @@ get_stream_thread_func (GSimpleAsyncResult *res,
* *
* This is an asynchronous failable function. See * This is an asynchronous failable function. See
* g_dbus_address_get_stream_sync() for the synchronous version. * g_dbus_address_get_stream_sync() for the synchronous version.
*
* Since: 2.26
*/ */
void void
g_dbus_address_get_stream (const gchar *address, g_dbus_address_get_stream (const gchar *address,
@ -796,6 +802,8 @@ g_dbus_address_get_stream (const gchar *address,
* Finishes an operation started with g_dbus_address_get_stream(). * Finishes an operation started with g_dbus_address_get_stream().
* *
* Returns: A #GIOStream or %NULL if @error is set. * Returns: A #GIOStream or %NULL if @error is set.
*
* Since: 2.26
*/ */
GIOStream * GIOStream *
g_dbus_address_get_stream_finish (GAsyncResult *res, g_dbus_address_get_stream_finish (GAsyncResult *res,
@ -840,6 +848,8 @@ g_dbus_address_get_stream_finish (GAsyncResult *res,
* g_dbus_address_get_stream() for the asynchronous version. * g_dbus_address_get_stream() for the asynchronous version.
* *
* Returns: A #GIOStream or %NULL if @error is set. * Returns: A #GIOStream or %NULL if @error is set.
*
* Since: 2.26
*/ */
GIOStream * GIOStream *
g_dbus_address_get_stream_sync (const gchar *address, g_dbus_address_get_stream_sync (const gchar *address,
@ -918,6 +928,8 @@ get_session_address_platform_specific (void)
* platform specific mechanisms. * platform specific mechanisms.
* *
* Returns: A valid D-Bus address string for @bus_type or %NULL if @error is set. * Returns: A valid D-Bus address string for @bus_type or %NULL if @error is set.
*
* Since: 2.26
*/ */
gchar * gchar *
g_dbus_address_get_for_bus_sync (GBusType bus_type, g_dbus_address_get_for_bus_sync (GBusType bus_type,

View File

@ -146,6 +146,8 @@ g_dbus_auth_observer_class_init (GDBusAuthObserverClass *klass)
* should be denied. * should be denied.
* *
* Returns: %TRUE if the peer should be denied, %FALSE otherwise. * Returns: %TRUE if the peer should be denied, %FALSE otherwise.
*
* Since: 2.26
*/ */
signals[DENY_AUTHENTICATED_PEER_SIGNAL] = signals[DENY_AUTHENTICATED_PEER_SIGNAL] =
g_signal_new ("deny-authenticated-peer", g_signal_new ("deny-authenticated-peer",
@ -179,6 +181,8 @@ g_dbus_auth_observer_init (GDBusAuthObserver *observer)
* Creates a new #GDBusAuthObserver object. * Creates a new #GDBusAuthObserver object.
* *
* Returns: A #GDBusAuthObserver. Free with g_object_unref(). * Returns: A #GDBusAuthObserver. Free with g_object_unref().
*
* Since: 2.26
*/ */
GDBusAuthObserver * GDBusAuthObserver *
g_dbus_auth_observer_new (void) g_dbus_auth_observer_new (void)
@ -197,6 +201,8 @@ g_dbus_auth_observer_new (void)
* Emits the #GDBusAuthObserver::deny-authenticated-peer signal on @observer. * Emits the #GDBusAuthObserver::deny-authenticated-peer signal on @observer.
* *
* Returns: %TRUE if the peer should be denied, %FALSE otherwise. * Returns: %TRUE if the peer should be denied, %FALSE otherwise.
*
* Since: 2.26
*/ */
gboolean gboolean
g_dbus_auth_observer_deny_authenticated_peer (GDBusAuthObserver *observer, g_dbus_auth_observer_deny_authenticated_peer (GDBusAuthObserver *observer,

View File

@ -43,6 +43,8 @@ typedef struct _GDBusAuthObserverPrivate GDBusAuthObserverPrivate;
* @deny_authenticated_peer: Signal class handler for the #GDBusAuthObserver::deny-authenticated-peer signal. * @deny_authenticated_peer: Signal class handler for the #GDBusAuthObserver::deny-authenticated-peer signal.
* *
* Class structure for #GDBusAuthObserverClass. * Class structure for #GDBusAuthObserverClass.
*
* Since: 2.26
*/ */
struct _GDBusAuthObserverClass struct _GDBusAuthObserverClass
{ {
@ -82,6 +84,8 @@ struct _GDBusAuthObserverClass
* *
* The #GDBusAuthObserver structure contains only private data and * The #GDBusAuthObserver structure contains only private data and
* should only be accessed using the provided API. * should only be accessed using the provided API.
*
* Since: 2.26
*/ */
struct _GDBusAuthObserver struct _GDBusAuthObserver
{ {

View File

@ -483,6 +483,8 @@ g_dbus_connection_class_init (GDBusConnectionClass *klass)
* GDBusConnection:stream: * GDBusConnection:stream:
* *
* The underlying #GIOStream used for I/O. * The underlying #GIOStream used for I/O.
*
* Since: 2.26
*/ */
g_object_class_install_property (gobject_class, g_object_class_install_property (gobject_class,
PROP_STREAM, PROP_STREAM,
@ -502,6 +504,8 @@ g_dbus_connection_class_init (GDBusConnectionClass *klass)
* *
* A D-Bus address specifying potential endpoints that can be used * A D-Bus address specifying potential endpoints that can be used
* when establishing the connection. * when establishing the connection.
*
* Since: 2.26
*/ */
g_object_class_install_property (gobject_class, g_object_class_install_property (gobject_class,
PROP_ADDRESS, PROP_ADDRESS,
@ -519,6 +523,8 @@ g_dbus_connection_class_init (GDBusConnectionClass *klass)
* GDBusConnection:flags: * GDBusConnection:flags:
* *
* Flags from the #GDBusConnectionFlags enumeration. * Flags from the #GDBusConnectionFlags enumeration.
*
* Since: 2.26
*/ */
g_object_class_install_property (gobject_class, g_object_class_install_property (gobject_class,
PROP_FLAGS, PROP_FLAGS,
@ -549,6 +555,8 @@ g_dbus_connection_class_init (GDBusConnectionClass *klass)
* #GDBusConnection:flags property you will be able to read the GUID * #GDBusConnection:flags property you will be able to read the GUID
* of the other peer here after the connection has been succesfully * of the other peer here after the connection has been succesfully
* initialized. * initialized.
*
* Since: 2.26
*/ */
g_object_class_install_property (gobject_class, g_object_class_install_property (gobject_class,
PROP_GUID, PROP_GUID,
@ -568,6 +576,8 @@ g_dbus_connection_class_init (GDBusConnectionClass *klass)
* *
* The unique name as assigned by the message bus or %NULL if the * The unique name as assigned by the message bus or %NULL if the
* connection is not open or not a message bus connection. * connection is not open or not a message bus connection.
*
* Since: 2.26
*/ */
g_object_class_install_property (gobject_class, g_object_class_install_property (gobject_class,
PROP_UNIQUE_NAME, PROP_UNIQUE_NAME,
@ -584,6 +594,8 @@ g_dbus_connection_class_init (GDBusConnectionClass *klass)
* GDBusConnection:closed: * GDBusConnection:closed:
* *
* A boolean specifying whether the connection has been closed. * A boolean specifying whether the connection has been closed.
*
* Since: 2.26
*/ */
g_object_class_install_property (gobject_class, g_object_class_install_property (gobject_class,
PROP_CLOSED, PROP_CLOSED,
@ -602,6 +614,8 @@ g_dbus_connection_class_init (GDBusConnectionClass *klass)
* A boolean specifying whether the process will be terminated (by * A boolean specifying whether the process will be terminated (by
* calling <literal>raise(SIGTERM)</literal>) if the connection * calling <literal>raise(SIGTERM)</literal>) if the connection
* is closed by the remote peer. * is closed by the remote peer.
*
* Since: 2.26
*/ */
g_object_class_install_property (gobject_class, g_object_class_install_property (gobject_class,
PROP_EXIT_ON_CLOSE, PROP_EXIT_ON_CLOSE,
@ -620,6 +634,8 @@ g_dbus_connection_class_init (GDBusConnectionClass *klass)
* *
* Flags from the #GDBusCapabilityFlags enumeration * Flags from the #GDBusCapabilityFlags enumeration
* representing connection features negotiated with the other peer. * representing connection features negotiated with the other peer.
*
* Since: 2.26
*/ */
g_object_class_install_property (gobject_class, g_object_class_install_property (gobject_class,
PROP_CAPABILITY_FLAGS, PROP_CAPABILITY_FLAGS,
@ -637,6 +653,8 @@ g_dbus_connection_class_init (GDBusConnectionClass *klass)
* GDBusConnection:authentication-observer: * GDBusConnection:authentication-observer:
* *
* A #GDBusAuthObserver object to assist in the authentication process or %NULL. * A #GDBusAuthObserver object to assist in the authentication process or %NULL.
*
* Since: 2.26
*/ */
g_object_class_install_property (gobject_class, g_object_class_install_property (gobject_class,
PROP_AUTHENTICATION_OBSERVER, PROP_AUTHENTICATION_OBSERVER,
@ -679,6 +697,8 @@ g_dbus_connection_class_init (GDBusConnectionClass *klass)
* 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
* once. * once.
*
* Since: 2.26
*/ */
signals[CLOSED_SIGNAL] = g_signal_new ("closed", signals[CLOSED_SIGNAL] = g_signal_new ("closed",
G_TYPE_DBUS_CONNECTION, G_TYPE_DBUS_CONNECTION,
@ -750,7 +770,9 @@ g_dbus_connection_get_stream (GDBusConnection *connection)
* 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
*/
gboolean gboolean
g_dbus_connection_is_closed (GDBusConnection *connection) g_dbus_connection_is_closed (GDBusConnection *connection)
{ {
@ -765,6 +787,8 @@ g_dbus_connection_is_closed (GDBusConnection *connection)
* Gets the capabilities negotiated with the remote peer * Gets the capabilities negotiated with the remote peer
* *
* Returns: One or more flags from the #GDBusCapabilityFlags enumeration. * Returns: One or more flags from the #GDBusCapabilityFlags enumeration.
*
* Since: 2.26
*/ */
GDBusCapabilityFlags GDBusCapabilityFlags
g_dbus_connection_get_capabilities (GDBusConnection *connection) g_dbus_connection_get_capabilities (GDBusConnection *connection)
@ -849,6 +873,8 @@ set_closed_unlocked (GDBusConnection *connection,
* bus connection disconnects). * bus connection disconnects).
* *
* If @connection is already closed, this method does nothing. * If @connection is already closed, this method does nothing.
*
* Since: 2.26
*/ */
void void
g_dbus_connection_close (GDBusConnection *connection) g_dbus_connection_close (GDBusConnection *connection)
@ -983,6 +1009,8 @@ g_dbus_connection_send_message_unlocked (GDBusConnection *connection,
* *
* 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
*/ */
gboolean gboolean
g_dbus_connection_send_message (GDBusConnection *connection, g_dbus_connection_send_message (GDBusConnection *connection,
@ -1297,6 +1325,8 @@ g_dbus_connection_send_message_with_reply_unlocked (GDBusConnection *connect
* See <xref linkend="gdbus-server"/> and <xref * See <xref linkend="gdbus-server"/> and <xref
* 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.
*
* Since: 2.26
*/ */
void void
g_dbus_connection_send_message_with_reply (GDBusConnection *connection, g_dbus_connection_send_message_with_reply (GDBusConnection *connection,
@ -1339,6 +1369,8 @@ g_dbus_connection_send_message_with_reply (GDBusConnection *connection,
* low-level API to send and receive UNIX file descriptors. * low-level API to send and receive UNIX file descriptors.
* *
* Returns: A #GDBusMessage or %NULL if @error is set. * Returns: A #GDBusMessage or %NULL if @error is set.
*
* Since: 2.26
*/ */
GDBusMessage * GDBusMessage *
g_dbus_connection_send_message_with_reply_finish (GDBusConnection *connection, g_dbus_connection_send_message_with_reply_finish (GDBusConnection *connection,
@ -1426,6 +1458,8 @@ send_message_with_reply_sync_cb (GDBusConnection *connection,
* low-level API to send and receive UNIX file descriptors. * low-level API to send and receive UNIX file descriptors.
* *
* Returns: A #GDBusMessage that is the reply to @message or %NULL if @error is set. * Returns: A #GDBusMessage that is the reply to @message or %NULL if @error is set.
*
* Since: 2.26
*/ */
GDBusMessage * GDBusMessage *
g_dbus_connection_send_message_with_reply_sync (GDBusConnection *connection, g_dbus_connection_send_message_with_reply_sync (GDBusConnection *connection,
@ -1856,6 +1890,8 @@ async_initable_iface_init (GAsyncInitableIface *async_initable_iface)
* This is a asynchronous failable constructor. See * This is a asynchronous failable constructor. See
* g_dbus_connection_new_sync() for the synchronous * g_dbus_connection_new_sync() for the synchronous
* version. * version.
*
* Since: 2.26
*/ */
void void
g_dbus_connection_new (GIOStream *stream, g_dbus_connection_new (GIOStream *stream,
@ -1887,6 +1923,8 @@ g_dbus_connection_new (GIOStream *stream,
* 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
*/ */
GDBusConnection * GDBusConnection *
g_dbus_connection_new_finish (GAsyncResult *res, g_dbus_connection_new_finish (GAsyncResult *res,
@ -1930,6 +1968,8 @@ g_dbus_connection_new_finish (GAsyncResult *res,
* 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
*/ */
GDBusConnection * GDBusConnection *
g_dbus_connection_new_sync (GIOStream *stream, g_dbus_connection_new_sync (GIOStream *stream,
@ -1978,6 +2018,8 @@ g_dbus_connection_new_sync (GIOStream *stream,
* This is a asynchronous failable constructor. See * This is a asynchronous failable constructor. See
* g_dbus_connection_new_for_address_sync() for the synchronous * g_dbus_connection_new_for_address_sync() for the synchronous
* version. * version.
*
* Since: 2.26
*/ */
void void
g_dbus_connection_new_for_address (const gchar *address, g_dbus_connection_new_for_address (const gchar *address,
@ -2005,6 +2047,8 @@ g_dbus_connection_new_for_address (const gchar *address,
* 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
*/ */
GDBusConnection * GDBusConnection *
g_dbus_connection_new_for_address_finish (GAsyncResult *res, g_dbus_connection_new_for_address_finish (GAsyncResult *res,
@ -2049,6 +2093,8 @@ g_dbus_connection_new_for_address_finish (GAsyncResult *res,
* g_dbus_connection_new_for_address() for the asynchronous version. * g_dbus_connection_new_for_address() 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
*/ */
GDBusConnection * GDBusConnection *
g_dbus_connection_new_for_address_sync (const gchar *address, g_dbus_connection_new_for_address_sync (const gchar *address,
@ -2077,6 +2123,8 @@ g_dbus_connection_new_for_address_sync (const gchar *address,
* 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
* more details. * more details.
*
* Since: 2.26
*/ */
void void
g_dbus_connection_set_exit_on_close (GDBusConnection *connection, g_dbus_connection_set_exit_on_close (GDBusConnection *connection,
@ -2096,6 +2144,8 @@ g_dbus_connection_set_exit_on_close (GDBusConnection *connection,
* *
* 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
*/ */
gboolean gboolean
g_dbus_connection_get_exit_on_close (GDBusConnection *connection) g_dbus_connection_get_exit_on_close (GDBusConnection *connection)
@ -2113,7 +2163,9 @@ g_dbus_connection_get_exit_on_close (GDBusConnection *connection)
* *
* Returns: The GUID. Do not free this string, it is owned by * Returns: The GUID. Do not free this string, it is owned by
* @connection. * @connection.
**/ *
* Since: 2.26
*/
const gchar * const gchar *
g_dbus_connection_get_guid (GDBusConnection *connection) g_dbus_connection_get_guid (GDBusConnection *connection)
{ {
@ -2132,7 +2184,9 @@ g_dbus_connection_get_guid (GDBusConnection *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.
**/ *
* Since: 2.26
*/
const gchar * const gchar *
g_dbus_connection_get_unique_name (GDBusConnection *connection) g_dbus_connection_get_unique_name (GDBusConnection *connection)
{ {
@ -2156,6 +2210,8 @@ g_dbus_connection_get_unique_name (GDBusConnection *connection)
* *
* Returns: A #GCredentials or %NULL if not available. Do not free * Returns: A #GCredentials or %NULL if not available. Do not free
* this object, it is owned by @connection. * this object, it is owned by @connection.
*
* Since: 2.26
*/ */
GCredentials * GCredentials *
g_dbus_connection_get_peer_credentials (GDBusConnection *connection) g_dbus_connection_get_peer_credentials (GDBusConnection *connection)
@ -2192,6 +2248,8 @@ static guint _global_filter_id = 1;
* *
* 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
*/ */
guint guint
g_dbus_connection_add_filter (GDBusConnection *connection, g_dbus_connection_add_filter (GDBusConnection *connection,
@ -2427,7 +2485,9 @@ is_signal_data_for_name_lost_or_acquired (SignalData *signal_data)
* call g_dbus_connection_signal_unsubscribe() to remove a subscription. * call g_dbus_connection_signal_unsubscribe() to remove a subscription.
* *
* 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
*/
guint guint
g_dbus_connection_signal_subscribe (GDBusConnection *connection, g_dbus_connection_signal_subscribe (GDBusConnection *connection,
const gchar *sender, const gchar *sender,
@ -2607,7 +2667,9 @@ unsubscribe_id_internal (GDBusConnection *connection,
* @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.
**/ *
* Since: 2.26
*/
void void
g_dbus_connection_signal_unsubscribe (GDBusConnection *connection, g_dbus_connection_signal_unsubscribe (GDBusConnection *connection,
guint subscription_id) guint subscription_id)
@ -3803,6 +3865,8 @@ obj_message_func (GDBusConnection *connection,
* *
* 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
*/ */
guint guint
g_dbus_connection_register_object (GDBusConnection *connection, g_dbus_connection_register_object (GDBusConnection *connection,
@ -3889,6 +3953,8 @@ g_dbus_connection_register_object (GDBusConnection *connection,
* 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
*/ */
gboolean gboolean
g_dbus_connection_unregister_object (GDBusConnection *connection, g_dbus_connection_unregister_object (GDBusConnection *connection,
@ -3947,6 +4013,8 @@ 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
*/ */
gboolean gboolean
g_dbus_connection_emit_signal (GDBusConnection *connection, g_dbus_connection_emit_signal (GDBusConnection *connection,
@ -4029,6 +4097,8 @@ add_invoke_method_flags (GDBusMessage *message,
* g_dbus_connection_invoke_method_finish() to get the result of the operation. * g_dbus_connection_invoke_method_finish() to get the result of the operation.
* See g_dbus_connection_invoke_method_sync() for the synchronous version of this * See g_dbus_connection_invoke_method_sync() for the synchronous version of this
* function. * function.
*
* Since: 2.26
*/ */
void void
g_dbus_connection_invoke_method (GDBusConnection *connection, g_dbus_connection_invoke_method (GDBusConnection *connection,
@ -4115,6 +4185,8 @@ decode_method_reply (GDBusMessage *reply, GError **error)
* *
* Returns: %NULL if @error is set. Otherwise a #GVariant tuple with * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
* return values. Free with g_variant_unref(). * return values. Free with g_variant_unref().
*
* Since: 2.26
*/ */
GVariant * GVariant *
g_dbus_connection_invoke_method_finish (GDBusConnection *connection, g_dbus_connection_invoke_method_finish (GDBusConnection *connection,
@ -4173,6 +4245,8 @@ g_dbus_connection_invoke_method_finish (GDBusConnection *connection,
* *
* Returns: %NULL if @error is set. Otherwise a #GVariant tuple with * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
* return values. Free with g_variant_unref(). * return values. Free with g_variant_unref().
*
* Since: 2.26
*/ */
GVariant * GVariant *
g_dbus_connection_invoke_method_sync (GDBusConnection *connection, g_dbus_connection_invoke_method_sync (GDBusConnection *connection,
@ -4695,6 +4769,8 @@ subtree_message_func (GDBusConnection *connection,
* *
* Returns: 0 if @error is set, otherwise a subtree registration id (never 0) * Returns: 0 if @error is set, otherwise a subtree registration id (never 0)
* that can be used with g_dbus_connection_unregister_subtree() . * that can be used with g_dbus_connection_unregister_subtree() .
*
* Since: 2.26
*/ */
guint guint
g_dbus_connection_register_subtree (GDBusConnection *connection, g_dbus_connection_register_subtree (GDBusConnection *connection,
@ -4764,6 +4840,8 @@ g_dbus_connection_register_subtree (GDBusConnection *connection,
* 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
*/ */
gboolean gboolean
g_dbus_connection_unregister_subtree (GDBusConnection *connection, g_dbus_connection_unregister_subtree (GDBusConnection *connection,
@ -5132,6 +5210,8 @@ get_uninitialized_connection (GBusType bus_type,
* the #GDBusConnection:exit-on-close property set to %TRUE. * the #GDBusConnection:exit-on-close property set to %TRUE.
* *
* 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
*/ */
GDBusConnection * GDBusConnection *
g_bus_get_sync (GBusType bus_type, g_bus_get_sync (GBusType bus_type,
@ -5198,6 +5278,8 @@ bus_get_async_initable_cb (GObject *source_object,
* *
* This is a asynchronous failable function. See g_bus_get_sync() for * This is a asynchronous failable function. See g_bus_get_sync() for
* the synchronous version. * the synchronous version.
*
* Since: 2.26
*/ */
void void
g_bus_get (GBusType bus_type, g_bus_get (GBusType bus_type,
@ -5251,6 +5333,8 @@ g_bus_get (GBusType bus_type,
* the #GDBusConnection:exit-on-close property set to %TRUE. * the #GDBusConnection:exit-on-close property set to %TRUE.
* *
* 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
*/ */
GDBusConnection * GDBusConnection *
g_bus_get_finish (GAsyncResult *res, g_bus_get_finish (GAsyncResult *res,

View File

@ -42,6 +42,8 @@ typedef struct _GDBusConnectionPrivate GDBusConnectionPrivate;
* *
* The #GDBusConnection structure contains only private data and * The #GDBusConnection structure contains only private data and
* should only be accessed using the provided API. * should only be accessed using the provided API.
*
* Since: 2.26
*/ */
struct _GDBusConnection struct _GDBusConnection
{ {
@ -55,6 +57,8 @@ struct _GDBusConnection
* @closed: Signal class handler for the #GDBusConnection::closed signal. * @closed: Signal class handler for the #GDBusConnection::closed signal.
* *
* Class structure for #GDBusConnection. * Class structure for #GDBusConnection.
*
* Since: 2.26
*/ */
struct _GDBusConnectionClass struct _GDBusConnectionClass
{ {
@ -207,6 +211,8 @@ GVariant *g_dbus_connection_invoke_method_sync (GDBusConnection
* @user_data: The @user_data #gpointer passed to g_dbus_connection_register_object(). * @user_data: The @user_data #gpointer passed to g_dbus_connection_register_object().
* *
* The type of the @method_call function in #GDBusInterfaceVTable. * The type of the @method_call function in #GDBusInterfaceVTable.
*
* Since: 2.26
*/ */
typedef void (*GDBusInterfaceMethodCallFunc) (GDBusConnection *connection, typedef void (*GDBusInterfaceMethodCallFunc) (GDBusConnection *connection,
const gchar *sender, const gchar *sender,
@ -230,6 +236,8 @@ typedef void (*GDBusInterfaceMethodCallFunc) (GDBusConnection *connection,
* The type of the @get_property function in #GDBusInterfaceVTable. * The type of the @get_property function in #GDBusInterfaceVTable.
* *
* Returns: A newly-allocated #GVariant with the value for @property_name or %NULL if @error is set. * Returns: A newly-allocated #GVariant with the value for @property_name or %NULL if @error is set.
*
* Since: 2.26
*/ */
typedef GVariant *(*GDBusInterfaceGetPropertyFunc) (GDBusConnection *connection, typedef GVariant *(*GDBusInterfaceGetPropertyFunc) (GDBusConnection *connection,
const gchar *sender, const gchar *sender,
@ -253,6 +261,8 @@ typedef GVariant *(*GDBusInterfaceGetPropertyFunc) (GDBusConnection *conne
* The type of the @set_property function in #GDBusInterfaceVTable. * The type of the @set_property function in #GDBusInterfaceVTable.
* *
* Returns: %TRUE if the property was set to @value, %FALSE if @error is set. * Returns: %TRUE if the property was set to @value, %FALSE if @error is set.
*
* Since: 2.26
*/ */
typedef gboolean (*GDBusInterfaceSetPropertyFunc) (GDBusConnection *connection, typedef gboolean (*GDBusInterfaceSetPropertyFunc) (GDBusConnection *connection,
const gchar *sender, const gchar *sender,
@ -275,6 +285,8 @@ typedef gboolean (*GDBusInterfaceSetPropertyFunc) (GDBusConnection *conne
* If you want to handle getting/setting D-Bus properties asynchronously, simply * If you want to handle getting/setting D-Bus properties asynchronously, simply
* register an object with the <literal>org.freedesktop.DBus.Properties</literal> * register an object with the <literal>org.freedesktop.DBus.Properties</literal>
* D-Bus interface using g_dbus_connection_register_object(). * D-Bus interface using g_dbus_connection_register_object().
*
* Since: 2.26
*/ */
struct _GDBusInterfaceVTable struct _GDBusInterfaceVTable
{ {
@ -317,6 +329,8 @@ gboolean g_dbus_connection_unregister_object (GDBusConnection
* The type of the @enumerate function in #GDBusSubtreeVTable. * The type of the @enumerate function in #GDBusSubtreeVTable.
* *
* Returns: A newly allocated array of strings for node names that are children of @object_path. * Returns: A newly allocated array of strings for node names that are children of @object_path.
*
* Since: 2.26
*/ */
typedef gchar** (*GDBusSubtreeEnumerateFunc) (GDBusConnection *connection, typedef gchar** (*GDBusSubtreeEnumerateFunc) (GDBusConnection *connection,
const gchar *sender, const gchar *sender,
@ -335,6 +349,8 @@ typedef gchar** (*GDBusSubtreeEnumerateFunc) (GDBusConnection *connection,
* *
* Returns: A newly-allocated #GPtrArray with pointers to #GDBusInterfaceInfo describing * Returns: A newly-allocated #GPtrArray with pointers to #GDBusInterfaceInfo describing
* the interfaces implemented by @node. * the interfaces implemented by @node.
*
* Since: 2.26
*/ */
typedef GPtrArray *(*GDBusSubtreeIntrospectFunc) (GDBusConnection *connection, typedef GPtrArray *(*GDBusSubtreeIntrospectFunc) (GDBusConnection *connection,
const gchar *sender, const gchar *sender,
@ -355,6 +371,8 @@ typedef GPtrArray *(*GDBusSubtreeIntrospectFunc) (GDBusConnection *connect
* The type of the @dispatch function in #GDBusSubtreeVTable. * The type of the @dispatch function in #GDBusSubtreeVTable.
* *
* Returns: A #GDBusInterfaceVTable or %NULL if you don't want to handle the methods. * Returns: A #GDBusInterfaceVTable or %NULL if you don't want to handle the methods.
*
* Since: 2.26
*/ */
typedef const GDBusInterfaceVTable * (*GDBusSubtreeDispatchFunc) (GDBusConnection *connection, typedef const GDBusInterfaceVTable * (*GDBusSubtreeDispatchFunc) (GDBusConnection *connection,
const gchar *sender, const gchar *sender,
@ -371,6 +389,8 @@ typedef const GDBusInterfaceVTable * (*GDBusSubtreeDispatchFunc) (GDBusConnectio
* @dispatch: Function for dispatching a remote call on a child node. * @dispatch: Function for dispatching a remote call on a child node.
* *
* Virtual table for handling subtrees registered with g_dbus_connection_register_subtree(). * Virtual table for handling subtrees registered with g_dbus_connection_register_subtree().
*
* Since: 2.26
*/ */
struct _GDBusSubtreeVTable struct _GDBusSubtreeVTable
{ {
@ -413,6 +433,8 @@ gboolean g_dbus_connection_unregister_subtree (GDBusConnection
* @user_data: User data passed when subscribing to the signal. * @user_data: User data passed when subscribing to the signal.
* *
* Signature for callback function used in g_dbus_connection_signal_subscribe(). * Signature for callback function used in g_dbus_connection_signal_subscribe().
*
* Since: 2.26
*/ */
typedef void (*GDBusSignalCallback) (GDBusConnection *connection, typedef void (*GDBusSignalCallback) (GDBusConnection *connection,
const gchar *sender_name, const gchar *sender_name,
@ -446,6 +468,8 @@ void g_dbus_connection_signal_unsubscribe (GDBusConnection
* *
* Returns: %TRUE if the filter handled @message, %FALSE to let other * Returns: %TRUE if the filter handled @message, %FALSE to let other
* handlers run. * handlers run.
*
* Since: 2.26
*/ */
typedef gboolean (*GDBusMessageFilterFunction) (GDBusConnection *connection, typedef gboolean (*GDBusMessageFilterFunction) (GDBusConnection *connection,
GDBusMessage *message, GDBusMessage *message,

View File

@ -167,6 +167,8 @@ g_dbus_error_quark (void)
* @num_entries: Number of items to register. * @num_entries: Number of items to register.
* *
* Helper function for associating a #GError error domain with D-Bus error names. * Helper function for associating a #GError error domain with D-Bus error names.
*
* Since: 2.26
*/ */
void void
g_dbus_error_register_error_domain (const gchar *error_domain_quark_name, g_dbus_error_register_error_domain (const gchar *error_domain_quark_name,
@ -336,6 +338,8 @@ static GHashTable *dbus_error_name_to_re = NULL;
* *
* Returns: %TRUE if the association was created, %FALSE if it already * Returns: %TRUE if the association was created, %FALSE if it already
* exists. * exists.
*
* Since: 2.26
*/ */
gboolean gboolean
g_dbus_error_register_error (GQuark error_domain, g_dbus_error_register_error (GQuark error_domain,
@ -395,6 +399,8 @@ g_dbus_error_register_error (GQuark error_domain,
* Destroys an association previously set up with g_dbus_error_register_error(). * Destroys an association previously set up with g_dbus_error_register_error().
* *
* Returns: %TRUE if the association was destroyed, %FALSE if it wasn't found. * Returns: %TRUE if the association was destroyed, %FALSE if it wasn't found.
*
* Since: 2.26
*/ */
gboolean gboolean
g_dbus_error_unregister_error (GQuark error_domain, g_dbus_error_unregister_error (GQuark error_domain,
@ -463,6 +469,8 @@ g_dbus_error_unregister_error (GQuark error_domain,
* *
* Returns: %TRUE if @error represents an error from a remote peer, * Returns: %TRUE if @error represents an error from a remote peer,
* %FALSE otherwise. * %FALSE otherwise.
*
* Since: 2.26
*/ */
gboolean gboolean
g_dbus_error_is_remote_error (const GError *error) g_dbus_error_is_remote_error (const GError *error)
@ -483,6 +491,8 @@ g_dbus_error_is_remote_error (const GError *error)
* unless g_dbus_error_strip_remote_error() has been used on @error. * unless g_dbus_error_strip_remote_error() has been used on @error.
* *
* Returns: An allocated string or %NULL if the D-Bus error name could not be found. Free with g_free(). * Returns: An allocated string or %NULL if the D-Bus error name could not be found. Free with g_free().
*
* Since: 2.26
*/ */
gchar * gchar *
g_dbus_error_get_remote_error (const GError *error) g_dbus_error_get_remote_error (const GError *error)
@ -568,6 +578,8 @@ g_dbus_error_get_remote_error (const GError *error)
* it. * it.
* *
* Returns: An allocated #GError. Free with g_error_free(). * Returns: An allocated #GError. Free with g_error_free().
*
* Since: 2.26
*/ */
GError * GError *
g_dbus_error_new_for_dbus_error (const gchar *dbus_error_name, g_dbus_error_new_for_dbus_error (const gchar *dbus_error_name,
@ -639,6 +651,8 @@ g_dbus_error_new_for_dbus_error (const gchar *dbus_error_name,
* Does nothing if @error is %NULL. Otherwise sets *@error to * Does nothing if @error is %NULL. Otherwise sets *@error to
* a new #GError created with g_dbus_error_new_for_dbus_error() * a new #GError created with g_dbus_error_new_for_dbus_error()
* with @dbus_error_message prepend with @format (unless %NULL). * with @dbus_error_message prepend with @format (unless %NULL).
*
* Since: 2.26
*/ */
void void
g_dbus_error_set_dbus_error (GError **error, g_dbus_error_set_dbus_error (GError **error,
@ -680,6 +694,8 @@ g_dbus_error_set_dbus_error (GError **error,
* @var_args: Arguments for @format. * @var_args: Arguments for @format.
* *
* Like g_dbus_error_set_dbus_error() but intended for language bindings. * Like g_dbus_error_set_dbus_error() but intended for language bindings.
*
* Since: 2.26
*/ */
void void
g_dbus_error_set_dbus_error_valist (GError **error, g_dbus_error_set_dbus_error_valist (GError **error,
@ -723,6 +739,8 @@ g_dbus_error_set_dbus_error_valist (GError **error,
* This is typically used when presenting errors to the end user. * This is typically used when presenting errors to the end user.
* *
* Returns: %TRUE if information was stripped, %FALSE otherwise. * Returns: %TRUE if information was stripped, %FALSE otherwise.
*
* Since: 2.26
*/ */
gboolean gboolean
g_dbus_error_strip_remote_error (GError *error) g_dbus_error_strip_remote_error (GError *error)
@ -770,6 +788,8 @@ g_dbus_error_strip_remote_error (GError *error)
* #GError on the wire. Regular applications should not use it. * #GError on the wire. Regular applications should not use it.
* *
* Returns: A D-Bus error name (never %NULL). Free with g_free(). * Returns: A D-Bus error name (never %NULL). Free with g_free().
*
* Since: 2.26
*/ */
gchar * gchar *
g_dbus_error_encode_gerror (const GError *error) g_dbus_error_encode_gerror (const GError *error)

View File

@ -38,6 +38,8 @@ G_BEGIN_DECLS
* returning errors from a remote message bus process. Errors * returning errors from a remote message bus process. Errors
* generated locally in-process by e.g. #GDBusConnection is from the * generated locally in-process by e.g. #GDBusConnection is from the
* %G_IO_ERROR domain. * %G_IO_ERROR domain.
*
* Since: 2.26
*/ */
#define G_DBUS_ERROR g_dbus_error_quark() #define G_DBUS_ERROR g_dbus_error_quark()
@ -54,6 +56,8 @@ gboolean g_dbus_error_strip_remote_error (GError *error);
* @dbus_error_name: The D-Bus error name to associate with @error_code. * @dbus_error_name: The D-Bus error name to associate with @error_code.
* *
* Struct used in g_dbus_error_register_error_domain(). * Struct used in g_dbus_error_register_error_domain().
*
* Since: 2.26
*/ */
struct _GDBusErrorEntry struct _GDBusErrorEntry
{ {

View File

@ -106,6 +106,8 @@ typedef struct
* the reference count. * the reference count.
* *
* Returns: The same @info. * Returns: The same @info.
*
* Since: 2.26
*/ */
GDBusNodeInfo * GDBusNodeInfo *
g_dbus_node_info_ref (GDBusNodeInfo *info) g_dbus_node_info_ref (GDBusNodeInfo *info)
@ -124,6 +126,8 @@ g_dbus_node_info_ref (GDBusNodeInfo *info)
* the reference count. * the reference count.
* *
* Returns: The same @info. * Returns: The same @info.
*
* Since: 2.26
*/ */
GDBusInterfaceInfo * GDBusInterfaceInfo *
g_dbus_interface_info_ref (GDBusInterfaceInfo *info) g_dbus_interface_info_ref (GDBusInterfaceInfo *info)
@ -142,6 +146,8 @@ g_dbus_interface_info_ref (GDBusInterfaceInfo *info)
* the reference count. * the reference count.
* *
* Returns: The same @info. * Returns: The same @info.
*
* Since: 2.26
*/ */
GDBusMethodInfo * GDBusMethodInfo *
g_dbus_method_info_ref (GDBusMethodInfo *info) g_dbus_method_info_ref (GDBusMethodInfo *info)
@ -160,6 +166,8 @@ g_dbus_method_info_ref (GDBusMethodInfo *info)
* the reference count. * the reference count.
* *
* Returns: The same @info. * Returns: The same @info.
*
* Since: 2.26
*/ */
GDBusSignalInfo * GDBusSignalInfo *
g_dbus_signal_info_ref (GDBusSignalInfo *info) g_dbus_signal_info_ref (GDBusSignalInfo *info)
@ -178,6 +186,8 @@ g_dbus_signal_info_ref (GDBusSignalInfo *info)
* the reference count. * the reference count.
* *
* Returns: The same @info. * Returns: The same @info.
*
* Since: 2.26
*/ */
GDBusPropertyInfo * GDBusPropertyInfo *
g_dbus_property_info_ref (GDBusPropertyInfo *info) g_dbus_property_info_ref (GDBusPropertyInfo *info)
@ -196,6 +206,8 @@ g_dbus_property_info_ref (GDBusPropertyInfo *info)
* the reference count. * the reference count.
* *
* Returns: The same @info. * Returns: The same @info.
*
* Since: 2.26
*/ */
GDBusArgInfo * GDBusArgInfo *
g_dbus_arg_info_ref (GDBusArgInfo *info) g_dbus_arg_info_ref (GDBusArgInfo *info)
@ -214,6 +226,8 @@ g_dbus_arg_info_ref (GDBusArgInfo *info)
* the reference count. * the reference count.
* *
* Returns: The same @info. * Returns: The same @info.
*
* Since: 2.26
*/ */
GDBusAnnotationInfo * GDBusAnnotationInfo *
g_dbus_annotation_info_ref (GDBusAnnotationInfo *info) g_dbus_annotation_info_ref (GDBusAnnotationInfo *info)
@ -245,6 +259,8 @@ free_null_terminated_array (gpointer array, GDestroyNotify unref_func)
* If @info is statically allocated, does nothing. Otherwise decreases * If @info is statically allocated, does nothing. Otherwise decreases
* the reference count of @info. When its reference count drops to 0, * the reference count of @info. When its reference count drops to 0,
* the memory used is freed. * the memory used is freed.
*
* Since: 2.26
*/ */
void void
g_dbus_annotation_info_unref (GDBusAnnotationInfo *info) g_dbus_annotation_info_unref (GDBusAnnotationInfo *info)
@ -267,6 +283,8 @@ g_dbus_annotation_info_unref (GDBusAnnotationInfo *info)
* If @info is statically allocated, does nothing. Otherwise decreases * If @info is statically allocated, does nothing. Otherwise decreases
* the reference count of @info. When its reference count drops to 0, * the reference count of @info. When its reference count drops to 0,
* the memory used is freed. * the memory used is freed.
*
* Since: 2.26
*/ */
void void
g_dbus_arg_info_unref (GDBusArgInfo *info) g_dbus_arg_info_unref (GDBusArgInfo *info)
@ -289,6 +307,8 @@ g_dbus_arg_info_unref (GDBusArgInfo *info)
* If @info is statically allocated, does nothing. Otherwise decreases * If @info is statically allocated, does nothing. Otherwise decreases
* the reference count of @info. When its reference count drops to 0, * the reference count of @info. When its reference count drops to 0,
* the memory used is freed. * the memory used is freed.
*
* Since: 2.26
*/ */
void void
g_dbus_method_info_unref (GDBusMethodInfo *info) g_dbus_method_info_unref (GDBusMethodInfo *info)
@ -312,6 +332,8 @@ g_dbus_method_info_unref (GDBusMethodInfo *info)
* If @info is statically allocated, does nothing. Otherwise decreases * If @info is statically allocated, does nothing. Otherwise decreases
* the reference count of @info. When its reference count drops to 0, * the reference count of @info. When its reference count drops to 0,
* the memory used is freed. * the memory used is freed.
*
* Since: 2.26
*/ */
void void
g_dbus_signal_info_unref (GDBusSignalInfo *info) g_dbus_signal_info_unref (GDBusSignalInfo *info)
@ -334,6 +356,8 @@ g_dbus_signal_info_unref (GDBusSignalInfo *info)
* If @info is statically allocated, does nothing. Otherwise decreases * If @info is statically allocated, does nothing. Otherwise decreases
* the reference count of @info. When its reference count drops to 0, * the reference count of @info. When its reference count drops to 0,
* the memory used is freed. * the memory used is freed.
*
* Since: 2.26
*/ */
void void
g_dbus_property_info_unref (GDBusPropertyInfo *info) g_dbus_property_info_unref (GDBusPropertyInfo *info)
@ -356,6 +380,8 @@ g_dbus_property_info_unref (GDBusPropertyInfo *info)
* If @info is statically allocated, does nothing. Otherwise decreases * If @info is statically allocated, does nothing. Otherwise decreases
* the reference count of @info. When its reference count drops to 0, * the reference count of @info. When its reference count drops to 0,
* the memory used is freed. * the memory used is freed.
*
* Since: 2.26
*/ */
void void
g_dbus_interface_info_unref (GDBusInterfaceInfo *info) g_dbus_interface_info_unref (GDBusInterfaceInfo *info)
@ -380,6 +406,8 @@ g_dbus_interface_info_unref (GDBusInterfaceInfo *info)
* If @info is statically allocated, does nothing. Otherwise decreases * If @info is statically allocated, does nothing. Otherwise decreases
* the reference count of @info. When its reference count drops to 0, * the reference count of @info. When its reference count drops to 0,
* the memory used is freed. * the memory used is freed.
*
* Since: 2.26
*/ */
void void
g_dbus_node_info_unref (GDBusNodeInfo *info) g_dbus_node_info_unref (GDBusNodeInfo *info)
@ -805,6 +833,8 @@ g_dbus_property_info_generate_xml (const GDBusPropertyInfo *info,
* documents at run-time for handling the * documents at run-time for handling the
* <literal>org.freedesktop.DBus.Introspectable.Introspect</literal> * <literal>org.freedesktop.DBus.Introspectable.Introspect</literal>
* method. * method.
*
* Since: 2.26
*/ */
void void
g_dbus_interface_info_generate_xml (const GDBusInterfaceInfo *info, g_dbus_interface_info_generate_xml (const GDBusInterfaceInfo *info,
@ -850,6 +880,8 @@ g_dbus_interface_info_generate_xml (const GDBusInterfaceInfo *info,
* *
* This function is typically used for generating introspection XML documents at run-time for * This function is typically used for generating introspection XML documents at run-time for
* handling the <literal>org.freedesktop.DBus.Introspectable.Introspect</literal> method. * handling the <literal>org.freedesktop.DBus.Introspectable.Introspect</literal> method.
*
* Since: 2.26
*/ */
void void
g_dbus_node_info_generate_xml (const GDBusNodeInfo *node_info, g_dbus_node_info_generate_xml (const GDBusNodeInfo *node_info,
@ -1759,6 +1791,8 @@ parser_error (GMarkupParseContext *context,
* *
* Returns: A #GDBusNodeInfo structure or %NULL if @error is set. Free * Returns: A #GDBusNodeInfo structure or %NULL if @error is set. Free
* with g_dbus_node_info_unref(). * with g_dbus_node_info_unref().
*
* Since: 2.26
*/ */
GDBusNodeInfo * GDBusNodeInfo *
g_dbus_node_info_new_for_xml (const gchar *xml_data, g_dbus_node_info_new_for_xml (const gchar *xml_data,
@ -1838,6 +1872,8 @@ g_dbus_node_info_new_for_xml (const gchar *xml_data,
* This cost of this function is O(n) in number of annotations. * This cost of this function is O(n) in number of annotations.
* *
* Returns: The value or %NULL if not found. Do not free, it is owned by @annotations. * Returns: The value or %NULL if not found. Do not free, it is owned by @annotations.
*
* Since: 2.26
*/ */
const gchar * const gchar *
g_dbus_annotation_info_lookup (const GDBusAnnotationInfo **annotations, g_dbus_annotation_info_lookup (const GDBusAnnotationInfo **annotations,
@ -1872,7 +1908,9 @@ g_dbus_annotation_info_lookup (const GDBusAnnotationInfo **annotations,
* This cost of this function is O(n) in number of methods. * This cost of this function is O(n) in number of methods.
* *
* Returns: A #GDBusMethodInfo or %NULL if not found. Do not free, it is owned by @info. * Returns: A #GDBusMethodInfo or %NULL if not found. Do not free, it is owned by @info.
**/ *
* Since: 2.26
*/
const GDBusMethodInfo * const GDBusMethodInfo *
g_dbus_interface_info_lookup_method (const GDBusInterfaceInfo *info, g_dbus_interface_info_lookup_method (const GDBusInterfaceInfo *info,
const gchar *name) const gchar *name)
@ -1909,7 +1947,9 @@ g_dbus_interface_info_lookup_method (const GDBusInterfaceInfo *info,
* This cost of this function is O(n) in number of signals. * This cost of this function is O(n) in number of signals.
* *
* Returns: A #GDBusSignalInfo or %NULL if not found. Do not free, it is owned by @info. * Returns: A #GDBusSignalInfo or %NULL if not found. Do not free, it is owned by @info.
**/ *
* Since: 2.26
*/
const GDBusSignalInfo * const GDBusSignalInfo *
g_dbus_interface_info_lookup_signal (const GDBusInterfaceInfo *info, g_dbus_interface_info_lookup_signal (const GDBusInterfaceInfo *info,
const gchar *name) const gchar *name)
@ -1946,7 +1986,9 @@ g_dbus_interface_info_lookup_signal (const GDBusInterfaceInfo *info,
* This cost of this function is O(n) in number of properties. * This cost of this function is O(n) in number of properties.
* *
* Returns: A #GDBusPropertyInfo or %NULL if not found. Do not free, it is owned by @info. * Returns: A #GDBusPropertyInfo or %NULL if not found. Do not free, it is owned by @info.
**/ *
* Since: 2.26
*/
const GDBusPropertyInfo * const GDBusPropertyInfo *
g_dbus_interface_info_lookup_property (const GDBusInterfaceInfo *info, g_dbus_interface_info_lookup_property (const GDBusInterfaceInfo *info,
const gchar *name) const gchar *name)
@ -1983,7 +2025,9 @@ g_dbus_interface_info_lookup_property (const GDBusInterfaceInfo *info,
* This cost of this function is O(n) in number of interfaces. * This cost of this function is O(n) in number of interfaces.
* *
* Returns: A #GDBusInterfaceInfo or %NULL if not found. Do not free, it is owned by @node_info. * Returns: A #GDBusInterfaceInfo or %NULL if not found. Do not free, it is owned by @node_info.
**/ *
* Since: 2.26
*/
const GDBusInterfaceInfo * const GDBusInterfaceInfo *
g_dbus_node_info_lookup_interface (const GDBusNodeInfo *node_info, g_dbus_node_info_lookup_interface (const GDBusNodeInfo *node_info,
const gchar *name) const gchar *name)

View File

@ -35,6 +35,8 @@ G_BEGIN_DECLS
* @annotations: A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations. * @annotations: A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
* *
* Information about an annotation. * Information about an annotation.
*
* Since: 2.26
*/ */
struct _GDBusAnnotationInfo struct _GDBusAnnotationInfo
{ {
@ -52,6 +54,8 @@ struct _GDBusAnnotationInfo
* @annotations: A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations. * @annotations: A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
* *
* Information about an argument for a method or a signal. * Information about an argument for a method or a signal.
*
* Since: 2.26
*/ */
struct _GDBusArgInfo struct _GDBusArgInfo
{ {
@ -70,6 +74,8 @@ struct _GDBusArgInfo
* @annotations: A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations. * @annotations: A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
* *
* Information about a method on an D-Bus interface. * Information about a method on an D-Bus interface.
*
* Since: 2.26
*/ */
struct _GDBusMethodInfo struct _GDBusMethodInfo
{ {
@ -88,6 +94,8 @@ struct _GDBusMethodInfo
* @annotations: A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations. * @annotations: A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
* *
* Information about a signal on a D-Bus interface. * Information about a signal on a D-Bus interface.
*
* Since: 2.26
*/ */
struct _GDBusSignalInfo struct _GDBusSignalInfo
{ {
@ -106,6 +114,8 @@ struct _GDBusSignalInfo
* @annotations: A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations. * @annotations: A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
* *
* Information about a D-Bus property on a D-Bus interface. * Information about a D-Bus property on a D-Bus interface.
*
* Since: 2.26
*/ */
struct _GDBusPropertyInfo struct _GDBusPropertyInfo
{ {
@ -126,6 +136,8 @@ struct _GDBusPropertyInfo
* @annotations: A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations. * @annotations: A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
* *
* Information about a D-Bus interface. * Information about a D-Bus interface.
*
* Since: 2.26
*/ */
struct _GDBusInterfaceInfo struct _GDBusInterfaceInfo
{ {
@ -146,6 +158,8 @@ struct _GDBusInterfaceInfo
* @annotations: A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations. * @annotations: A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
* *
* Information about nodes in a remote object hierarchy. * Information about nodes in a remote object hierarchy.
*
* Since: 2.26
*/ */
struct _GDBusNodeInfo struct _GDBusNodeInfo
{ {
@ -197,6 +211,8 @@ void g_dbus_annotation_info_unref (GDBusAnnotatio
* G_TYPE_DBUS_NODE_INFO: * G_TYPE_DBUS_NODE_INFO:
* *
* The #GType for a boxed type holding a #GDBusNodeInfo. * The #GType for a boxed type holding a #GDBusNodeInfo.
*
* Since: 2.26
*/ */
#define G_TYPE_DBUS_NODE_INFO (g_dbus_node_info_get_type ()) #define G_TYPE_DBUS_NODE_INFO (g_dbus_node_info_get_type ())
@ -204,6 +220,8 @@ void g_dbus_annotation_info_unref (GDBusAnnotatio
* G_TYPE_DBUS_INTERFACE_INFO: * G_TYPE_DBUS_INTERFACE_INFO:
* *
* The #GType for a boxed type holding a #GDBusInterfaceInfo. * The #GType for a boxed type holding a #GDBusInterfaceInfo.
*
* Since: 2.26
*/ */
#define G_TYPE_DBUS_INTERFACE_INFO (g_dbus_interface_info_get_type ()) #define G_TYPE_DBUS_INTERFACE_INFO (g_dbus_interface_info_get_type ())
@ -211,6 +229,8 @@ void g_dbus_annotation_info_unref (GDBusAnnotatio
* G_TYPE_DBUS_METHOD_INFO: * G_TYPE_DBUS_METHOD_INFO:
* *
* The #GType for a boxed type holding a #GDBusMethodInfo. * The #GType for a boxed type holding a #GDBusMethodInfo.
*
* Since: 2.26
*/ */
#define G_TYPE_DBUS_METHOD_INFO (g_dbus_method_info_get_type ()) #define G_TYPE_DBUS_METHOD_INFO (g_dbus_method_info_get_type ())
@ -218,6 +238,8 @@ void g_dbus_annotation_info_unref (GDBusAnnotatio
* G_TYPE_DBUS_SIGNAL_INFO: * G_TYPE_DBUS_SIGNAL_INFO:
* *
* The #GType for a boxed type holding a #GDBusSignalInfo. * The #GType for a boxed type holding a #GDBusSignalInfo.
*
* Since: 2.26
*/ */
#define G_TYPE_DBUS_SIGNAL_INFO (g_dbus_signal_info_get_type ()) #define G_TYPE_DBUS_SIGNAL_INFO (g_dbus_signal_info_get_type ())
@ -225,6 +247,8 @@ void g_dbus_annotation_info_unref (GDBusAnnotatio
* G_TYPE_DBUS_PROPERTY_INFO: * G_TYPE_DBUS_PROPERTY_INFO:
* *
* The #GType for a boxed type holding a #GDBusPropertyInfo. * The #GType for a boxed type holding a #GDBusPropertyInfo.
*
* Since: 2.26
*/ */
#define G_TYPE_DBUS_PROPERTY_INFO (g_dbus_property_info_get_type ()) #define G_TYPE_DBUS_PROPERTY_INFO (g_dbus_property_info_get_type ())
@ -232,6 +256,8 @@ void g_dbus_annotation_info_unref (GDBusAnnotatio
* G_TYPE_DBUS_ARG_INFO: * G_TYPE_DBUS_ARG_INFO:
* *
* The #GType for a boxed type holding a #GDBusArgInfo. * The #GType for a boxed type holding a #GDBusArgInfo.
*
* Since: 2.26
*/ */
#define G_TYPE_DBUS_ARG_INFO (g_dbus_arg_info_get_type ()) #define G_TYPE_DBUS_ARG_INFO (g_dbus_arg_info_get_type ())
@ -239,6 +265,8 @@ void g_dbus_annotation_info_unref (GDBusAnnotatio
* G_TYPE_DBUS_ANNOTATION_INFO: * G_TYPE_DBUS_ANNOTATION_INFO:
* *
* The #GType for a boxed type holding a #GDBusAnnotationInfo. * The #GType for a boxed type holding a #GDBusAnnotationInfo.
*
* Since: 2.26
*/ */
#define G_TYPE_DBUS_ANNOTATION_INFO (g_dbus_annotation_info_get_type ()) #define G_TYPE_DBUS_ANNOTATION_INFO (g_dbus_annotation_info_get_type ())

View File

@ -118,6 +118,8 @@ g_dbus_message_init (GDBusMessage *message)
* Creates a new empty #GDBusMessage. * Creates a new empty #GDBusMessage.
* *
* Returns: A #GDBusMessage. Free with g_object_unref(). * Returns: A #GDBusMessage. Free with g_object_unref().
*
* Since: 2.26
*/ */
GDBusMessage * GDBusMessage *
g_dbus_message_new (void) g_dbus_message_new (void)
@ -135,6 +137,8 @@ g_dbus_message_new (void)
* Creates a new #GDBusMessage for a method call. * Creates a new #GDBusMessage for a method call.
* *
* Returns: A #GDBusMessage. Free with g_object_unref(). * Returns: A #GDBusMessage. Free with g_object_unref().
*
* Since: 2.26
*/ */
GDBusMessage * GDBusMessage *
g_dbus_message_new_method_call (const gchar *name, g_dbus_message_new_method_call (const gchar *name,
@ -171,6 +175,8 @@ g_dbus_message_new_method_call (const gchar *name,
* Creates a new #GDBusMessage for a signal emission. * Creates a new #GDBusMessage for a signal emission.
* *
* Returns: A #GDBusMessage. Free with g_object_unref(). * Returns: A #GDBusMessage. Free with g_object_unref().
*
* Since: 2.26
*/ */
GDBusMessage * GDBusMessage *
g_dbus_message_new_signal (const gchar *path, g_dbus_message_new_signal (const gchar *path,
@ -205,6 +211,8 @@ g_dbus_message_new_signal (const gchar *path,
* Creates a new #GDBusMessage that is a reply to @method_call_message. * Creates a new #GDBusMessage that is a reply to @method_call_message.
* *
* Returns: A #GDBusMessage. Free with g_object_unref(). * Returns: A #GDBusMessage. Free with g_object_unref().
*
* Since: 2.26
*/ */
GDBusMessage * GDBusMessage *
g_dbus_message_new_method_reply (GDBusMessage *method_call_message) g_dbus_message_new_method_reply (GDBusMessage *method_call_message)
@ -239,6 +247,8 @@ g_dbus_message_new_method_reply (GDBusMessage *method_call_message)
* Creates a new #GDBusMessage that is an error reply to @method_call_message. * Creates a new #GDBusMessage that is an error reply to @method_call_message.
* *
* Returns: A #GDBusMessage. Free with g_object_unref(). * Returns: A #GDBusMessage. Free with g_object_unref().
*
* Since: 2.26
*/ */
GDBusMessage * GDBusMessage *
g_dbus_message_new_method_error (GDBusMessage *method_call_message, g_dbus_message_new_method_error (GDBusMessage *method_call_message,
@ -269,6 +279,8 @@ g_dbus_message_new_method_error (GDBusMessage *method_call_message,
* Creates a new #GDBusMessage that is an error reply to @method_call_message. * Creates a new #GDBusMessage that is an error reply to @method_call_message.
* *
* Returns: A #GDBusMessage. Free with g_object_unref(). * Returns: A #GDBusMessage. Free with g_object_unref().
*
* Since: 2.26
*/ */
GDBusMessage * GDBusMessage *
g_dbus_message_new_method_error_literal (GDBusMessage *method_call_message, g_dbus_message_new_method_error_literal (GDBusMessage *method_call_message,
@ -310,6 +322,8 @@ g_dbus_message_new_method_error_literal (GDBusMessage *method_call_message,
* Like g_dbus_message_new_method_error() but intended for language bindings. * Like g_dbus_message_new_method_error() but intended for language bindings.
* *
* Returns: A #GDBusMessage. Free with g_object_unref(). * Returns: A #GDBusMessage. Free with g_object_unref().
*
* Since: 2.26
*/ */
GDBusMessage * GDBusMessage *
g_dbus_message_new_method_error_valist (GDBusMessage *method_call_message, g_dbus_message_new_method_error_valist (GDBusMessage *method_call_message,
@ -338,6 +352,8 @@ g_dbus_message_new_method_error_valist (GDBusMessage *method_call_me
* Gets the type of @message. * Gets the type of @message.
* *
* Returns: A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration). * Returns: A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration).
*
* Since: 2.26
*/ */
GDBusMessageType GDBusMessageType
g_dbus_message_get_type (GDBusMessage *message) g_dbus_message_get_type (GDBusMessage *message)
@ -352,6 +368,8 @@ g_dbus_message_get_type (GDBusMessage *message)
* @type: A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration). * @type: A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration).
* *
* Sets @message to be of @type. * Sets @message to be of @type.
*
* Since: 2.26
*/ */
void void
g_dbus_message_set_type (GDBusMessage *message, g_dbus_message_set_type (GDBusMessage *message,
@ -373,6 +391,8 @@ g_dbus_message_set_type (GDBusMessage *message,
* Gets the flags for @message. * Gets the flags for @message.
* *
* Returns: Flags that are set (typically values from the #GDBusMessageFlags enumeration bitwise ORed together). * Returns: Flags that are set (typically values from the #GDBusMessageFlags enumeration bitwise ORed together).
*
* Since: 2.26
*/ */
GDBusMessageFlags GDBusMessageFlags
g_dbus_message_get_flags (GDBusMessage *message) g_dbus_message_get_flags (GDBusMessage *message)
@ -388,6 +408,8 @@ g_dbus_message_get_flags (GDBusMessage *message)
* enumeration bitwise ORed together). * enumeration bitwise ORed together).
* *
* Sets the flags to set on @message. * Sets the flags to set on @message.
*
* Since: 2.26
*/ */
void void
g_dbus_message_set_flags (GDBusMessage *message, g_dbus_message_set_flags (GDBusMessage *message,
@ -407,6 +429,8 @@ g_dbus_message_set_flags (GDBusMessage *message,
* Gets the serial for @message. * Gets the serial for @message.
* *
* Returns: A #guint32. * Returns: A #guint32.
*
* Since: 2.26
*/ */
guint32 guint32
g_dbus_message_get_serial (GDBusMessage *message) g_dbus_message_get_serial (GDBusMessage *message)
@ -421,6 +445,8 @@ g_dbus_message_get_serial (GDBusMessage *message)
* @serial: A #guint32. * @serial: A #guint32.
* *
* Sets the serial for @message. * Sets the serial for @message.
*
* Since: 2.26
*/ */
void void
g_dbus_message_set_serial (GDBusMessage *message, g_dbus_message_set_serial (GDBusMessage *message,
@ -443,6 +469,8 @@ g_dbus_message_set_serial (GDBusMessage *message,
* *
* Returns: A #GVariant with the value if the header was found, %NULL * Returns: A #GVariant with the value if the header was found, %NULL
* otherwise. Do not free, it is owned by @message. * otherwise. Do not free, it is owned by @message.
*
* Since: 2.26
*/ */
GVariant * GVariant *
g_dbus_message_get_header (GDBusMessage *message, g_dbus_message_get_header (GDBusMessage *message,
@ -462,6 +490,8 @@ g_dbus_message_get_header (GDBusMessage *message,
* Sets a header field on @message. * Sets a header field on @message.
* *
* If @value is floating, @message assumes ownership of @value. * If @value is floating, @message assumes ownership of @value.
*
* Since: 2.26
*/ */
void void
g_dbus_message_set_header (GDBusMessage *message, g_dbus_message_set_header (GDBusMessage *message,
@ -489,6 +519,8 @@ g_dbus_message_set_header (GDBusMessage *message,
* Returns: An array of header fields terminated by * Returns: An array of header fields terminated by
* %G_DBUS_MESSAGE_HEADER_FIELD_INVALID. Each element is a * %G_DBUS_MESSAGE_HEADER_FIELD_INVALID. Each element is a
* #guchar. Free with g_free(). * #guchar. Free with g_free().
*
* Since: 2.26
*/ */
guchar * guchar *
g_dbus_message_get_header_fields (GDBusMessage *message) g_dbus_message_get_header_fields (GDBusMessage *message)
@ -522,6 +554,8 @@ g_dbus_message_get_header_fields (GDBusMessage *message)
* Gets the body of a message. * Gets the body of a message.
* *
* Returns: A #GVariant or %NULL if the body is empty. Do not free, it is owned by @message. * Returns: A #GVariant or %NULL if the body is empty. Do not free, it is owned by @message.
*
* Since: 2.26
*/ */
GVariant * GVariant *
g_dbus_message_get_body (GDBusMessage *message) g_dbus_message_get_body (GDBusMessage *message)
@ -540,6 +574,8 @@ g_dbus_message_get_body (GDBusMessage *message)
* type string of @body (or cleared if @body is %NULL). * type string of @body (or cleared if @body is %NULL).
* *
* If @body is floating, @message assumes ownership of @body. * If @body is floating, @message assumes ownership of @body.
*
* Since: 2.26
*/ */
void void
g_dbus_message_set_body (GDBusMessage *message, g_dbus_message_set_body (GDBusMessage *message,
@ -585,6 +621,8 @@ g_dbus_message_set_body (GDBusMessage *message,
* *
* Returns: A #GUnixFDList or %NULL if no file descriptors are * Returns: A #GUnixFDList or %NULL if no file descriptors are
* associated. Do not free, this object is owned by @message. * associated. Do not free, this object is owned by @message.
*
* Since: 2.26
*/ */
GUnixFDList * GUnixFDList *
g_dbus_message_get_unix_fd_list (GDBusMessage *message) g_dbus_message_get_unix_fd_list (GDBusMessage *message)
@ -604,6 +642,8 @@ g_dbus_message_get_unix_fd_list (GDBusMessage *message)
* @fd_list is %NULL). * @fd_list is %NULL).
* *
* This method is only available on UNIX. * This method is only available on UNIX.
*
* Since: 2.26
*/ */
void void
g_dbus_message_set_unix_fd_list (GDBusMessage *message, g_dbus_message_set_unix_fd_list (GDBusMessage *message,
@ -1026,6 +1066,8 @@ parse_value_from_blob (GMemoryInputStream *mis,
* Returns: Number of bytes needed or -1 if @error is set (e.g. if * Returns: Number of bytes needed or -1 if @error is set (e.g. if
* @blob contains invalid data or not enough data is available to * @blob contains invalid data or not enough data is available to
* determine the size). * determine the size).
*
* Since: 2.26
*/ */
gssize gssize
g_dbus_message_bytes_needed (guchar *blob, g_dbus_message_bytes_needed (guchar *blob,
@ -1086,6 +1128,8 @@ g_dbus_message_bytes_needed (guchar *blob,
* *
* Returns: A new #GDBusMessage or %NULL if @error is set. Free with * Returns: A new #GDBusMessage or %NULL if @error is set. Free with
* g_object_unref(). * g_object_unref().
*
* Since: 2.26
*/ */
GDBusMessage * GDBusMessage *
g_dbus_message_new_from_blob (guchar *blob, g_dbus_message_new_from_blob (guchar *blob,
@ -1527,6 +1571,8 @@ append_body_to_blob (GVariant *value,
* *
* Returns: A pointer to a valid binary D-Bus message of @out_size bytes * Returns: A pointer to a valid binary D-Bus message of @out_size bytes
* generated by @message or %NULL if @error is set. Free with g_free(). * generated by @message or %NULL if @error is set. Free with g_free().
*
* Since: 2.26
*/ */
guchar * guchar *
g_dbus_message_to_blob (GDBusMessage *message, g_dbus_message_to_blob (GDBusMessage *message,
@ -1792,6 +1838,8 @@ set_signature_header (GDBusMessage *message,
* Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field. * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field.
* *
* Returns: The value. * Returns: The value.
*
* Since: 2.26
*/ */
guint32 guint32
g_dbus_message_get_reply_serial (GDBusMessage *message) g_dbus_message_get_reply_serial (GDBusMessage *message)
@ -1806,6 +1854,8 @@ g_dbus_message_get_reply_serial (GDBusMessage *message)
* @value: The value to set. * @value: The value to set.
* *
* Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field. * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field.
*
* Since: 2.26
*/ */
void void
g_dbus_message_set_reply_serial (GDBusMessage *message, g_dbus_message_set_reply_serial (GDBusMessage *message,
@ -1824,6 +1874,8 @@ g_dbus_message_set_reply_serial (GDBusMessage *message,
* Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field. * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field.
* *
* Returns: The value. * Returns: The value.
*
* Since: 2.26
*/ */
const gchar * const gchar *
g_dbus_message_get_interface (GDBusMessage *message) g_dbus_message_get_interface (GDBusMessage *message)
@ -1838,6 +1890,8 @@ g_dbus_message_get_interface (GDBusMessage *message)
* @value: The value to set. * @value: The value to set.
* *
* Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field. * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field.
*
* Since: 2.26
*/ */
void void
g_dbus_message_set_interface (GDBusMessage *message, g_dbus_message_set_interface (GDBusMessage *message,
@ -1857,6 +1911,8 @@ g_dbus_message_set_interface (GDBusMessage *message,
* Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field. * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field.
* *
* Returns: The value. * Returns: The value.
*
* Since: 2.26
*/ */
const gchar * const gchar *
g_dbus_message_get_member (GDBusMessage *message) g_dbus_message_get_member (GDBusMessage *message)
@ -1871,6 +1927,8 @@ g_dbus_message_get_member (GDBusMessage *message)
* @value: The value to set. * @value: The value to set.
* *
* Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field. * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field.
*
* Since: 2.26
*/ */
void void
g_dbus_message_set_member (GDBusMessage *message, g_dbus_message_set_member (GDBusMessage *message,
@ -1890,6 +1948,8 @@ g_dbus_message_set_member (GDBusMessage *message,
* Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field. * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field.
* *
* Returns: The value. * Returns: The value.
*
* Since: 2.26
*/ */
const gchar * const gchar *
g_dbus_message_get_path (GDBusMessage *message) g_dbus_message_get_path (GDBusMessage *message)
@ -1904,6 +1964,8 @@ g_dbus_message_get_path (GDBusMessage *message)
* @value: The value to set. * @value: The value to set.
* *
* Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field. * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field.
*
* Since: 2.26
*/ */
void void
g_dbus_message_set_path (GDBusMessage *message, g_dbus_message_set_path (GDBusMessage *message,
@ -1923,6 +1985,8 @@ g_dbus_message_set_path (GDBusMessage *message,
* Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field. * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field.
* *
* Returns: The value. * Returns: The value.
*
* Since: 2.26
*/ */
const gchar * const gchar *
g_dbus_message_get_sender (GDBusMessage *message) g_dbus_message_get_sender (GDBusMessage *message)
@ -1937,6 +2001,8 @@ g_dbus_message_get_sender (GDBusMessage *message)
* @value: The value to set. * @value: The value to set.
* *
* Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field. * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field.
*
* Since: 2.26
*/ */
void void
g_dbus_message_set_sender (GDBusMessage *message, g_dbus_message_set_sender (GDBusMessage *message,
@ -1956,6 +2022,8 @@ g_dbus_message_set_sender (GDBusMessage *message,
* Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field. * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field.
* *
* Returns: The value. * Returns: The value.
*
* Since: 2.26
*/ */
const gchar * const gchar *
g_dbus_message_get_destination (GDBusMessage *message) g_dbus_message_get_destination (GDBusMessage *message)
@ -1970,6 +2038,8 @@ g_dbus_message_get_destination (GDBusMessage *message)
* @value: The value to set. * @value: The value to set.
* *
* Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field. * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field.
*
* Since: 2.26
*/ */
void void
g_dbus_message_set_destination (GDBusMessage *message, g_dbus_message_set_destination (GDBusMessage *message,
@ -1989,6 +2059,8 @@ g_dbus_message_set_destination (GDBusMessage *message,
* Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field. * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field.
* *
* Returns: The value. * Returns: The value.
*
* Since: 2.26
*/ */
const gchar * const gchar *
g_dbus_message_get_error_name (GDBusMessage *message) g_dbus_message_get_error_name (GDBusMessage *message)
@ -2003,6 +2075,8 @@ g_dbus_message_get_error_name (GDBusMessage *message)
* @value: The value to set. * @value: The value to set.
* *
* Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field. * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field.
*
* Since: 2.26
*/ */
void void
g_dbus_message_set_error_name (GDBusMessage *message, g_dbus_message_set_error_name (GDBusMessage *message,
@ -2022,6 +2096,8 @@ g_dbus_message_set_error_name (GDBusMessage *message,
* Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field. * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field.
* *
* Returns: The value. * Returns: The value.
*
* Since: 2.26
*/ */
const gchar * const gchar *
g_dbus_message_get_signature (GDBusMessage *message) g_dbus_message_get_signature (GDBusMessage *message)
@ -2040,6 +2116,8 @@ g_dbus_message_get_signature (GDBusMessage *message)
* @value: The value to set. * @value: The value to set.
* *
* Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field. * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field.
*
* Since: 2.26
*/ */
void void
g_dbus_message_set_signature (GDBusMessage *message, g_dbus_message_set_signature (GDBusMessage *message,
@ -2060,6 +2138,8 @@ g_dbus_message_set_signature (GDBusMessage *message,
* *
* Returns: The string item or %NULL if the first item in the body of * Returns: The string item or %NULL if the first item in the body of
* @message is not a string. * @message is not a string.
*
* Since: 2.26
*/ */
const gchar * const gchar *
g_dbus_message_get_arg0 (GDBusMessage *message) g_dbus_message_get_arg0 (GDBusMessage *message)
@ -2090,6 +2170,8 @@ g_dbus_message_get_arg0 (GDBusMessage *message)
* Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field. * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field.
* *
* Returns: The value. * Returns: The value.
*
* Since: 2.26
*/ */
guint32 guint32
g_dbus_message_get_num_unix_fds (GDBusMessage *message) g_dbus_message_get_num_unix_fds (GDBusMessage *message)
@ -2104,6 +2186,8 @@ g_dbus_message_get_num_unix_fds (GDBusMessage *message)
* @value: The value to set. * @value: The value to set.
* *
* Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field. * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field.
*
* Since: 2.26
*/ */
void void
g_dbus_message_set_num_unix_fds (GDBusMessage *message, g_dbus_message_set_num_unix_fds (GDBusMessage *message,
@ -2129,6 +2213,8 @@ g_dbus_message_set_num_unix_fds (GDBusMessage *message,
* well as the first string item in @message's body. * well as the first string item in @message's body.
* *
* Returns: %TRUE if @error was set, %FALSE otherwise. * Returns: %TRUE if @error was set, %FALSE otherwise.
*
* Since: 2.26
*/ */
gboolean gboolean
g_dbus_message_to_gerror (GDBusMessage *message, g_dbus_message_to_gerror (GDBusMessage *message,
@ -2298,6 +2384,8 @@ _sort_keys_func (gconstpointer a,
* </programlisting> * </programlisting>
* *
* Returns: A string that should be freed with g_free(). * Returns: A string that should be freed with g_free().
*
* Since: 2.26
*/ */
gchar * gchar *
g_dbus_message_print (GDBusMessage *message, g_dbus_message_print (GDBusMessage *message,

View File

@ -45,6 +45,8 @@ typedef struct _GDBusMessagePrivate GDBusMessagePrivate;
* GDBusMessageClass: * GDBusMessageClass:
* *
* Class structure for #GDBusMessage. * Class structure for #GDBusMessage.
*
* Since: 2.26
*/ */
struct _GDBusMessageClass struct _GDBusMessageClass
{ {
@ -57,6 +59,8 @@ struct _GDBusMessageClass
* *
* The #GDBusMessage structure contains only private data and should * The #GDBusMessage structure contains only private data and should
* only be accessed using the provided API. * only be accessed using the provided API.
*
* Since: 2.26
*/ */
struct _GDBusMessage struct _GDBusMessage
{ {

View File

@ -208,6 +208,8 @@ g_dbus_method_invocation_class_init (GDBusMethodInvocationClass *klass)
* GDBusMethodInvocation:sender: * GDBusMethodInvocation:sender:
* *
* The bus name that invoked the method or %NULL if the connection is not a bus connection. * The bus name that invoked the method or %NULL if the connection is not a bus connection.
*
* Since: 2.26
*/ */
g_object_class_install_property (gobject_class, g_object_class_install_property (gobject_class,
PROP_SENDER, PROP_SENDER,
@ -226,6 +228,8 @@ g_dbus_method_invocation_class_init (GDBusMethodInvocationClass *klass)
* GDBusMethodInvocation:object-path: * GDBusMethodInvocation:object-path:
* *
* The object path the method was invoked on. * The object path the method was invoked on.
*
* Since: 2.26
*/ */
g_object_class_install_property (gobject_class, g_object_class_install_property (gobject_class,
PROP_OBJECT_PATH, PROP_OBJECT_PATH,
@ -244,6 +248,8 @@ g_dbus_method_invocation_class_init (GDBusMethodInvocationClass *klass)
* GDBusMethodInvocation:interface-name: * GDBusMethodInvocation:interface-name:
* *
* The name of the D-Bus interface the method was invoked on. * The name of the D-Bus interface the method was invoked on.
*
* Since: 2.26
*/ */
g_object_class_install_property (gobject_class, g_object_class_install_property (gobject_class,
PROP_INTERFACE_NAME, PROP_INTERFACE_NAME,
@ -262,6 +268,8 @@ g_dbus_method_invocation_class_init (GDBusMethodInvocationClass *klass)
* GDBusMethodInvocation:method-name: * GDBusMethodInvocation:method-name:
* *
* The name of the method that was invoked. * The name of the method that was invoked.
*
* Since: 2.26
*/ */
g_object_class_install_property (gobject_class, g_object_class_install_property (gobject_class,
PROP_METHOD_NAME, PROP_METHOD_NAME,
@ -280,6 +288,8 @@ g_dbus_method_invocation_class_init (GDBusMethodInvocationClass *klass)
* GDBusMethodInvocation:method-info: * GDBusMethodInvocation:method-info:
* *
* Information about the method that was invoked, if any. * Information about the method that was invoked, if any.
*
* Since: 2.26
*/ */
g_object_class_install_property (gobject_class, g_object_class_install_property (gobject_class,
PROP_METHOD_INFO, PROP_METHOD_INFO,
@ -298,6 +308,8 @@ g_dbus_method_invocation_class_init (GDBusMethodInvocationClass *klass)
* GDBusMethodInvocation:connection: * GDBusMethodInvocation:connection:
* *
* The #GDBusConnection the method was invoked on. * The #GDBusConnection the method was invoked on.
*
* Since: 2.26
*/ */
g_object_class_install_property (gobject_class, g_object_class_install_property (gobject_class,
PROP_CONNECTION, PROP_CONNECTION,
@ -316,6 +328,8 @@ g_dbus_method_invocation_class_init (GDBusMethodInvocationClass *klass)
* GDBusMethodInvocation:message: * GDBusMethodInvocation:message:
* *
* The D-Bus message. * The D-Bus message.
*
* Since: 2.26
*/ */
g_object_class_install_property (gobject_class, g_object_class_install_property (gobject_class,
PROP_MESSAGE, PROP_MESSAGE,
@ -334,6 +348,8 @@ g_dbus_method_invocation_class_init (GDBusMethodInvocationClass *klass)
* GDBusMethodInvocation:parameters: * GDBusMethodInvocation:parameters:
* *
* The parameters as a #GVariant tuple. * The parameters as a #GVariant tuple.
*
* Since: 2.26
*/ */
g_object_class_install_property (gobject_class, g_object_class_install_property (gobject_class,
PROP_PARAMETERS, PROP_PARAMETERS,
@ -352,6 +368,8 @@ g_dbus_method_invocation_class_init (GDBusMethodInvocationClass *klass)
* GDBusMethodInvocation:user-data: * GDBusMethodInvocation:user-data:
* *
* The @user_data #gpointer passed to g_dbus_connection_register_object(). * The @user_data #gpointer passed to g_dbus_connection_register_object().
*
* Since: 2.26
*/ */
g_object_class_install_property (gobject_class, g_object_class_install_property (gobject_class,
PROP_USER_DATA, PROP_USER_DATA,
@ -383,6 +401,8 @@ g_dbus_method_invocation_init (GDBusMethodInvocation *invocation)
* Gets the bus name that invoked the method. * Gets the bus name that invoked the method.
* *
* Returns: A string. Do not free, it is owned by @invocation. * Returns: A string. Do not free, it is owned by @invocation.
*
* Since: 2.26
*/ */
const gchar * const gchar *
g_dbus_method_invocation_get_sender (GDBusMethodInvocation *invocation) g_dbus_method_invocation_get_sender (GDBusMethodInvocation *invocation)
@ -398,6 +418,8 @@ g_dbus_method_invocation_get_sender (GDBusMethodInvocation *invocation)
* Gets the object path the method was invoked on. * Gets the object path the method was invoked on.
* *
* Returns: A string. Do not free, it is owned by @invocation. * Returns: A string. Do not free, it is owned by @invocation.
*
* Since: 2.26
*/ */
const gchar * const gchar *
g_dbus_method_invocation_get_object_path (GDBusMethodInvocation *invocation) g_dbus_method_invocation_get_object_path (GDBusMethodInvocation *invocation)
@ -413,6 +435,8 @@ g_dbus_method_invocation_get_object_path (GDBusMethodInvocation *invocation)
* Gets the name of the D-Bus interface the method was invoked on. * Gets the name of the D-Bus interface the method was invoked on.
* *
* Returns: A string. Do not free, it is owned by @invocation. * Returns: A string. Do not free, it is owned by @invocation.
*
* Since: 2.26
*/ */
const gchar * const gchar *
g_dbus_method_invocation_get_interface_name (GDBusMethodInvocation *invocation) g_dbus_method_invocation_get_interface_name (GDBusMethodInvocation *invocation)
@ -428,6 +452,8 @@ g_dbus_method_invocation_get_interface_name (GDBusMethodInvocation *invocation)
* Gets information about the method call, if any. * Gets information about the method call, if any.
* *
* Returns: A #GDBusMethodInfo or %NULL. Do not free, it is owned by @invocation. * Returns: A #GDBusMethodInfo or %NULL. Do not free, it is owned by @invocation.
*
* Since: 2.26
*/ */
const GDBusMethodInfo * const GDBusMethodInfo *
g_dbus_method_invocation_get_method_info (GDBusMethodInvocation *invocation) g_dbus_method_invocation_get_method_info (GDBusMethodInvocation *invocation)
@ -443,6 +469,8 @@ g_dbus_method_invocation_get_method_info (GDBusMethodInvocation *invocation)
* Gets the name of the method that was invoked. * Gets the name of the method that was invoked.
* *
* Returns: A string. Do not free, it is owned by @invocation. * Returns: A string. Do not free, it is owned by @invocation.
*
* Since: 2.26
*/ */
const gchar * const gchar *
g_dbus_method_invocation_get_method_name (GDBusMethodInvocation *invocation) g_dbus_method_invocation_get_method_name (GDBusMethodInvocation *invocation)
@ -458,6 +486,8 @@ g_dbus_method_invocation_get_method_name (GDBusMethodInvocation *invocation)
* Gets the #GDBusConnection the method was invoked on. * Gets the #GDBusConnection the method was invoked on.
* *
* Returns: A #GDBusConnection. Do not free, it is owned by @invocation. * Returns: A #GDBusConnection. Do not free, it is owned by @invocation.
*
* Since: 2.26
*/ */
GDBusConnection * GDBusConnection *
g_dbus_method_invocation_get_connection (GDBusMethodInvocation *invocation) g_dbus_method_invocation_get_connection (GDBusMethodInvocation *invocation)
@ -480,6 +510,8 @@ g_dbus_method_invocation_get_connection (GDBusMethodInvocation *invocation)
* low-level API to send and receive UNIX file descriptors. * low-level API to send and receive UNIX file descriptors.
* *
* Returns: A #GDBusMessage. Do not free, it is owned by @invocation. * Returns: A #GDBusMessage. Do not free, it is owned by @invocation.
*
* Since: 2.26
*/ */
GDBusMessage * GDBusMessage *
g_dbus_method_invocation_get_message (GDBusMethodInvocation *invocation) g_dbus_method_invocation_get_message (GDBusMethodInvocation *invocation)
@ -495,6 +527,8 @@ g_dbus_method_invocation_get_message (GDBusMethodInvocation *invocation)
* Gets the parameters of the method invocation. * Gets the parameters of the method invocation.
* *
* Returns: A #GVariant. Do not free, it is owned by @invocation. * Returns: A #GVariant. Do not free, it is owned by @invocation.
*
* Since: 2.26
*/ */
GVariant * GVariant *
g_dbus_method_invocation_get_parameters (GDBusMethodInvocation *invocation) g_dbus_method_invocation_get_parameters (GDBusMethodInvocation *invocation)
@ -510,6 +544,8 @@ g_dbus_method_invocation_get_parameters (GDBusMethodInvocation *invocation)
* Gets the @user_data #gpointer passed to g_dbus_connection_register_object(). * Gets the @user_data #gpointer passed to g_dbus_connection_register_object().
* *
* Returns: A #gpointer. * Returns: A #gpointer.
*
* Since: 2.26
*/ */
gpointer gpointer
g_dbus_method_invocation_get_user_data (GDBusMethodInvocation *invocation) g_dbus_method_invocation_get_user_data (GDBusMethodInvocation *invocation)
@ -533,6 +569,8 @@ g_dbus_method_invocation_get_user_data (GDBusMethodInvocation *invocation)
* Creates a new #GDBusMethodInvocation object. * Creates a new #GDBusMethodInvocation object.
* *
* Returns: A #GDBusMethodInvocation. Free with g_object_unref(). * Returns: A #GDBusMethodInvocation. Free with g_object_unref().
*
* Since: 2.26
*/ */
GDBusMethodInvocation * GDBusMethodInvocation *
g_dbus_method_invocation_new (const gchar *sender, g_dbus_method_invocation_new (const gchar *sender,
@ -578,6 +616,8 @@ g_dbus_method_invocation_new (const gchar *sender,
* It is an error if @parameters is not of the right format. * It is an error if @parameters is not of the right format.
* *
* This method will free @invocation, you cannot use it afterwards. * This method will free @invocation, you cannot use it afterwards.
*
* Since: 2.26
*/ */
void void
g_dbus_method_invocation_return_value (GDBusMethodInvocation *invocation, g_dbus_method_invocation_return_value (GDBusMethodInvocation *invocation,
@ -655,6 +695,8 @@ g_dbus_method_invocation_return_value (GDBusMethodInvocation *invocation,
* or use g_dbus_method_invocation_return_dbus_error(). * or use g_dbus_method_invocation_return_dbus_error().
* *
* This method will free @invocation, you cannot use it afterwards. * This method will free @invocation, you cannot use it afterwards.
*
* Since: 2.26
*/ */
void void
g_dbus_method_invocation_return_error (GDBusMethodInvocation *invocation, g_dbus_method_invocation_return_error (GDBusMethodInvocation *invocation,
@ -689,6 +731,8 @@ g_dbus_method_invocation_return_error (GDBusMethodInvocation *invocation,
* language bindings. * language bindings.
* *
* This method will free @invocation, you cannot use it afterwards. * This method will free @invocation, you cannot use it afterwards.
*
* Since: 2.26
*/ */
void void
g_dbus_method_invocation_return_error_valist (GDBusMethodInvocation *invocation, g_dbus_method_invocation_return_error_valist (GDBusMethodInvocation *invocation,
@ -720,6 +764,8 @@ g_dbus_method_invocation_return_error_valist (GDBusMethodInvocation *invocation,
* Like g_dbus_method_invocation_return_error() but without printf()-style formatting. * Like g_dbus_method_invocation_return_error() but without printf()-style formatting.
* *
* This method will free @invocation, you cannot use it afterwards. * This method will free @invocation, you cannot use it afterwards.
*
* Since: 2.26
*/ */
void void
g_dbus_method_invocation_return_error_literal (GDBusMethodInvocation *invocation, g_dbus_method_invocation_return_error_literal (GDBusMethodInvocation *invocation,
@ -746,6 +792,8 @@ g_dbus_method_invocation_return_error_literal (GDBusMethodInvocation *invocation
* instead of the error domain, error code and message. * instead of the error domain, error code and message.
* *
* This method will free @invocation, you cannot use it afterwards. * This method will free @invocation, you cannot use it afterwards.
*
* Since: 2.26
*/ */
void void
g_dbus_method_invocation_return_gerror (GDBusMethodInvocation *invocation, g_dbus_method_invocation_return_gerror (GDBusMethodInvocation *invocation,
@ -773,6 +821,8 @@ g_dbus_method_invocation_return_gerror (GDBusMethodInvocation *invocation,
* Finishes handling a D-Bus method call by returning an error. * Finishes handling a D-Bus method call by returning an error.
* *
* This method will free @invocation, you cannot use it afterwards. * This method will free @invocation, you cannot use it afterwards.
*
* Since: 2.26
*/ */
void void
g_dbus_method_invocation_return_dbus_error (GDBusMethodInvocation *invocation, g_dbus_method_invocation_return_dbus_error (GDBusMethodInvocation *invocation,

View File

@ -42,6 +42,8 @@ typedef struct _GDBusMethodInvocationPrivate GDBusMethodInvocationPrivate;
* *
* The #GDBusMethodInvocation structure contains only private data and * The #GDBusMethodInvocation structure contains only private data and
* should only be accessed using the provided API. * should only be accessed using the provided API.
*
* Since: 2.26
*/ */
struct _GDBusMethodInvocation struct _GDBusMethodInvocation
{ {
@ -54,6 +56,8 @@ struct _GDBusMethodInvocation
* GDBusMethodInvocationClass: * GDBusMethodInvocationClass:
* *
* Class structure for #GDBusMethodInvocation. * Class structure for #GDBusMethodInvocation.
*
* Since: 2.26
*/ */
struct _GDBusMethodInvocationClass struct _GDBusMethodInvocationClass
{ {

View File

@ -461,7 +461,9 @@ connection_get_cb (GObject *source_object,
* *
* Returns: An identifier (never 0) that an be used with * Returns: An identifier (never 0) that an be used with
* g_bus_unown_name() to stop owning the name. * g_bus_unown_name() to stop owning the name.
**/ *
* Since: 2.26
*/
guint guint
g_bus_own_name_on_connection (GDBusConnection *connection, g_bus_own_name_on_connection (GDBusConnection *connection,
const gchar *name, const gchar *name,
@ -571,7 +573,9 @@ g_bus_own_name_on_connection (GDBusConnection *connection,
* *
* Returns: An identifier (never 0) that an be used with * Returns: An identifier (never 0) that an be used with
* g_bus_unown_name() to stop owning the name. * g_bus_unown_name() to stop owning the name.
**/ *
* Since: 2.26
*/
guint guint
g_bus_own_name (GBusType bus_type, g_bus_own_name (GBusType bus_type,
const gchar *name, const gchar *name,
@ -626,6 +630,8 @@ g_bus_own_name (GBusType bus_type,
* @owner_id: An identifier obtained from g_bus_own_name() * @owner_id: An identifier obtained from g_bus_own_name()
* *
* Stops owning a name. * Stops owning a name.
*
* Since: 2.26
*/ */
void void
g_bus_unown_name (guint owner_id) g_bus_unown_name (guint owner_id)

View File

@ -34,6 +34,8 @@ G_BEGIN_DECLS
* @user_data: User data passed to g_bus_own_name(). * @user_data: User data passed to g_bus_own_name().
* *
* Invoked when a connection to a message bus has been obtained. * Invoked when a connection to a message bus has been obtained.
*
* Since: 2.26
*/ */
typedef void (*GBusAcquiredCallback) (GDBusConnection *connection, typedef void (*GBusAcquiredCallback) (GDBusConnection *connection,
const gchar *name, const gchar *name,
@ -46,6 +48,8 @@ typedef void (*GBusAcquiredCallback) (GDBusConnection *connection,
* @user_data: User data passed to g_bus_own_name() or g_bus_own_name_on_connection(). * @user_data: User data passed to g_bus_own_name() or g_bus_own_name_on_connection().
* *
* Invoked when the name is acquired. * Invoked when the name is acquired.
*
* Since: 2.26
*/ */
typedef void (*GBusNameAcquiredCallback) (GDBusConnection *connection, typedef void (*GBusNameAcquiredCallback) (GDBusConnection *connection,
const gchar *name, const gchar *name,
@ -59,6 +63,8 @@ typedef void (*GBusNameAcquiredCallback) (GDBusConnection *connection,
* @user_data: User data passed to g_bus_own_name() or g_bus_own_name_on_connection(). * @user_data: User data passed to g_bus_own_name() or g_bus_own_name_on_connection().
* *
* Invoked when the name is lost or @connection has been closed. * Invoked when the name is lost or @connection has been closed.
*
* Since: 2.26
*/ */
typedef void (*GBusNameLostCallback) (GDBusConnection *connection, typedef void (*GBusNameLostCallback) (GDBusConnection *connection,
const gchar *name, const gchar *name,

View File

@ -534,7 +534,9 @@ connection_get_cb (GObject *source_object,
* *
* Returns: An identifier (never 0) that an be used with * Returns: An identifier (never 0) that an be used with
* g_bus_unwatch_name() to stop watching the name. * g_bus_unwatch_name() to stop watching the name.
**/ *
* Since: 2.26
*/
guint guint
g_bus_watch_name (GBusType bus_type, g_bus_watch_name (GBusType bus_type,
const gchar *name, const gchar *name,
@ -587,7 +589,9 @@ g_bus_watch_name (GBusType bus_type,
* @watcher_id: An identifier obtained from g_bus_watch_name() * @watcher_id: An identifier obtained from g_bus_watch_name()
* *
* Stops watching a name. * Stops watching a name.
**/ *
* Since: 2.26
*/
void void
g_bus_unwatch_name (guint watcher_id) g_bus_unwatch_name (guint watcher_id)
{ {

View File

@ -35,6 +35,8 @@ G_BEGIN_DECLS
* @user_data: User data passed to g_bus_watch_name(). * @user_data: User data passed to g_bus_watch_name().
* *
* Invoked when the name being watched is known to have to have a owner. * Invoked when the name being watched is known to have to have a owner.
*
* Since: 2.26
*/ */
typedef void (*GBusNameAppearedCallback) (GDBusConnection *connection, typedef void (*GBusNameAppearedCallback) (GDBusConnection *connection,
const gchar *name, const gchar *name,
@ -48,6 +50,8 @@ typedef void (*GBusNameAppearedCallback) (GDBusConnection *connection,
* @user_data: User data passed to g_bus_watch_name(). * @user_data: User data passed to g_bus_watch_name().
* *
* Invoked when the name being watched is known not to have to have a owner. * Invoked when the name being watched is known not to have to have a owner.
*
* Since: 2.26
*/ */
typedef void (*GBusNameVanishedCallback) (GDBusConnection *connection, typedef void (*GBusNameVanishedCallback) (GDBusConnection *connection,
const gchar *name, const gchar *name,

View File

@ -974,7 +974,7 @@ _g_dbus_debug_message (void)
return (_gdbus_debug_flags & G_DBUS_DEBUG_MESSAGE) != 0; return (_gdbus_debug_flags & G_DBUS_DEBUG_MESSAGE) != 0;
} }
/** /*
* _g_dbus_initialize: * _g_dbus_initialize:
* *
* Does various one-time init things such as * Does various one-time init things such as

View File

@ -240,6 +240,8 @@ g_dbus_proxy_class_init (GDBusProxyClass *klass)
* type signature of the message isn't what's expected, the given * type signature of the message isn't what's expected, the given
* #GError is set. Signals that have a type signature mismatch are * #GError is set. Signals that have a type signature mismatch are
* simply dropped. * simply dropped.
*
* Since: 2.26
*/ */
g_object_class_install_property (gobject_class, g_object_class_install_property (gobject_class,
PROP_G_INTERFACE_INFO, PROP_G_INTERFACE_INFO,
@ -257,6 +259,8 @@ g_dbus_proxy_class_init (GDBusProxyClass *klass)
* GDBusProxy:g-connection: * GDBusProxy:g-connection:
* *
* The #GDBusConnection the proxy is for. * The #GDBusConnection the proxy is for.
*
* Since: 2.26
*/ */
g_object_class_install_property (gobject_class, g_object_class_install_property (gobject_class,
PROP_G_CONNECTION, PROP_G_CONNECTION,
@ -275,6 +279,8 @@ g_dbus_proxy_class_init (GDBusProxyClass *klass)
* GDBusProxy:g-flags: * GDBusProxy:g-flags:
* *
* Flags from the #GDBusProxyFlags enumeration. * Flags from the #GDBusProxyFlags enumeration.
*
* Since: 2.26
*/ */
g_object_class_install_property (gobject_class, g_object_class_install_property (gobject_class,
PROP_G_FLAGS, PROP_G_FLAGS,
@ -294,6 +300,8 @@ g_dbus_proxy_class_init (GDBusProxyClass *klass)
* GDBusProxy:g-unique-bus-name: * GDBusProxy:g-unique-bus-name:
* *
* The unique bus name the proxy is for. * The unique bus name the proxy is for.
*
* Since: 2.26
*/ */
g_object_class_install_property (gobject_class, g_object_class_install_property (gobject_class,
PROP_G_UNIQUE_BUS_NAME, PROP_G_UNIQUE_BUS_NAME,
@ -312,6 +320,8 @@ g_dbus_proxy_class_init (GDBusProxyClass *klass)
* GDBusProxy:g-object-path: * GDBusProxy:g-object-path:
* *
* The object path the proxy is for. * The object path the proxy is for.
*
* Since: 2.26
*/ */
g_object_class_install_property (gobject_class, g_object_class_install_property (gobject_class,
PROP_G_OBJECT_PATH, PROP_G_OBJECT_PATH,
@ -330,6 +340,8 @@ g_dbus_proxy_class_init (GDBusProxyClass *klass)
* GDBusProxy:g-interface-name: * GDBusProxy:g-interface-name:
* *
* The D-Bus interface name the proxy is for. * The D-Bus interface name the proxy is for.
*
* Since: 2.26
*/ */
g_object_class_install_property (gobject_class, g_object_class_install_property (gobject_class,
PROP_G_INTERFACE_NAME, PROP_G_INTERFACE_NAME,
@ -355,6 +367,8 @@ g_dbus_proxy_class_init (GDBusProxyClass *klass)
* remote method invocations on the proxy. If this property is -1, * remote method invocations on the proxy. If this property is -1,
* the default timeout (typically 25 seconds) is used. If set to * the default timeout (typically 25 seconds) is used. If set to
* %G_MAXINT, then no timeout is used. * %G_MAXINT, then no timeout is used.
*
* Since: 2.26
*/ */
g_object_class_install_property (gobject_class, g_object_class_install_property (gobject_class,
PROP_G_DEFAULT_TIMEOUT, PROP_G_DEFAULT_TIMEOUT,
@ -378,6 +392,8 @@ g_dbus_proxy_class_init (GDBusProxyClass *klass)
* *
* Emitted when one or more D-Bus properties on @proxy changes. The cached properties * Emitted when one or more D-Bus properties on @proxy changes. The cached properties
* are already replaced when this signal fires. * are already replaced when this signal fires.
*
* Since: 2.26
*/ */
signals[PROPERTIES_CHANGED_SIGNAL] = g_signal_new ("g-properties-changed", signals[PROPERTIES_CHANGED_SIGNAL] = g_signal_new ("g-properties-changed",
G_TYPE_DBUS_PROXY, G_TYPE_DBUS_PROXY,
@ -398,7 +414,9 @@ g_dbus_proxy_class_init (GDBusProxyClass *klass)
* @parameters: A #GVariant tuple with parameters for the signal. * @parameters: A #GVariant tuple with parameters for the signal.
* *
* Emitted when a signal from the remote object and interface that @proxy is for, has been received. * Emitted when a signal from the remote object and interface that @proxy is for, has been received.
**/ *
* Since: 2.26
*/
signals[SIGNAL_SIGNAL] = g_signal_new ("g-signal", signals[SIGNAL_SIGNAL] = g_signal_new ("g-signal",
G_TYPE_DBUS_PROXY, G_TYPE_DBUS_PROXY,
G_SIGNAL_RUN_LAST, G_SIGNAL_RUN_LAST,
@ -433,6 +451,8 @@ g_dbus_proxy_init (GDBusProxy *proxy)
* *
* Returns: A %NULL-terminated array of strings or %NULL if @error is set. Free with * Returns: A %NULL-terminated array of strings or %NULL if @error is set. Free with
* g_strfreev(). * g_strfreev().
*
* Since: 2.26
*/ */
gchar ** gchar **
g_dbus_proxy_get_cached_property_names (GDBusProxy *proxy, g_dbus_proxy_get_cached_property_names (GDBusProxy *proxy,
@ -491,6 +511,8 @@ g_dbus_proxy_get_cached_property_names (GDBusProxy *proxy,
* *
* Returns: A reference to the #GVariant instance that holds the value for @property_name or * Returns: A reference to the #GVariant instance that holds the value for @property_name or
* %NULL if @error is set. Free the reference with g_variant_unref(). * %NULL if @error is set. Free the reference with g_variant_unref().
*
* Since: 2.26
*/ */
GVariant * GVariant *
g_dbus_proxy_get_cached_property (GDBusProxy *proxy, g_dbus_proxy_get_cached_property (GDBusProxy *proxy,
@ -903,7 +925,9 @@ async_initable_iface_init (GAsyncInitableIface *async_initable_iface)
* g_dbus_proxy_new_finish() to get the result. * g_dbus_proxy_new_finish() to get the result.
* *
* See g_dbus_proxy_new_sync() and for a synchronous version of this constructor. * See g_dbus_proxy_new_sync() and for a synchronous version of this constructor.
**/ *
* Since: 2.26
*/
void void
g_dbus_proxy_new (GDBusConnection *connection, g_dbus_proxy_new (GDBusConnection *connection,
GType object_type, GType object_type,
@ -945,7 +969,9 @@ g_dbus_proxy_new (GDBusConnection *connection,
* Finishes creating a #GDBusProxy. * Finishes creating a #GDBusProxy.
* *
* Returns: A #GDBusProxy or %NULL if @error is set. Free with g_object_unref(). * Returns: A #GDBusProxy or %NULL if @error is set. Free with g_object_unref().
**/ *
* Since: 2.26
*/
GDBusProxy * GDBusProxy *
g_dbus_proxy_new_finish (GAsyncResult *res, g_dbus_proxy_new_finish (GAsyncResult *res,
GError **error) GError **error)
@ -994,7 +1020,9 @@ g_dbus_proxy_new_finish (GAsyncResult *res,
* and g_dbus_proxy_new_finish() for the asynchronous version. * and g_dbus_proxy_new_finish() for the asynchronous version.
* *
* Returns: A #GDBusProxy or %NULL if error is set. Free with g_object_unref(). * Returns: A #GDBusProxy or %NULL if error is set. Free with g_object_unref().
**/ *
* Since: 2.26
*/
GDBusProxy * GDBusProxy *
g_dbus_proxy_new_sync (GDBusConnection *connection, g_dbus_proxy_new_sync (GDBusConnection *connection,
GType object_type, GType object_type,
@ -1040,7 +1068,9 @@ g_dbus_proxy_new_sync (GDBusConnection *connection,
* Gets the connection @proxy is for. * Gets the connection @proxy is for.
* *
* Returns: A #GDBusConnection owned by @proxy. Do not free. * Returns: A #GDBusConnection owned by @proxy. Do not free.
**/ *
* Since: 2.26
*/
GDBusConnection * GDBusConnection *
g_dbus_proxy_get_connection (GDBusProxy *proxy) g_dbus_proxy_get_connection (GDBusProxy *proxy)
{ {
@ -1055,7 +1085,9 @@ g_dbus_proxy_get_connection (GDBusProxy *proxy)
* Gets the flags that @proxy was constructed with. * Gets the flags that @proxy was constructed with.
* *
* Returns: Flags from the #GDBusProxyFlags enumeration. * Returns: Flags from the #GDBusProxyFlags enumeration.
**/ *
* Since: 2.26
*/
GDBusProxyFlags GDBusProxyFlags
g_dbus_proxy_get_flags (GDBusProxy *proxy) g_dbus_proxy_get_flags (GDBusProxy *proxy)
{ {
@ -1070,7 +1102,9 @@ g_dbus_proxy_get_flags (GDBusProxy *proxy)
* Gets the unique bus name @proxy is for. * Gets the unique bus name @proxy is for.
* *
* Returns: A string owned by @proxy. Do not free. * Returns: A string owned by @proxy. Do not free.
**/ *
* Since: 2.26
*/
const gchar * const gchar *
g_dbus_proxy_get_unique_bus_name (GDBusProxy *proxy) g_dbus_proxy_get_unique_bus_name (GDBusProxy *proxy)
{ {
@ -1085,7 +1119,9 @@ g_dbus_proxy_get_unique_bus_name (GDBusProxy *proxy)
* Gets the object path @proxy is for. * Gets the object path @proxy is for.
* *
* Returns: A string owned by @proxy. Do not free. * Returns: A string owned by @proxy. Do not free.
**/ *
* Since: 2.26
*/
const gchar * const gchar *
g_dbus_proxy_get_object_path (GDBusProxy *proxy) g_dbus_proxy_get_object_path (GDBusProxy *proxy)
{ {
@ -1100,7 +1136,9 @@ g_dbus_proxy_get_object_path (GDBusProxy *proxy)
* Gets the D-Bus interface name @proxy is for. * Gets the D-Bus interface name @proxy is for.
* *
* Returns: A string owned by @proxy. Do not free. * Returns: A string owned by @proxy. Do not free.
**/ *
* Since: 2.26
*/
const gchar * const gchar *
g_dbus_proxy_get_interface_name (GDBusProxy *proxy) g_dbus_proxy_get_interface_name (GDBusProxy *proxy)
{ {
@ -1119,6 +1157,8 @@ g_dbus_proxy_get_interface_name (GDBusProxy *proxy)
* See the #GDBusProxy:g-default-timeout property for more details. * See the #GDBusProxy:g-default-timeout property for more details.
* *
* Returns: Timeout to use for @proxy. * Returns: Timeout to use for @proxy.
*
* Since: 2.26
*/ */
gint gint
g_dbus_proxy_get_default_timeout (GDBusProxy *proxy) g_dbus_proxy_get_default_timeout (GDBusProxy *proxy)
@ -1137,6 +1177,8 @@ g_dbus_proxy_get_default_timeout (GDBusProxy *proxy)
* g_dbus_proxy_invoke_method_sync() functions. * g_dbus_proxy_invoke_method_sync() functions.
* *
* See the #GDBusProxy:g-default-timeout property for more details. * See the #GDBusProxy:g-default-timeout property for more details.
*
* Since: 2.26
*/ */
void void
g_dbus_proxy_set_default_timeout (GDBusProxy *proxy, g_dbus_proxy_set_default_timeout (GDBusProxy *proxy,
@ -1164,6 +1206,8 @@ g_dbus_proxy_set_default_timeout (GDBusProxy *proxy,
* *
* Returns: A #GDBusInterfaceInfo or %NULL. Do not unref the returned * Returns: A #GDBusInterfaceInfo or %NULL. Do not unref the returned
* object, it is owned by @proxy. * object, it is owned by @proxy.
*
* Since: 2.26
*/ */
GDBusInterfaceInfo * GDBusInterfaceInfo *
g_dbus_proxy_get_interface_info (GDBusProxy *proxy) g_dbus_proxy_get_interface_info (GDBusProxy *proxy)
@ -1184,6 +1228,8 @@ g_dbus_proxy_get_interface_info (GDBusProxy *proxy)
* dropped. * dropped.
* *
* See the #GDBusProxy:g-interface-info property for more details. * See the #GDBusProxy:g-interface-info property for more details.
*
* Since: 2.26
*/ */
void void
g_dbus_proxy_set_interface_info (GDBusProxy *proxy, g_dbus_proxy_set_interface_info (GDBusProxy *proxy,
@ -1346,6 +1392,8 @@ validate_method_return (const char *method_name,
* g_dbus_proxy_invoke_method_finish() to get the result of the operation. * g_dbus_proxy_invoke_method_finish() to get the result of the operation.
* See g_dbus_proxy_invoke_method_sync() for the * See g_dbus_proxy_invoke_method_sync() for the
* synchronous version of this method. * synchronous version of this method.
*
* Since: 2.26
*/ */
void void
g_dbus_proxy_invoke_method (GDBusProxy *proxy, g_dbus_proxy_invoke_method (GDBusProxy *proxy,
@ -1409,6 +1457,8 @@ g_dbus_proxy_invoke_method (GDBusProxy *proxy,
* *
* Returns: %NULL if @error is set. Otherwise a #GVariant tuple with * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
* return values. Free with g_variant_unref(). * return values. Free with g_variant_unref().
*
* Since: 2.26
*/ */
GVariant * GVariant *
g_dbus_proxy_invoke_method_finish (GDBusProxy *proxy, g_dbus_proxy_invoke_method_finish (GDBusProxy *proxy,
@ -1478,6 +1528,8 @@ g_dbus_proxy_invoke_method_finish (GDBusProxy *proxy,
* *
* Returns: %NULL if @error is set. Otherwise a #GVariant tuple with * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
* return values. Free with g_variant_unref(). * return values. Free with g_variant_unref().
*
* Since: 2.26
*/ */
GVariant * GVariant *
g_dbus_proxy_invoke_method_sync (GDBusProxy *proxy, g_dbus_proxy_invoke_method_sync (GDBusProxy *proxy,

View File

@ -43,6 +43,8 @@ typedef struct _GDBusProxyPrivate GDBusProxyPrivate;
* *
* The #GDBusProxy structure contains only private data and * The #GDBusProxy structure contains only private data and
* should only be accessed using the provided API. * should only be accessed using the provided API.
*
* Since: 2.26
*/ */
struct _GDBusProxy struct _GDBusProxy
{ {
@ -57,6 +59,8 @@ struct _GDBusProxy
* @g_signal: Signal class handler for the #GDBusProxy::g-signal signal. * @g_signal: Signal class handler for the #GDBusProxy::g-signal signal.
* *
* Class structure for #GDBusProxy. * Class structure for #GDBusProxy.
*
* Since: 2.26
*/ */
struct _GDBusProxyClass struct _GDBusProxyClass
{ {

View File

@ -298,7 +298,9 @@ on_name_vanished (GDBusConnection *connection,
* *
* Returns: An identifier (never 0) that can be used with * Returns: An identifier (never 0) that can be used with
* g_bus_unwatch_proxy() to stop watching the remote object. * g_bus_unwatch_proxy() to stop watching the remote object.
**/ *
* Since: 2.26
*/
guint guint
g_bus_watch_proxy (GBusType bus_type, g_bus_watch_proxy (GBusType bus_type,
const gchar *name, const gchar *name,
@ -364,6 +366,8 @@ g_bus_watch_proxy (GBusType bus_type,
* @watcher_id: An identifier obtained from g_bus_watch_proxy() * @watcher_id: An identifier obtained from g_bus_watch_proxy()
* *
* Stops watching proxy. * Stops watching proxy.
*
* Since: 2.26
*/ */
void void
g_bus_unwatch_proxy (guint watcher_id) g_bus_unwatch_proxy (guint watcher_id)

View File

@ -38,6 +38,8 @@ G_BEGIN_DECLS
* Invoked when the proxy being watched is ready for use - the passed * Invoked when the proxy being watched is ready for use - the passed
* @proxy object is valid until the #GBusProxyVanishedCallback * @proxy object is valid until the #GBusProxyVanishedCallback
* callback is invoked. * callback is invoked.
*
* Since: 2.26
*/ */
typedef void (*GBusProxyAppearedCallback) (GDBusConnection *connection, typedef void (*GBusProxyAppearedCallback) (GDBusConnection *connection,
const gchar *name, const gchar *name,
@ -54,6 +56,8 @@ typedef void (*GBusProxyAppearedCallback) (GDBusConnection *connection,
* Invoked when the proxy being watched has vanished. The #GDBusProxy * Invoked when the proxy being watched has vanished. The #GDBusProxy
* object passed in the #GBusProxyAppearedCallback callback is no * object passed in the #GBusProxyAppearedCallback callback is no
* longer valid. * longer valid.
*
* Since: 2.26
*/ */
typedef void (*GBusProxyVanishedCallback) (GDBusConnection *connection, typedef void (*GBusProxyVanishedCallback) (GDBusConnection *connection,
const gchar *name, const gchar *name,

View File

@ -218,6 +218,8 @@ g_dbus_server_class_init (GDBusServerClass *klass)
* GDBusServer:flags: * GDBusServer:flags:
* *
* Flags from the #GDBusServerFlags enumeration. * Flags from the #GDBusServerFlags enumeration.
*
* Since: 2.26
*/ */
g_object_class_install_property (gobject_class, g_object_class_install_property (gobject_class,
PROP_FLAGS, PROP_FLAGS,
@ -237,6 +239,8 @@ g_dbus_server_class_init (GDBusServerClass *klass)
* GDBusServer:guid: * GDBusServer:guid:
* *
* The guid of the server. * The guid of the server.
*
* Since: 2.26
*/ */
g_object_class_install_property (gobject_class, g_object_class_install_property (gobject_class,
PROP_GUID, PROP_GUID,
@ -255,6 +259,8 @@ g_dbus_server_class_init (GDBusServerClass *klass)
* GDBusServer:address: * GDBusServer:address:
* *
* The D-Bus address to listen on. * The D-Bus address to listen on.
*
* Since: 2.26
*/ */
g_object_class_install_property (gobject_class, g_object_class_install_property (gobject_class,
PROP_ADDRESS, PROP_ADDRESS,
@ -273,6 +279,8 @@ g_dbus_server_class_init (GDBusServerClass *klass)
* GDBusServer:client-address: * GDBusServer:client-address:
* *
* The D-Bus address that clients can use. * The D-Bus address that clients can use.
*
* Since: 2.26
*/ */
g_object_class_install_property (gobject_class, g_object_class_install_property (gobject_class,
PROP_CLIENT_ADDRESS, PROP_CLIENT_ADDRESS,
@ -289,6 +297,8 @@ g_dbus_server_class_init (GDBusServerClass *klass)
* GDBusServer:active: * GDBusServer:active:
* *
* Whether the server is currently active. * Whether the server is currently active.
*
* Since: 2.26
*/ */
g_object_class_install_property (gobject_class, g_object_class_install_property (gobject_class,
PROP_ACTIVE, PROP_ACTIVE,
@ -305,6 +315,8 @@ g_dbus_server_class_init (GDBusServerClass *klass)
* GDBusServer:authentication-observer: * GDBusServer:authentication-observer:
* *
* A #GDBusAuthObserver object to assist in the authentication process or %NULL. * A #GDBusAuthObserver object to assist in the authentication process or %NULL.
*
* Since: 2.26
*/ */
g_object_class_install_property (gobject_class, g_object_class_install_property (gobject_class,
PROP_AUTHENTICATION_OBSERVER, PROP_AUTHENTICATION_OBSERVER,
@ -338,6 +350,8 @@ g_dbus_server_class_init (GDBusServerClass *klass)
* connection. Otherwise the signal is emitted in the <link * connection. Otherwise the signal is emitted 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 that @server was constructed in. * loop</link> of the thread that @server was constructed in.
*
* Since: 2.26
*/ */
_signals[NEW_CONNECTION_SIGNAL] = g_signal_new ("new-connection", _signals[NEW_CONNECTION_SIGNAL] = g_signal_new ("new-connection",
G_TYPE_DBUS_SERVER, G_TYPE_DBUS_SERVER,
@ -399,6 +413,8 @@ on_run (GSocketService *service,
* *
* Returns: A #GDBusServer or %NULL if @error is set. Free with * Returns: A #GDBusServer or %NULL if @error is set. Free with
* g_object_unref(). * g_object_unref().
*
* Since: 2.26
*/ */
GDBusServer * GDBusServer *
g_dbus_server_new_sync (const gchar *address, g_dbus_server_new_sync (const gchar *address,
@ -444,6 +460,8 @@ g_dbus_server_new_sync (const gchar *address,
* *
* 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.
*
* Since: 2.26
*/ */
const gchar * const gchar *
g_dbus_server_get_client_address (GDBusServer *server) g_dbus_server_get_client_address (GDBusServer *server)
@ -459,6 +477,8 @@ g_dbus_server_get_client_address (GDBusServer *server)
* Gets the GUID for @server. * Gets the GUID for @server.
* *
* Returns: A D-Bus GUID. Do not free this string, it is owned by @server. * Returns: A D-Bus GUID. Do not free this string, it is owned by @server.
*
* Since: 2.26
*/ */
const gchar * const gchar *
g_dbus_server_get_guid (GDBusServer *server) g_dbus_server_get_guid (GDBusServer *server)
@ -474,6 +494,8 @@ g_dbus_server_get_guid (GDBusServer *server)
* Gets the flags for @server. * Gets the flags for @server.
* *
* Returns: A set of flags from the #GDBusServerFlags enumeration. * Returns: A set of flags from the #GDBusServerFlags enumeration.
*
* Since: 2.26
*/ */
GDBusServerFlags GDBusServerFlags
g_dbus_server_get_flags (GDBusServer *server) g_dbus_server_get_flags (GDBusServer *server)
@ -489,6 +511,8 @@ g_dbus_server_get_flags (GDBusServer *server)
* Gets whether @server is active. * Gets whether @server is active.
* *
* Returns: %TRUE if server is active, %FALSE otherwise. * Returns: %TRUE if server is active, %FALSE otherwise.
*
* Since: 2.26
*/ */
gboolean gboolean
g_dbus_server_is_active (GDBusServer *server) g_dbus_server_is_active (GDBusServer *server)
@ -502,6 +526,8 @@ g_dbus_server_is_active (GDBusServer *server)
* @server: A #GDBusServer. * @server: A #GDBusServer.
* *
* Starts @server. * Starts @server.
*
* Since: 2.26
*/ */
void void
g_dbus_server_start (GDBusServer *server) g_dbus_server_start (GDBusServer *server)
@ -521,6 +547,8 @@ g_dbus_server_start (GDBusServer *server)
* @server: A #GDBusServer. * @server: A #GDBusServer.
* *
* Stops @server. * Stops @server.
*
* Since: 2.26
*/ */
void void
g_dbus_server_stop (GDBusServer *server) g_dbus_server_stop (GDBusServer *server)

View File

@ -42,6 +42,8 @@ typedef struct _GDBusServerPrivate GDBusServerPrivate;
* *
* The #GDBusServer structure contains only private data and * The #GDBusServer structure contains only private data and
* should only be accessed using the provided API. * should only be accessed using the provided API.
*
* Since: 2.26
*/ */
struct _GDBusServer struct _GDBusServer
{ {
@ -55,6 +57,8 @@ struct _GDBusServer
* @new_connection: Signal class handler for the #GDBusServer::new-connection signal. * @new_connection: Signal class handler for the #GDBusServer::new-connection signal.
* *
* Class structure for #GDBusServer. * Class structure for #GDBusServer.
*
* Since: 2.26
*/ */
struct _GDBusServerClass struct _GDBusServerClass
{ {

View File

@ -116,6 +116,8 @@ is_valid_name (const gchar *start,
* Checks if @string is a valid D-Bus bus name (either unique or well-known). * Checks if @string is a valid D-Bus bus name (either unique or well-known).
* *
* Returns: %TRUE if valid, %FALSE otherwise. * Returns: %TRUE if valid, %FALSE otherwise.
*
* Since: 2.26
*/ */
gboolean gboolean
g_dbus_is_name (const gchar *string) g_dbus_is_name (const gchar *string)
@ -164,6 +166,8 @@ g_dbus_is_name (const gchar *string)
* Checks if @string is a valid D-Bus unique bus name. * Checks if @string is a valid D-Bus unique bus name.
* *
* Returns: %TRUE if valid, %FALSE otherwise. * Returns: %TRUE if valid, %FALSE otherwise.
*
* Since: 2.26
*/ */
gboolean gboolean
g_dbus_is_unique_name (const gchar *string) g_dbus_is_unique_name (const gchar *string)
@ -198,6 +202,8 @@ g_dbus_is_unique_name (const gchar *string)
* Checks if @string is a valid D-Bus member (e.g. signal or method) name. * Checks if @string is a valid D-Bus member (e.g. signal or method) name.
* *
* Returns: %TRUE if valid, %FALSE otherwise. * Returns: %TRUE if valid, %FALSE otherwise.
*
* Since: 2.26
*/ */
gboolean gboolean
g_dbus_is_member_name (const gchar *string) g_dbus_is_member_name (const gchar *string)
@ -233,6 +239,8 @@ g_dbus_is_member_name (const gchar *string)
* Checks if @string is a valid D-Bus interface name. * Checks if @string is a valid D-Bus interface name.
* *
* Returns: %TRUE if valid, %FALSE otherwise. * Returns: %TRUE if valid, %FALSE otherwise.
*
* Since: 2.26
*/ */
gboolean gboolean
g_dbus_is_interface_name (const gchar *string) g_dbus_is_interface_name (const gchar *string)
@ -282,6 +290,8 @@ g_dbus_is_interface_name (const gchar *string)
* GUID (for example, D-Bus GUIDs are not RFC-4122 compliant). * GUID (for example, D-Bus GUIDs are not RFC-4122 compliant).
* *
* Returns: A valid D-Bus GUID. Free with g_free(). * Returns: A valid D-Bus GUID. Free with g_free().
*
* Since: 2.26
*/ */
gchar * gchar *
g_dbus_generate_guid (void) g_dbus_generate_guid (void)
@ -317,6 +327,8 @@ g_dbus_generate_guid (void)
* GUID (for example, D-Bus GUIDs are not RFC-4122 compliant). * GUID (for example, D-Bus GUIDs are not RFC-4122 compliant).
* *
* Returns: %TRUE if @string is a guid, %FALSE otherwise. * Returns: %TRUE if @string is a guid, %FALSE otherwise.
*
* Since: 2.26
*/ */
gboolean gboolean
g_dbus_is_guid (const gchar *string) g_dbus_is_guid (const gchar *string)
@ -344,13 +356,14 @@ g_dbus_is_guid (const gchar *string)
/* ---------------------------------------------------------------------------------------------------- */ /* ---------------------------------------------------------------------------------------------------- */
/** /**
* g_dbus_is_activated: * g_dbus_is_activated:
* *
* Determine if the process has been activated by a message bus. * Determine if the process has been activated by a message bus.
* *
* Returns: %TRUE if this process has been started by a message bus, %FALSE otherwise. * Returns: %TRUE if this process has been started by a message bus, %FALSE otherwise.
*
* Since: 2.26
*/ */
gboolean gboolean
g_dbus_is_activated (void) g_dbus_is_activated (void)

View File

@ -746,6 +746,8 @@ typedef enum {
* @G_BUS_TYPE_STARTER: Connect to the bus that activated the program. * @G_BUS_TYPE_STARTER: Connect to the bus that activated the program.
* *
* An enumeration to specify the type of a #GDBusConnection. * An enumeration to specify the type of a #GDBusConnection.
*
* Since: 2.26
*/ */
typedef enum typedef enum
{ {
@ -763,6 +765,8 @@ typedef enum
* specified #G_BUS_NAME_OWNER_FLAGS_ALLOW_REPLACEMENT, then take the name from the other connection. * specified #G_BUS_NAME_OWNER_FLAGS_ALLOW_REPLACEMENT, then take the name from the other connection.
* *
* Flags used in g_bus_own_name(). * Flags used in g_bus_own_name().
*
* Since: 2.26
*/ */
typedef enum typedef enum
{ {
@ -779,6 +783,8 @@ typedef enum
* name. * name.
* *
* Flags used in g_bus_watch_name(). * Flags used in g_bus_watch_name().
*
* Since: 2.26
*/ */
typedef enum typedef enum
{ {
@ -793,6 +799,8 @@ typedef enum
* @G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS: Don't connect to signals on the remote object. * @G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS: Don't connect to signals on the remote object.
* *
* Flags used when constructing an instance of a #GDBusProxy derived class. * Flags used when constructing an instance of a #GDBusProxy derived class.
*
* Since: 2.26
*/ */
typedef enum typedef enum
{ {
@ -897,6 +905,8 @@ typedef enum
* There's already an object with the requested object path. * There's already an object with the requested object path.
* *
* Error codes for the %G_DBUS_ERROR error domain. * Error codes for the %G_DBUS_ERROR error domain.
*
* Since: 2.26
*/ */
typedef enum typedef enum
{ {
@ -943,7 +953,7 @@ typedef enum
G_DBUS_ERROR_ADT_AUDIT_DATA_UNKNOWN, /* org.freedesktop.DBus.Error.AdtAuditDataUnknown */ G_DBUS_ERROR_ADT_AUDIT_DATA_UNKNOWN, /* org.freedesktop.DBus.Error.AdtAuditDataUnknown */
G_DBUS_ERROR_OBJECT_PATH_IN_USE, /* org.freedesktop.DBus.Error.ObjectPathInUse */ G_DBUS_ERROR_OBJECT_PATH_IN_USE, /* org.freedesktop.DBus.Error.ObjectPathInUse */
} GDBusError; } GDBusError;
/* TODO: remember to update g_dbus_error_quark() in gdbuserror.c if you extend this enumeration */ /* Remember to update g_dbus_error_quark() in gdbuserror.c if you extend this enumeration */
/** /**
* GDBusConnectionFlags: * GDBusConnectionFlags:
@ -957,6 +967,8 @@ typedef enum
* message bus. This means that the Hello() method will be invoked as part of the connection setup. * message bus. This means that the Hello() method will be invoked as part of the connection setup.
* *
* Flags used when creating a new #GDBusConnection. * Flags used when creating a new #GDBusConnection.
*
* Since: 2.26
*/ */
typedef enum { typedef enum {
G_DBUS_CONNECTION_FLAGS_NONE = 0, G_DBUS_CONNECTION_FLAGS_NONE = 0,
@ -973,6 +985,8 @@ typedef enum {
* supports exchanging UNIX file descriptors with the remote peer. * supports exchanging UNIX file descriptors with the remote peer.
* *
* Capabilities negotiated with the remote peer. * Capabilities negotiated with the remote peer.
*
* Since: 2.26
*/ */
typedef enum { typedef enum {
G_DBUS_CAPABILITY_FLAGS_NONE = 0, G_DBUS_CAPABILITY_FLAGS_NONE = 0,
@ -987,6 +1001,8 @@ typedef enum {
* invocation. * invocation.
* *
* Flags used in g_dbus_connection_invoke_method() and similar APIs. * Flags used in g_dbus_connection_invoke_method() and similar APIs.
*
* Since: 2.26
*/ */
typedef enum { typedef enum {
G_DBUS_INVOKE_METHOD_FLAGS_NONE = 0, G_DBUS_INVOKE_METHOD_FLAGS_NONE = 0,
@ -1002,6 +1018,8 @@ typedef enum {
* @G_DBUS_MESSAGE_TYPE_SIGNAL: Signal emission. * @G_DBUS_MESSAGE_TYPE_SIGNAL: Signal emission.
* *
* Message types used in #GDBusMessage. * Message types used in #GDBusMessage.
*
* Since: 2.26
*/ */
typedef enum { typedef enum {
G_DBUS_MESSAGE_TYPE_INVALID, G_DBUS_MESSAGE_TYPE_INVALID,
@ -1019,6 +1037,8 @@ typedef enum {
* owner for the destination name in response to this message. * owner for the destination name in response to this message.
* *
* Message flags used in #GDBusMessage. * Message flags used in #GDBusMessage.
*
* Since: 2.26
*/ */
typedef enum { typedef enum {
G_DBUS_MESSAGE_FLAGS_NONE = 0, G_DBUS_MESSAGE_FLAGS_NONE = 0,
@ -1040,6 +1060,8 @@ typedef enum {
* @G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS: The number of UNIX file descriptors that accompany the message. * @G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS: The number of UNIX file descriptors that accompany the message.
* *
* Header fields used in #GDBusMessage. * Header fields used in #GDBusMessage.
*
* Since: 2.26
*/ */
typedef enum { typedef enum {
G_DBUS_MESSAGE_HEADER_FIELD_INVALID, G_DBUS_MESSAGE_HEADER_FIELD_INVALID,
@ -1061,6 +1083,8 @@ typedef enum {
* @G_DBUS_PROPERTY_INFO_FLAGS_WRITABLE: Property is writable. * @G_DBUS_PROPERTY_INFO_FLAGS_WRITABLE: Property is writable.
* *
* Flags describing the access control of a D-Bus property. * Flags describing the access control of a D-Bus property.
*
* Since: 2.26
*/ */
typedef enum typedef enum
{ {
@ -1077,6 +1101,8 @@ typedef enum
* to dynamically spawn objects in the subtree. * to dynamically spawn objects in the subtree.
* *
* Flags passed to g_dbus_connection_register_subtree(). * Flags passed to g_dbus_connection_register_subtree().
*
* Since: 2.26
*/ */
typedef enum typedef enum
{ {
@ -1094,6 +1120,8 @@ typedef enum
* authentication method. * authentication method.
* *
* Flags used when creating a #GDBusServer. * Flags used when creating a #GDBusServer.
*
* Since: 2.26
*/ */
typedef enum typedef enum
{ {

View File

@ -252,6 +252,8 @@ g_unix_credentials_message_class_init (GUnixCredentialsMessageClass *class)
* GUnixCredentialsMessage:credentials: * GUnixCredentialsMessage:credentials:
* *
* The credentials stored in the message. * The credentials stored in the message.
*
* Since: 2.26
*/ */
g_object_class_install_property (gobject_class, g_object_class_install_property (gobject_class,
PROP_CREDENTIALS, PROP_CREDENTIALS,
@ -331,6 +333,8 @@ g_unix_credentials_message_new_with_credentials (GCredentials *credentials)
* Gets the credentials stored in @message. * Gets the credentials stored in @message.
* *
* Returns: A #GCredentials instance. Do not free, it is owned by @message. * Returns: A #GCredentials instance. Do not free, it is owned by @message.
*
* Since: 2.26
*/ */
GCredentials * GCredentials *
g_unix_credentials_message_get_credentials (GUnixCredentialsMessage *message) g_unix_credentials_message_get_credentials (GUnixCredentialsMessage *message)

View File

@ -39,6 +39,13 @@ G_BEGIN_DECLS
typedef struct _GUnixCredentialsMessagePrivate GUnixCredentialsMessagePrivate; typedef struct _GUnixCredentialsMessagePrivate GUnixCredentialsMessagePrivate;
typedef struct _GUnixCredentialsMessageClass GUnixCredentialsMessageClass; typedef struct _GUnixCredentialsMessageClass GUnixCredentialsMessageClass;
/**
* GUnixCredentialsMessageClass:
*
* Class structure for #GUnixCredentialsMessage.
*
* Since: 2.26
*/
struct _GUnixCredentialsMessageClass struct _GUnixCredentialsMessageClass
{ {
GSocketControlMessageClass parent_class; GSocketControlMessageClass parent_class;
@ -50,6 +57,14 @@ struct _GUnixCredentialsMessageClass
void (*_g_reserved2) (void); void (*_g_reserved2) (void);
}; };
/**
* GUnixCredentialsMessage:
*
* The #GUnixCredentialsMessage structure contains only private data
* and should only be accessed using the provided API.
*
* Since: 2.26
*/
struct _GUnixCredentialsMessage struct _GUnixCredentialsMessage
{ {
GSocketControlMessage parent_instance; GSocketControlMessage parent_instance;