<xi:include href="xml/gdbusmessage.xml"/>
<xi:include href="xml/gdbusconnection.xml"/>
<xi:include href="xml/gdbusmethodinvocation.xml"/>
- <xi:include href="xml/gdbusproxy.xml"/>
<xi:include href="xml/gdbusserver.xml"/>
<xi:include href="xml/gdbusauthobserver.xml"/>
</chapter>
<xi:include href="xml/gdbusnameowning.xml"/>
<xi:include href="xml/gdbusnamewatching.xml"/>
<xi:include href="xml/gdbusproxywatching.xml"/>
+ <xi:include href="xml/gdbusproxy.xml"/>
</chapter>
<chapter id="utils">
<title>Utilities</title>
* Creates a new empty credentials object.
*
* Returns: A #GCredentials. Free with g_object_unref().
+ *
+ * Since: 2.26
*/
GCredentials *
g_credentials_new (void)
* platform.
*
* Returns: A #GCredentials. Free with g_object_unref().
+ *
+ * Since: 2.26
*/
GCredentials *
g_credentials_new_for_process (void)
*
* Returns: A #GCredentials or %NULL if @error is set. The return
* object must be freed with g_object_unref().
+ *
+ * Since: 2.26
*/
GCredentials *
g_credentials_new_for_string (const gchar *str,
* g_credentials_new_for_string().
*
* Returns: A string that should be freed with g_free().
+ *
+ * Since: 2.26
*/
gchar *
g_credentials_to_string (GCredentials *credentials)
* Checks if @credentials has a UNIX user credential.
*
* Returns: %TRUE if @credentials has this type of credential, %FALSE otherwise.
+ *
+ * Since: 2.26
*/
gboolean
g_credentials_has_unix_user (GCredentials *credentials)
* Gets the UNIX user identifier from @credentials.
*
* Returns: The identifier or -1 if unset.
+ *
+ * Since: 2.26
*/
gint64
g_credentials_get_unix_user (GCredentials *credentials)
* @user_id: A UNIX user identifier (typically type #uid_t) or -1 to unset it.
*
* Sets the UNIX user identifier.
+ *
+ * Since: 2.26
*/
void
g_credentials_set_unix_user (GCredentials *credentials,
* Checks if @credentials has a UNIX group credential.
*
* Returns: %TRUE if @credentials has this type of credential, %FALSE otherwise.
+ *
+ * Since: 2.26
*/
gboolean
g_credentials_has_unix_group (GCredentials *credentials)
* Gets the UNIX group identifier from @credentials.
*
* Returns: The identifier or -1 if unset.
+ *
+ * Since: 2.26
*/
gint64
g_credentials_get_unix_group (GCredentials *credentials)
* @group_id: A UNIX group identifier (typically type #gid_t) or -1 to unset.
*
* Sets the UNIX group identifier.
+ *
+ * Since: 2.26
*/
void
g_credentials_set_unix_group (GCredentials *credentials,
* Checks if @credentials has a UNIX process credential.
*
* Returns: %TRUE if @credentials has this type of credential, %FALSE otherwise.
+ *
+ * Since: 2.26
*/
gboolean
g_credentials_has_unix_process (GCredentials *credentials)
* Gets the UNIX process identifier from @credentials.
*
* Returns: The identifier or -1 if unset.
+ *
+ * Since: 2.26
*/
gint64
g_credentials_get_unix_process (GCredentials *credentials)
* @process_id: A UNIX process identifier (typically type #pid_t/#GPid) or -1 to unset.
*
* Sets the UNIX process identifier.
+ *
+ * Since: 2.26
*/
void
g_credentials_set_unix_process (GCredentials *credentials,
* Checks if @credentials has a Windows user SID (Security Identifier).
*
* Returns: %TRUE if @credentials has this type of credential, %FALSE otherwise.
+ *
+ * Since: 2.26
*/
gboolean
g_credentials_has_windows_user (GCredentials *credentials)
* Gets the Windows User SID from @credentials.
*
* Returns: A string or %NULL if unset. Do not free, the string is owned by @credentials.
+ *
+ * Since: 2.26
*/
const gchar *
g_credentials_get_windows_user (GCredentials *credentials)
* @user_sid: The Windows User SID or %NULL to unset.
*
* Sets the Windows User SID.
+ *
+ * Since: 2.26
*/
void
g_credentials_set_windows_user (GCredentials *credentials,
*
* The #GCredentials structure contains only private data and
* should only be accessed using the provided API.
+ *
+ * Since: 2.26
*/
struct _GCredentials
{
* GCredentialsClass:
*
* Class structure for #GCredentials.
+ *
+ * Since: 2.26
*/
struct _GCredentialsClass
{
* checks.
*
* Returns: %TRUE if @string is a valid D-Bus address, %FALSE otherwise.
+ *
+ * Since: 2.26
*/
gboolean
g_dbus_is_address (const gchar *string)
*
* Returns: %TRUE if @string is a valid D-Bus address that is
* supported by this library, %FALSE if @error is set.
+ *
+ * Since: 2.26
*/
gboolean
g_dbus_is_supported_address (const gchar *string,
*
* This is an asynchronous failable function. See
* g_dbus_address_get_stream_sync() for the synchronous version.
+ *
+ * Since: 2.26
*/
void
g_dbus_address_get_stream (const gchar *address,
* Finishes an operation started with g_dbus_address_get_stream().
*
* Returns: A #GIOStream or %NULL if @error is set.
+ *
+ * Since: 2.26
*/
GIOStream *
g_dbus_address_get_stream_finish (GAsyncResult *res,
* g_dbus_address_get_stream() for the asynchronous version.
*
* Returns: A #GIOStream or %NULL if @error is set.
+ *
+ * Since: 2.26
*/
GIOStream *
g_dbus_address_get_stream_sync (const gchar *address,
* platform specific mechanisms.
*
* Returns: A valid D-Bus address string for @bus_type or %NULL if @error is set.
+ *
+ * Since: 2.26
*/
gchar *
g_dbus_address_get_for_bus_sync (GBusType bus_type,
* should be denied.
*
* Returns: %TRUE if the peer should be denied, %FALSE otherwise.
+ *
+ * Since: 2.26
*/
signals[DENY_AUTHENTICATED_PEER_SIGNAL] =
g_signal_new ("deny-authenticated-peer",
* Creates a new #GDBusAuthObserver object.
*
* Returns: A #GDBusAuthObserver. Free with g_object_unref().
+ *
+ * Since: 2.26
*/
GDBusAuthObserver *
g_dbus_auth_observer_new (void)
* Emits the #GDBusAuthObserver::deny-authenticated-peer signal on @observer.
*
* Returns: %TRUE if the peer should be denied, %FALSE otherwise.
+ *
+ * Since: 2.26
*/
gboolean
g_dbus_auth_observer_deny_authenticated_peer (GDBusAuthObserver *observer,
* @deny_authenticated_peer: Signal class handler for the #GDBusAuthObserver::deny-authenticated-peer signal.
*
* Class structure for #GDBusAuthObserverClass.
+ *
+ * Since: 2.26
*/
struct _GDBusAuthObserverClass
{
*
* The #GDBusAuthObserver structure contains only private data and
* should only be accessed using the provided API.
+ *
+ * Since: 2.26
*/
struct _GDBusAuthObserver
{
* GDBusConnection:stream:
*
* The underlying #GIOStream used for I/O.
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_STREAM,
*
* A D-Bus address specifying potential endpoints that can be used
* when establishing the connection.
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_ADDRESS,
* GDBusConnection:flags:
*
* Flags from the #GDBusConnectionFlags enumeration.
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_FLAGS,
* #GDBusConnection:flags property you will be able to read the GUID
* of the other peer here after the connection has been succesfully
* initialized.
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_GUID,
*
* The unique name as assigned by the message bus or %NULL if the
* connection is not open or not a message bus connection.
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_UNIQUE_NAME,
* GDBusConnection:closed:
*
* A boolean specifying whether the connection has been closed.
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_CLOSED,
* A boolean specifying whether the process will be terminated (by
* calling <literal>raise(SIGTERM)</literal>) if the connection
* is closed by the remote peer.
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_EXIT_ON_CLOSE,
*
* Flags from the #GDBusCapabilityFlags enumeration
* representing connection features negotiated with the other peer.
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_CAPABILITY_FLAGS,
* GDBusConnection:authentication-observer:
*
* A #GDBusAuthObserver object to assist in the authentication process or %NULL.
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_AUTHENTICATION_OBSERVER,
* Upon receiving this signal, you should give up your reference to
* @connection. You are guaranteed that this signal is emitted only
* once.
+ *
+ * Since: 2.26
*/
signals[CLOSED_SIGNAL] = g_signal_new ("closed",
G_TYPE_DBUS_CONNECTION,
* Gets whether @connection is closed.
*
* Returns: %TRUE if the connection is closed, %FALSE otherwise.
- **/
+ *
+ * Since: 2.26
+ */
gboolean
g_dbus_connection_is_closed (GDBusConnection *connection)
{
* Gets the capabilities negotiated with the remote peer
*
* Returns: One or more flags from the #GDBusCapabilityFlags enumeration.
+ *
+ * Since: 2.26
*/
GDBusCapabilityFlags
g_dbus_connection_get_capabilities (GDBusConnection *connection)
* bus connection disconnects).
*
* If @connection is already closed, this method does nothing.
+ *
+ * Since: 2.26
*/
void
g_dbus_connection_close (GDBusConnection *connection)
*
* Returns: %TRUE if the message was well-formed and queued for
* transmission, %FALSE if @error is set.
+ *
+ * Since: 2.26
*/
gboolean
g_dbus_connection_send_message (GDBusConnection *connection,
* See <xref linkend="gdbus-server"/> and <xref
* linkend="gdbus-unix-fd-client"/> for an example of how to use this
* low-level API to send and receive UNIX file descriptors.
+ *
+ * Since: 2.26
*/
void
g_dbus_connection_send_message_with_reply (GDBusConnection *connection,
* low-level API to send and receive UNIX file descriptors.
*
* Returns: A #GDBusMessage or %NULL if @error is set.
+ *
+ * Since: 2.26
*/
GDBusMessage *
g_dbus_connection_send_message_with_reply_finish (GDBusConnection *connection,
* 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.
+ *
+ * Since: 2.26
*/
GDBusMessage *
g_dbus_connection_send_message_with_reply_sync (GDBusConnection *connection,
* This is a asynchronous failable constructor. See
* g_dbus_connection_new_sync() for the synchronous
* version.
+ *
+ * Since: 2.26
*/
void
g_dbus_connection_new (GIOStream *stream,
* Finishes an operation started with g_dbus_connection_new().
*
* Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
+ *
+ * Since: 2.26
*/
GDBusConnection *
g_dbus_connection_new_finish (GAsyncResult *res,
* g_dbus_connection_new() for the asynchronous version.
*
* Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
+ *
+ * Since: 2.26
*/
GDBusConnection *
g_dbus_connection_new_sync (GIOStream *stream,
* This is a asynchronous failable constructor. See
* g_dbus_connection_new_for_address_sync() for the synchronous
* version.
+ *
+ * Since: 2.26
*/
void
g_dbus_connection_new_for_address (const gchar *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().
+ *
+ * Since: 2.26
*/
GDBusConnection *
g_dbus_connection_new_for_address_finish (GAsyncResult *res,
* g_dbus_connection_new_for_address() for the asynchronous version.
*
* Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
+ *
+ * Since: 2.26
*/
GDBusConnection *
g_dbus_connection_new_for_address_sync (const gchar *address,
* Sets whether the process should be terminated when @connection is
* closed by the remote peer. See #GDBusConnection:exit-on-close for
* more details.
+ *
+ * Since: 2.26
*/
void
g_dbus_connection_set_exit_on_close (GDBusConnection *connection,
*
* Returns: Whether the process is terminated when @connection is
* closed by the remote peer.
+ *
+ * Since: 2.26
*/
gboolean
g_dbus_connection_get_exit_on_close (GDBusConnection *connection)
*
* Returns: The GUID. Do not free this string, it is owned by
* @connection.
- **/
+ *
+ * Since: 2.26
+ */
const gchar *
g_dbus_connection_get_guid (GDBusConnection *connection)
{
* Returns: The unique name or %NULL if @connection is not a message
* bus connection. Do not free this string, it is owned by
* @connection.
- **/
+ *
+ * Since: 2.26
+ */
const gchar *
g_dbus_connection_get_unique_name (GDBusConnection *connection)
{
*
* Returns: A #GCredentials or %NULL if not available. Do not free
* this object, it is owned by @connection.
+ *
+ * Since: 2.26
*/
GCredentials *
g_dbus_connection_get_peer_credentials (GDBusConnection *connection)
*
* Returns: A filter identifier that can be used with
* g_dbus_connection_remove_filter().
+ *
+ * Since: 2.26
*/
guint
g_dbus_connection_add_filter (GDBusConnection *connection,
* call g_dbus_connection_signal_unsubscribe() to remove a subscription.
*
* Returns: A subscription identifier that can be used with g_dbus_connection_signal_unsubscribe().
- **/
+ *
+ * Since: 2.26
+ */
guint
g_dbus_connection_signal_subscribe (GDBusConnection *connection,
const gchar *sender,
* @subscription_id: A subscription id obtained from g_dbus_connection_signal_subscribe().
*
* Unsubscribes from signals.
- **/
+ *
+ * Since: 2.26
+ */
void
g_dbus_connection_signal_unsubscribe (GDBusConnection *connection,
guint subscription_id)
*
* Returns: 0 if @error is set, otherwise a registration id (never 0)
* that can be used with g_dbus_connection_unregister_object() .
+ *
+ * Since: 2.26
*/
guint
g_dbus_connection_register_object (GDBusConnection *connection,
* Unregisters an object.
*
* Returns: %TRUE if the object was unregistered, %FALSE otherwise.
+ *
+ * Since: 2.26
*/
gboolean
g_dbus_connection_unregister_object (GDBusConnection *connection,
* This can only fail if @parameters is not compatible with the D-Bus protocol.
*
* Returns: %TRUE unless @error is set.
+ *
+ * Since: 2.26
*/
gboolean
g_dbus_connection_emit_signal (GDBusConnection *connection,
* 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
* function.
+ *
+ * Since: 2.26
*/
void
g_dbus_connection_invoke_method (GDBusConnection *connection,
*
* Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
* return values. Free with g_variant_unref().
+ *
+ * Since: 2.26
*/
GVariant *
g_dbus_connection_invoke_method_finish (GDBusConnection *connection,
*
* Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
* return values. Free with g_variant_unref().
+ *
+ * Since: 2.26
*/
GVariant *
g_dbus_connection_invoke_method_sync (GDBusConnection *connection,
*
* Returns: 0 if @error is set, otherwise a subtree registration id (never 0)
* that can be used with g_dbus_connection_unregister_subtree() .
+ *
+ * Since: 2.26
*/
guint
g_dbus_connection_register_subtree (GDBusConnection *connection,
* Unregisters a subtree.
*
* Returns: %TRUE if the subtree was unregistered, %FALSE otherwise.
+ *
+ * Since: 2.26
*/
gboolean
g_dbus_connection_unregister_subtree (GDBusConnection *connection,
* the #GDBusConnection:exit-on-close property set to %TRUE.
*
* Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
+ *
+ * Since: 2.26
*/
GDBusConnection *
g_bus_get_sync (GBusType bus_type,
*
* This is a asynchronous failable function. See g_bus_get_sync() for
* the synchronous version.
+ *
+ * Since: 2.26
*/
void
g_bus_get (GBusType bus_type,
* the #GDBusConnection:exit-on-close property set to %TRUE.
*
* Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
+ *
+ * Since: 2.26
*/
GDBusConnection *
g_bus_get_finish (GAsyncResult *res,
*
* The #GDBusConnection structure contains only private data and
* should only be accessed using the provided API.
+ *
+ * Since: 2.26
*/
struct _GDBusConnection
{
* @closed: Signal class handler for the #GDBusConnection::closed signal.
*
* Class structure for #GDBusConnection.
+ *
+ * Since: 2.26
*/
struct _GDBusConnectionClass
{
* @user_data: The @user_data #gpointer passed to g_dbus_connection_register_object().
*
* The type of the @method_call function in #GDBusInterfaceVTable.
+ *
+ * Since: 2.26
*/
typedef void (*GDBusInterfaceMethodCallFunc) (GDBusConnection *connection,
const gchar *sender,
* 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.
+ *
+ * Since: 2.26
*/
typedef GVariant *(*GDBusInterfaceGetPropertyFunc) (GDBusConnection *connection,
const gchar *sender,
* The type of the @set_property function in #GDBusInterfaceVTable.
*
* Returns: %TRUE if the property was set to @value, %FALSE if @error is set.
+ *
+ * Since: 2.26
*/
typedef gboolean (*GDBusInterfaceSetPropertyFunc) (GDBusConnection *connection,
const gchar *sender,
* If you want to handle getting/setting D-Bus properties asynchronously, simply
* register an object with the <literal>org.freedesktop.DBus.Properties</literal>
* D-Bus interface using g_dbus_connection_register_object().
+ *
+ * Since: 2.26
*/
struct _GDBusInterfaceVTable
{
* The type of the @enumerate function in #GDBusSubtreeVTable.
*
* Returns: A newly allocated array of strings for node names that are children of @object_path.
+ *
+ * Since: 2.26
*/
typedef gchar** (*GDBusSubtreeEnumerateFunc) (GDBusConnection *connection,
const gchar *sender,
*
* Returns: A newly-allocated #GPtrArray with pointers to #GDBusInterfaceInfo describing
* the interfaces implemented by @node.
+ *
+ * Since: 2.26
*/
typedef GPtrArray *(*GDBusSubtreeIntrospectFunc) (GDBusConnection *connection,
const gchar *sender,
* The type of the @dispatch function in #GDBusSubtreeVTable.
*
* Returns: A #GDBusInterfaceVTable or %NULL if you don't want to handle the methods.
+ *
+ * Since: 2.26
*/
typedef const GDBusInterfaceVTable * (*GDBusSubtreeDispatchFunc) (GDBusConnection *connection,
const gchar *sender,
* @dispatch: Function for dispatching a remote call on a child node.
*
* Virtual table for handling subtrees registered with g_dbus_connection_register_subtree().
+ *
+ * Since: 2.26
*/
struct _GDBusSubtreeVTable
{
* @user_data: User data passed when subscribing to the signal.
*
* Signature for callback function used in g_dbus_connection_signal_subscribe().
+ *
+ * Since: 2.26
*/
typedef void (*GDBusSignalCallback) (GDBusConnection *connection,
const gchar *sender_name,
*
* Returns: %TRUE if the filter handled @message, %FALSE to let other
* handlers run.
+ *
+ * Since: 2.26
*/
typedef gboolean (*GDBusMessageFilterFunction) (GDBusConnection *connection,
GDBusMessage *message,
* @num_entries: Number of items to register.
*
* Helper function for associating a #GError error domain with D-Bus error names.
+ *
+ * Since: 2.26
*/
void
g_dbus_error_register_error_domain (const gchar *error_domain_quark_name,
*
* Returns: %TRUE if the association was created, %FALSE if it already
* exists.
+ *
+ * Since: 2.26
*/
gboolean
g_dbus_error_register_error (GQuark error_domain,
* 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.
+ *
+ * Since: 2.26
*/
gboolean
g_dbus_error_unregister_error (GQuark error_domain,
*
* Returns: %TRUE if @error represents an error from a remote peer,
* %FALSE otherwise.
+ *
+ * Since: 2.26
*/
gboolean
g_dbus_error_is_remote_error (const GError *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().
+ *
+ * Since: 2.26
*/
gchar *
g_dbus_error_get_remote_error (const GError *error)
* it.
*
* Returns: An allocated #GError. Free with g_error_free().
+ *
+ * Since: 2.26
*/
GError *
g_dbus_error_new_for_dbus_error (const gchar *dbus_error_name,
* Does nothing if @error is %NULL. Otherwise sets *@error to
* a new #GError created with g_dbus_error_new_for_dbus_error()
* with @dbus_error_message prepend with @format (unless %NULL).
+ *
+ * Since: 2.26
*/
void
g_dbus_error_set_dbus_error (GError **error,
* @var_args: Arguments for @format.
*
* Like g_dbus_error_set_dbus_error() but intended for language bindings.
+ *
+ * Since: 2.26
*/
void
g_dbus_error_set_dbus_error_valist (GError **error,
* This is typically used when presenting errors to the end user.
*
* Returns: %TRUE if information was stripped, %FALSE otherwise.
+ *
+ * Since: 2.26
*/
gboolean
g_dbus_error_strip_remote_error (GError *error)
* #GError on the wire. Regular applications should not use it.
*
* Returns: A D-Bus error name (never %NULL). Free with g_free().
+ *
+ * Since: 2.26
*/
gchar *
g_dbus_error_encode_gerror (const GError *error)
* returning errors from a remote message bus process. Errors
* generated locally in-process by e.g. #GDBusConnection is from the
* %G_IO_ERROR domain.
+ *
+ * Since: 2.26
*/
#define G_DBUS_ERROR g_dbus_error_quark()
* @dbus_error_name: The D-Bus error name to associate with @error_code.
*
* Struct used in g_dbus_error_register_error_domain().
+ *
+ * Since: 2.26
*/
struct _GDBusErrorEntry
{
* the reference count.
*
* Returns: The same @info.
+ *
+ * Since: 2.26
*/
GDBusNodeInfo *
g_dbus_node_info_ref (GDBusNodeInfo *info)
* the reference count.
*
* Returns: The same @info.
+ *
+ * Since: 2.26
*/
GDBusInterfaceInfo *
g_dbus_interface_info_ref (GDBusInterfaceInfo *info)
* the reference count.
*
* Returns: The same @info.
+ *
+ * Since: 2.26
*/
GDBusMethodInfo *
g_dbus_method_info_ref (GDBusMethodInfo *info)
* the reference count.
*
* Returns: The same @info.
+ *
+ * Since: 2.26
*/
GDBusSignalInfo *
g_dbus_signal_info_ref (GDBusSignalInfo *info)
* the reference count.
*
* Returns: The same @info.
+ *
+ * Since: 2.26
*/
GDBusPropertyInfo *
g_dbus_property_info_ref (GDBusPropertyInfo *info)
* the reference count.
*
* Returns: The same @info.
+ *
+ * Since: 2.26
*/
GDBusArgInfo *
g_dbus_arg_info_ref (GDBusArgInfo *info)
* the reference count.
*
* Returns: The same @info.
+ *
+ * Since: 2.26
*/
GDBusAnnotationInfo *
g_dbus_annotation_info_ref (GDBusAnnotationInfo *info)
* If @info is statically allocated, does nothing. Otherwise decreases
* the reference count of @info. When its reference count drops to 0,
* the memory used is freed.
+ *
+ * Since: 2.26
*/
void
g_dbus_annotation_info_unref (GDBusAnnotationInfo *info)
* If @info is statically allocated, does nothing. Otherwise decreases
* the reference count of @info. When its reference count drops to 0,
* the memory used is freed.
+ *
+ * Since: 2.26
*/
void
g_dbus_arg_info_unref (GDBusArgInfo *info)
* If @info is statically allocated, does nothing. Otherwise decreases
* the reference count of @info. When its reference count drops to 0,
* the memory used is freed.
+ *
+ * Since: 2.26
*/
void
g_dbus_method_info_unref (GDBusMethodInfo *info)
* If @info is statically allocated, does nothing. Otherwise decreases
* the reference count of @info. When its reference count drops to 0,
* the memory used is freed.
+ *
+ * Since: 2.26
*/
void
g_dbus_signal_info_unref (GDBusSignalInfo *info)
* If @info is statically allocated, does nothing. Otherwise decreases
* the reference count of @info. When its reference count drops to 0,
* the memory used is freed.
+ *
+ * Since: 2.26
*/
void
g_dbus_property_info_unref (GDBusPropertyInfo *info)
* If @info is statically allocated, does nothing. Otherwise decreases
* the reference count of @info. When its reference count drops to 0,
* the memory used is freed.
+ *
+ * Since: 2.26
*/
void
g_dbus_interface_info_unref (GDBusInterfaceInfo *info)
* If @info is statically allocated, does nothing. Otherwise decreases
* the reference count of @info. When its reference count drops to 0,
* the memory used is freed.
+ *
+ * Since: 2.26
*/
void
g_dbus_node_info_unref (GDBusNodeInfo *info)
* documents at run-time for handling the
* <literal>org.freedesktop.DBus.Introspectable.Introspect</literal>
* method.
+ *
+ * Since: 2.26
*/
void
g_dbus_interface_info_generate_xml (const GDBusInterfaceInfo *info,
*
* This function is typically used for generating introspection XML documents at run-time for
* handling the <literal>org.freedesktop.DBus.Introspectable.Introspect</literal> method.
+ *
+ * Since: 2.26
*/
void
g_dbus_node_info_generate_xml (const GDBusNodeInfo *node_info,
*
* Returns: A #GDBusNodeInfo structure or %NULL if @error is set. Free
* with g_dbus_node_info_unref().
+ *
+ * Since: 2.26
*/
GDBusNodeInfo *
g_dbus_node_info_new_for_xml (const gchar *xml_data,
* 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.
+ *
+ * Since: 2.26
*/
const gchar *
g_dbus_annotation_info_lookup (const GDBusAnnotationInfo **annotations,
* 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.
- **/
+ *
+ * Since: 2.26
+ */
const GDBusMethodInfo *
g_dbus_interface_info_lookup_method (const GDBusInterfaceInfo *info,
const gchar *name)
* 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.
- **/
+ *
+ * Since: 2.26
+ */
const GDBusSignalInfo *
g_dbus_interface_info_lookup_signal (const GDBusInterfaceInfo *info,
const gchar *name)
* 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.
- **/
+ *
+ * Since: 2.26
+ */
const GDBusPropertyInfo *
g_dbus_interface_info_lookup_property (const GDBusInterfaceInfo *info,
const gchar *name)
* 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.
- **/
+ *
+ * Since: 2.26
+ */
const GDBusInterfaceInfo *
g_dbus_node_info_lookup_interface (const GDBusNodeInfo *node_info,
const gchar *name)
* @annotations: A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
*
* Information about an annotation.
+ *
+ * Since: 2.26
*/
struct _GDBusAnnotationInfo
{
* @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.
+ *
+ * Since: 2.26
*/
struct _GDBusArgInfo
{
* @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.
+ *
+ * Since: 2.26
*/
struct _GDBusMethodInfo
{
* @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.
+ *
+ * Since: 2.26
*/
struct _GDBusSignalInfo
{
* @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.
+ *
+ * Since: 2.26
*/
struct _GDBusPropertyInfo
{
* @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.
+ *
+ * Since: 2.26
*/
struct _GDBusInterfaceInfo
{
* @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.
+ *
+ * Since: 2.26
*/
struct _GDBusNodeInfo
{
* G_TYPE_DBUS_NODE_INFO:
*
* The #GType for a boxed type holding a #GDBusNodeInfo.
+ *
+ * Since: 2.26
*/
#define G_TYPE_DBUS_NODE_INFO (g_dbus_node_info_get_type ())
* G_TYPE_DBUS_INTERFACE_INFO:
*
* The #GType for a boxed type holding a #GDBusInterfaceInfo.
+ *
+ * Since: 2.26
*/
#define G_TYPE_DBUS_INTERFACE_INFO (g_dbus_interface_info_get_type ())
* G_TYPE_DBUS_METHOD_INFO:
*
* The #GType for a boxed type holding a #GDBusMethodInfo.
+ *
+ * Since: 2.26
*/
#define G_TYPE_DBUS_METHOD_INFO (g_dbus_method_info_get_type ())
* G_TYPE_DBUS_SIGNAL_INFO:
*
* The #GType for a boxed type holding a #GDBusSignalInfo.
+ *
+ * Since: 2.26
*/
#define G_TYPE_DBUS_SIGNAL_INFO (g_dbus_signal_info_get_type ())
* G_TYPE_DBUS_PROPERTY_INFO:
*
* The #GType for a boxed type holding a #GDBusPropertyInfo.
+ *
+ * Since: 2.26
*/
#define G_TYPE_DBUS_PROPERTY_INFO (g_dbus_property_info_get_type ())
* G_TYPE_DBUS_ARG_INFO:
*
* The #GType for a boxed type holding a #GDBusArgInfo.
+ *
+ * Since: 2.26
*/
#define G_TYPE_DBUS_ARG_INFO (g_dbus_arg_info_get_type ())
* G_TYPE_DBUS_ANNOTATION_INFO:
*
* The #GType for a boxed type holding a #GDBusAnnotationInfo.
+ *
+ * Since: 2.26
*/
#define G_TYPE_DBUS_ANNOTATION_INFO (g_dbus_annotation_info_get_type ())
* Creates a new empty #GDBusMessage.
*
* Returns: A #GDBusMessage. Free with g_object_unref().
+ *
+ * Since: 2.26
*/
GDBusMessage *
g_dbus_message_new (void)
* Creates a new #GDBusMessage for a method call.
*
* Returns: A #GDBusMessage. Free with g_object_unref().
+ *
+ * Since: 2.26
*/
GDBusMessage *
g_dbus_message_new_method_call (const gchar *name,
* Creates a new #GDBusMessage for a signal emission.
*
* Returns: A #GDBusMessage. Free with g_object_unref().
+ *
+ * Since: 2.26
*/
GDBusMessage *
g_dbus_message_new_signal (const gchar *path,
* Creates a new #GDBusMessage that is a reply to @method_call_message.
*
* Returns: A #GDBusMessage. Free with g_object_unref().
+ *
+ * Since: 2.26
*/
GDBusMessage *
g_dbus_message_new_method_reply (GDBusMessage *method_call_message)
* Creates a new #GDBusMessage that is an error reply to @method_call_message.
*
* Returns: A #GDBusMessage. Free with g_object_unref().
+ *
+ * Since: 2.26
*/
GDBusMessage *
g_dbus_message_new_method_error (GDBusMessage *method_call_message,
* Creates a new #GDBusMessage that is an error reply to @method_call_message.
*
* Returns: A #GDBusMessage. Free with g_object_unref().
+ *
+ * Since: 2.26
*/
GDBusMessage *
g_dbus_message_new_method_error_literal (GDBusMessage *method_call_message,
* Like g_dbus_message_new_method_error() but intended for language bindings.
*
* Returns: A #GDBusMessage. Free with g_object_unref().
+ *
+ * Since: 2.26
*/
GDBusMessage *
g_dbus_message_new_method_error_valist (GDBusMessage *method_call_message,
* Gets the type of @message.
*
* Returns: A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration).
+ *
+ * Since: 2.26
*/
GDBusMessageType
g_dbus_message_get_type (GDBusMessage *message)
* @type: A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration).
*
* Sets @message to be of @type.
+ *
+ * Since: 2.26
*/
void
g_dbus_message_set_type (GDBusMessage *message,
* Gets the flags for @message.
*
* Returns: Flags that are set (typically values from the #GDBusMessageFlags enumeration bitwise ORed together).
+ *
+ * Since: 2.26
*/
GDBusMessageFlags
g_dbus_message_get_flags (GDBusMessage *message)
* enumeration bitwise ORed together).
*
* Sets the flags to set on @message.
+ *
+ * Since: 2.26
*/
void
g_dbus_message_set_flags (GDBusMessage *message,
* Gets the serial for @message.
*
* Returns: A #guint32.
+ *
+ * Since: 2.26
*/
guint32
g_dbus_message_get_serial (GDBusMessage *message)
* @serial: A #guint32.
*
* Sets the serial for @message.
+ *
+ * Since: 2.26
*/
void
g_dbus_message_set_serial (GDBusMessage *message,
*
* Returns: A #GVariant with the value if the header was found, %NULL
* otherwise. Do not free, it is owned by @message.
+ *
+ * Since: 2.26
*/
GVariant *
g_dbus_message_get_header (GDBusMessage *message,
* Sets a header field on @message.
*
* If @value is floating, @message assumes ownership of @value.
+ *
+ * Since: 2.26
*/
void
g_dbus_message_set_header (GDBusMessage *message,
* Returns: An array of header fields terminated by
* %G_DBUS_MESSAGE_HEADER_FIELD_INVALID. Each element is a
* #guchar. Free with g_free().
+ *
+ * Since: 2.26
*/
guchar *
g_dbus_message_get_header_fields (GDBusMessage *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.
+ *
+ * Since: 2.26
*/
GVariant *
g_dbus_message_get_body (GDBusMessage *message)
* type string of @body (or cleared if @body is %NULL).
*
* If @body is floating, @message assumes ownership of @body.
+ *
+ * Since: 2.26
*/
void
g_dbus_message_set_body (GDBusMessage *message,
*
* Returns: A #GUnixFDList or %NULL if no file descriptors are
* associated. Do not free, this object is owned by @message.
+ *
+ * Since: 2.26
*/
GUnixFDList *
g_dbus_message_get_unix_fd_list (GDBusMessage *message)
* @fd_list is %NULL).
*
* This method is only available on UNIX.
+ *
+ * Since: 2.26
*/
void
g_dbus_message_set_unix_fd_list (GDBusMessage *message,
* 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
* determine the size).
+ *
+ * Since: 2.26
*/
gssize
g_dbus_message_bytes_needed (guchar *blob,
*
* Returns: A new #GDBusMessage or %NULL if @error is set. Free with
* g_object_unref().
+ *
+ * Since: 2.26
*/
GDBusMessage *
g_dbus_message_new_from_blob (guchar *blob,
*
* 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().
+ *
+ * Since: 2.26
*/
guchar *
g_dbus_message_to_blob (GDBusMessage *message,
* Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field.
*
* Returns: The value.
+ *
+ * Since: 2.26
*/
guint32
g_dbus_message_get_reply_serial (GDBusMessage *message)
* @value: The value to set.
*
* Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field.
+ *
+ * Since: 2.26
*/
void
g_dbus_message_set_reply_serial (GDBusMessage *message,
* Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field.
*
* Returns: The value.
+ *
+ * Since: 2.26
*/
const gchar *
g_dbus_message_get_interface (GDBusMessage *message)
* @value: The value to set.
*
* Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field.
+ *
+ * Since: 2.26
*/
void
g_dbus_message_set_interface (GDBusMessage *message,
* Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field.
*
* Returns: The value.
+ *
+ * Since: 2.26
*/
const gchar *
g_dbus_message_get_member (GDBusMessage *message)
* @value: The value to set.
*
* Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field.
+ *
+ * Since: 2.26
*/
void
g_dbus_message_set_member (GDBusMessage *message,
* Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field.
*
* Returns: The value.
+ *
+ * Since: 2.26
*/
const gchar *
g_dbus_message_get_path (GDBusMessage *message)
* @value: The value to set.
*
* Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field.
+ *
+ * Since: 2.26
*/
void
g_dbus_message_set_path (GDBusMessage *message,
* Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field.
*
* Returns: The value.
+ *
+ * Since: 2.26
*/
const gchar *
g_dbus_message_get_sender (GDBusMessage *message)
* @value: The value to set.
*
* Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field.
+ *
+ * Since: 2.26
*/
void
g_dbus_message_set_sender (GDBusMessage *message,
* Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field.
*
* Returns: The value.
+ *
+ * Since: 2.26
*/
const gchar *
g_dbus_message_get_destination (GDBusMessage *message)
* @value: The value to set.
*
* Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field.
+ *
+ * Since: 2.26
*/
void
g_dbus_message_set_destination (GDBusMessage *message,
* Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field.
*
* Returns: The value.
+ *
+ * Since: 2.26
*/
const gchar *
g_dbus_message_get_error_name (GDBusMessage *message)
* @value: The value to set.
*
* Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field.
+ *
+ * Since: 2.26
*/
void
g_dbus_message_set_error_name (GDBusMessage *message,
* Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field.
*
* Returns: The value.
+ *
+ * Since: 2.26
*/
const gchar *
g_dbus_message_get_signature (GDBusMessage *message)
* @value: The value to set.
*
* Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field.
+ *
+ * Since: 2.26
*/
void
g_dbus_message_set_signature (GDBusMessage *message,
*
* Returns: The string item or %NULL if the first item in the body of
* @message is not a string.
+ *
+ * Since: 2.26
*/
const gchar *
g_dbus_message_get_arg0 (GDBusMessage *message)
* Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field.
*
* Returns: The value.
+ *
+ * Since: 2.26
*/
guint32
g_dbus_message_get_num_unix_fds (GDBusMessage *message)
* @value: The value to set.
*
* Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field.
+ *
+ * Since: 2.26
*/
void
g_dbus_message_set_num_unix_fds (GDBusMessage *message,
* well as the first string item in @message's body.
*
* Returns: %TRUE if @error was set, %FALSE otherwise.
+ *
+ * Since: 2.26
*/
gboolean
g_dbus_message_to_gerror (GDBusMessage *message,
* </programlisting>
*
* Returns: A string that should be freed with g_free().
+ *
+ * Since: 2.26
*/
gchar *
g_dbus_message_print (GDBusMessage *message,
* GDBusMessageClass:
*
* Class structure for #GDBusMessage.
+ *
+ * Since: 2.26
*/
struct _GDBusMessageClass
{
*
* The #GDBusMessage structure contains only private data and should
* only be accessed using the provided API.
+ *
+ * Since: 2.26
*/
struct _GDBusMessage
{
* GDBusMethodInvocation:sender:
*
* 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,
PROP_SENDER,
* GDBusMethodInvocation:object-path:
*
* The object path the method was invoked on.
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_OBJECT_PATH,
* GDBusMethodInvocation:interface-name:
*
* The name of the D-Bus interface the method was invoked on.
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_INTERFACE_NAME,
* GDBusMethodInvocation:method-name:
*
* The name of the method that was invoked.
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_METHOD_NAME,
* GDBusMethodInvocation:method-info:
*
* Information about the method that was invoked, if any.
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_METHOD_INFO,
* GDBusMethodInvocation:connection:
*
* The #GDBusConnection the method was invoked on.
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_CONNECTION,
* GDBusMethodInvocation:message:
*
* The D-Bus message.
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_MESSAGE,
* GDBusMethodInvocation:parameters:
*
* The parameters as a #GVariant tuple.
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_PARAMETERS,
* GDBusMethodInvocation:user-data:
*
* The @user_data #gpointer passed to g_dbus_connection_register_object().
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_USER_DATA,
* Gets the bus name that invoked the method.
*
* Returns: A string. Do not free, it is owned by @invocation.
+ *
+ * Since: 2.26
*/
const gchar *
g_dbus_method_invocation_get_sender (GDBusMethodInvocation *invocation)
* Gets the object path the method was invoked on.
*
* Returns: A string. Do not free, it is owned by @invocation.
+ *
+ * Since: 2.26
*/
const gchar *
g_dbus_method_invocation_get_object_path (GDBusMethodInvocation *invocation)
* Gets the name of the D-Bus interface the method was invoked on.
*
* Returns: A string. Do not free, it is owned by @invocation.
+ *
+ * Since: 2.26
*/
const gchar *
g_dbus_method_invocation_get_interface_name (GDBusMethodInvocation *invocation)
* Gets information about the method call, if any.
*
* Returns: A #GDBusMethodInfo or %NULL. Do not free, it is owned by @invocation.
+ *
+ * Since: 2.26
*/
const GDBusMethodInfo *
g_dbus_method_invocation_get_method_info (GDBusMethodInvocation *invocation)
* Gets the name of the method that was invoked.
*
* Returns: A string. Do not free, it is owned by @invocation.
+ *
+ * Since: 2.26
*/
const gchar *
g_dbus_method_invocation_get_method_name (GDBusMethodInvocation *invocation)
* Gets the #GDBusConnection the method was invoked on.
*
* Returns: A #GDBusConnection. Do not free, it is owned by @invocation.
+ *
+ * Since: 2.26
*/
GDBusConnection *
g_dbus_method_invocation_get_connection (GDBusMethodInvocation *invocation)
* low-level API to send and receive UNIX file descriptors.
*
* Returns: A #GDBusMessage. Do not free, it is owned by @invocation.
+ *
+ * Since: 2.26
*/
GDBusMessage *
g_dbus_method_invocation_get_message (GDBusMethodInvocation *invocation)
* Gets the parameters of the method invocation.
*
* Returns: A #GVariant. Do not free, it is owned by @invocation.
+ *
+ * Since: 2.26
*/
GVariant *
g_dbus_method_invocation_get_parameters (GDBusMethodInvocation *invocation)
* Gets the @user_data #gpointer passed to g_dbus_connection_register_object().
*
* Returns: A #gpointer.
+ *
+ * Since: 2.26
*/
gpointer
g_dbus_method_invocation_get_user_data (GDBusMethodInvocation *invocation)
* Creates a new #GDBusMethodInvocation object.
*
* Returns: A #GDBusMethodInvocation. Free with g_object_unref().
+ *
+ * Since: 2.26
*/
GDBusMethodInvocation *
g_dbus_method_invocation_new (const gchar *sender,
* It is an error if @parameters is not of the right format.
*
* This method will free @invocation, you cannot use it afterwards.
+ *
+ * Since: 2.26
*/
void
g_dbus_method_invocation_return_value (GDBusMethodInvocation *invocation,
* or use g_dbus_method_invocation_return_dbus_error().
*
* This method will free @invocation, you cannot use it afterwards.
+ *
+ * Since: 2.26
*/
void
g_dbus_method_invocation_return_error (GDBusMethodInvocation *invocation,
* language bindings.
*
* This method will free @invocation, you cannot use it afterwards.
+ *
+ * Since: 2.26
*/
void
g_dbus_method_invocation_return_error_valist (GDBusMethodInvocation *invocation,
* Like g_dbus_method_invocation_return_error() but without printf()-style formatting.
*
* This method will free @invocation, you cannot use it afterwards.
+ *
+ * Since: 2.26
*/
void
g_dbus_method_invocation_return_error_literal (GDBusMethodInvocation *invocation,
* instead of the error domain, error code and message.
*
* This method will free @invocation, you cannot use it afterwards.
+ *
+ * Since: 2.26
*/
void
g_dbus_method_invocation_return_gerror (GDBusMethodInvocation *invocation,
* Finishes handling a D-Bus method call by returning an error.
*
* This method will free @invocation, you cannot use it afterwards.
+ *
+ * Since: 2.26
*/
void
g_dbus_method_invocation_return_dbus_error (GDBusMethodInvocation *invocation,
*
* The #GDBusMethodInvocation structure contains only private data and
* should only be accessed using the provided API.
+ *
+ * Since: 2.26
*/
struct _GDBusMethodInvocation
{
* GDBusMethodInvocationClass:
*
* Class structure for #GDBusMethodInvocation.
+ *
+ * Since: 2.26
*/
struct _GDBusMethodInvocationClass
{
*
* Returns: An identifier (never 0) that an be used with
* g_bus_unown_name() to stop owning the name.
- **/
+ *
+ * Since: 2.26
+ */
guint
g_bus_own_name_on_connection (GDBusConnection *connection,
const gchar *name,
*
* Returns: An identifier (never 0) that an be used with
* g_bus_unown_name() to stop owning the name.
- **/
+ *
+ * Since: 2.26
+ */
guint
g_bus_own_name (GBusType bus_type,
const gchar *name,
* @owner_id: An identifier obtained from g_bus_own_name()
*
* Stops owning a name.
+ *
+ * Since: 2.26
*/
void
g_bus_unown_name (guint owner_id)
* @user_data: User data passed to g_bus_own_name().
*
* Invoked when a connection to a message bus has been obtained.
+ *
+ * Since: 2.26
*/
typedef void (*GBusAcquiredCallback) (GDBusConnection *connection,
const gchar *name,
* @user_data: User data passed to g_bus_own_name() or g_bus_own_name_on_connection().
*
* Invoked when the name is acquired.
+ *
+ * Since: 2.26
*/
typedef void (*GBusNameAcquiredCallback) (GDBusConnection *connection,
const gchar *name,
* @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.
+ *
+ * Since: 2.26
*/
typedef void (*GBusNameLostCallback) (GDBusConnection *connection,
const gchar *name,
*
* Returns: An identifier (never 0) that an be used with
* g_bus_unwatch_name() to stop watching the name.
- **/
+ *
+ * Since: 2.26
+ */
guint
g_bus_watch_name (GBusType bus_type,
const gchar *name,
* @watcher_id: An identifier obtained from g_bus_watch_name()
*
* Stops watching a name.
- **/
+ *
+ * Since: 2.26
+ */
void
g_bus_unwatch_name (guint watcher_id)
{
* @user_data: User data passed to g_bus_watch_name().
*
* Invoked when the name being watched is known to have to have a owner.
+ *
+ * Since: 2.26
*/
typedef void (*GBusNameAppearedCallback) (GDBusConnection *connection,
const gchar *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.
+ *
+ * Since: 2.26
*/
typedef void (*GBusNameVanishedCallback) (GDBusConnection *connection,
const gchar *name,
return (_gdbus_debug_flags & G_DBUS_DEBUG_MESSAGE) != 0;
}
-/**
+/*
* _g_dbus_initialize:
*
* Does various one-time init things such as
* type signature of the message isn't what's expected, the given
* #GError is set. Signals that have a type signature mismatch are
* simply dropped.
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_G_INTERFACE_INFO,
* GDBusProxy:g-connection:
*
* The #GDBusConnection the proxy is for.
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_G_CONNECTION,
* GDBusProxy:g-flags:
*
* Flags from the #GDBusProxyFlags enumeration.
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_G_FLAGS,
* GDBusProxy:g-unique-bus-name:
*
* The unique bus name the proxy is for.
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_G_UNIQUE_BUS_NAME,
* GDBusProxy:g-object-path:
*
* The object path the proxy is for.
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_G_OBJECT_PATH,
* GDBusProxy:g-interface-name:
*
* The D-Bus interface name the proxy is for.
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_G_INTERFACE_NAME,
* remote method invocations on the proxy. If this property is -1,
* the default timeout (typically 25 seconds) is used. If set to
* %G_MAXINT, then no timeout is used.
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_G_DEFAULT_TIMEOUT,
*
* Emitted when one or more D-Bus properties on @proxy changes. The cached properties
* are already replaced when this signal fires.
+ *
+ * Since: 2.26
*/
signals[PROPERTIES_CHANGED_SIGNAL] = g_signal_new ("g-properties-changed",
G_TYPE_DBUS_PROXY,
* @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.
- **/
+ *
+ * Since: 2.26
+ */
signals[SIGNAL_SIGNAL] = g_signal_new ("g-signal",
G_TYPE_DBUS_PROXY,
G_SIGNAL_RUN_LAST,
*
* Returns: A %NULL-terminated array of strings or %NULL if @error is set. Free with
* g_strfreev().
+ *
+ * Since: 2.26
*/
gchar **
g_dbus_proxy_get_cached_property_names (GDBusProxy *proxy,
*
* 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().
+ *
+ * Since: 2.26
*/
GVariant *
g_dbus_proxy_get_cached_property (GDBusProxy *proxy,
* g_dbus_proxy_new_finish() to get the result.
*
* See g_dbus_proxy_new_sync() and for a synchronous version of this constructor.
- **/
+ *
+ * Since: 2.26
+ */
void
g_dbus_proxy_new (GDBusConnection *connection,
GType object_type,
* Finishes creating a #GDBusProxy.
*
* Returns: A #GDBusProxy or %NULL if @error is set. Free with g_object_unref().
- **/
+ *
+ * Since: 2.26
+ */
GDBusProxy *
g_dbus_proxy_new_finish (GAsyncResult *res,
GError **error)
* and g_dbus_proxy_new_finish() for the asynchronous version.
*
* Returns: A #GDBusProxy or %NULL if error is set. Free with g_object_unref().
- **/
+ *
+ * Since: 2.26
+ */
GDBusProxy *
g_dbus_proxy_new_sync (GDBusConnection *connection,
GType object_type,
* Gets the connection @proxy is for.
*
* Returns: A #GDBusConnection owned by @proxy. Do not free.
- **/
+ *
+ * Since: 2.26
+ */
GDBusConnection *
g_dbus_proxy_get_connection (GDBusProxy *proxy)
{
* Gets the flags that @proxy was constructed with.
*
* Returns: Flags from the #GDBusProxyFlags enumeration.
- **/
+ *
+ * Since: 2.26
+ */
GDBusProxyFlags
g_dbus_proxy_get_flags (GDBusProxy *proxy)
{
* Gets the unique bus name @proxy is for.
*
* Returns: A string owned by @proxy. Do not free.
- **/
+ *
+ * Since: 2.26
+ */
const gchar *
g_dbus_proxy_get_unique_bus_name (GDBusProxy *proxy)
{
* Gets the object path @proxy is for.
*
* Returns: A string owned by @proxy. Do not free.
- **/
+ *
+ * Since: 2.26
+ */
const gchar *
g_dbus_proxy_get_object_path (GDBusProxy *proxy)
{
* Gets the D-Bus interface name @proxy is for.
*
* Returns: A string owned by @proxy. Do not free.
- **/
+ *
+ * Since: 2.26
+ */
const gchar *
g_dbus_proxy_get_interface_name (GDBusProxy *proxy)
{
* See the #GDBusProxy:g-default-timeout property for more details.
*
* Returns: Timeout to use for @proxy.
+ *
+ * Since: 2.26
*/
gint
g_dbus_proxy_get_default_timeout (GDBusProxy *proxy)
* g_dbus_proxy_invoke_method_sync() functions.
*
* See the #GDBusProxy:g-default-timeout property for more details.
+ *
+ * Since: 2.26
*/
void
g_dbus_proxy_set_default_timeout (GDBusProxy *proxy,
*
* Returns: A #GDBusInterfaceInfo or %NULL. Do not unref the returned
* object, it is owned by @proxy.
+ *
+ * Since: 2.26
*/
GDBusInterfaceInfo *
g_dbus_proxy_get_interface_info (GDBusProxy *proxy)
* dropped.
*
* See the #GDBusProxy:g-interface-info property for more details.
+ *
+ * Since: 2.26
*/
void
g_dbus_proxy_set_interface_info (GDBusProxy *proxy,
* g_dbus_proxy_invoke_method_finish() to get the result of the operation.
* See g_dbus_proxy_invoke_method_sync() for the
* synchronous version of this method.
+ *
+ * Since: 2.26
*/
void
g_dbus_proxy_invoke_method (GDBusProxy *proxy,
*
* Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
* return values. Free with g_variant_unref().
+ *
+ * Since: 2.26
*/
GVariant *
g_dbus_proxy_invoke_method_finish (GDBusProxy *proxy,
*
* Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
* return values. Free with g_variant_unref().
+ *
+ * Since: 2.26
*/
GVariant *
g_dbus_proxy_invoke_method_sync (GDBusProxy *proxy,
*
* The #GDBusProxy structure contains only private data and
* should only be accessed using the provided API.
+ *
+ * Since: 2.26
*/
struct _GDBusProxy
{
* @g_signal: Signal class handler for the #GDBusProxy::g-signal signal.
*
* Class structure for #GDBusProxy.
+ *
+ * Since: 2.26
*/
struct _GDBusProxyClass
{
*
* Returns: An identifier (never 0) that can be used with
* g_bus_unwatch_proxy() to stop watching the remote object.
- **/
+ *
+ * Since: 2.26
+ */
guint
g_bus_watch_proxy (GBusType bus_type,
const gchar *name,
* @watcher_id: An identifier obtained from g_bus_watch_proxy()
*
* Stops watching proxy.
+ *
+ * Since: 2.26
*/
void
g_bus_unwatch_proxy (guint watcher_id)
* Invoked when the proxy being watched is ready for use - the passed
* @proxy object is valid until the #GBusProxyVanishedCallback
* callback is invoked.
+ *
+ * Since: 2.26
*/
typedef void (*GBusProxyAppearedCallback) (GDBusConnection *connection,
const gchar *name,
* Invoked when the proxy being watched has vanished. The #GDBusProxy
* object passed in the #GBusProxyAppearedCallback callback is no
* longer valid.
+ *
+ * Since: 2.26
*/
typedef void (*GBusProxyVanishedCallback) (GDBusConnection *connection,
const gchar *name,
* GDBusServer:flags:
*
* Flags from the #GDBusServerFlags enumeration.
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_FLAGS,
* GDBusServer:guid:
*
* The guid of the server.
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_GUID,
* GDBusServer:address:
*
* The D-Bus address to listen on.
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_ADDRESS,
* GDBusServer:client-address:
*
* The D-Bus address that clients can use.
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_CLIENT_ADDRESS,
* GDBusServer:active:
*
* Whether the server is currently active.
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_ACTIVE,
* GDBusServer:authentication-observer:
*
* A #GDBusAuthObserver object to assist in the authentication process or %NULL.
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_AUTHENTICATION_OBSERVER,
* connection. Otherwise the signal is emitted in the <link
* linkend="g-main-context-push-thread-default">thread-default main
* loop</link> of the thread that @server was constructed in.
+ *
+ * Since: 2.26
*/
_signals[NEW_CONNECTION_SIGNAL] = g_signal_new ("new-connection",
G_TYPE_DBUS_SERVER,
*
* Returns: A #GDBusServer or %NULL if @error is set. Free with
* g_object_unref().
+ *
+ * Since: 2.26
*/
GDBusServer *
g_dbus_server_new_sync (const gchar *address,
*
* Returns: A D-Bus address string. Do not free, the string is owned
* by @server.
+ *
+ * Since: 2.26
*/
const gchar *
g_dbus_server_get_client_address (GDBusServer *server)
* Gets the GUID for @server.
*
* Returns: A D-Bus GUID. Do not free this string, it is owned by @server.
+ *
+ * Since: 2.26
*/
const gchar *
g_dbus_server_get_guid (GDBusServer *server)
* Gets the flags for @server.
*
* Returns: A set of flags from the #GDBusServerFlags enumeration.
+ *
+ * Since: 2.26
*/
GDBusServerFlags
g_dbus_server_get_flags (GDBusServer *server)
* Gets whether @server is active.
*
* Returns: %TRUE if server is active, %FALSE otherwise.
+ *
+ * Since: 2.26
*/
gboolean
g_dbus_server_is_active (GDBusServer *server)
* @server: A #GDBusServer.
*
* Starts @server.
+ *
+ * Since: 2.26
*/
void
g_dbus_server_start (GDBusServer *server)
* @server: A #GDBusServer.
*
* Stops @server.
+ *
+ * Since: 2.26
*/
void
g_dbus_server_stop (GDBusServer *server)
*
* The #GDBusServer structure contains only private data and
* should only be accessed using the provided API.
+ *
+ * Since: 2.26
*/
struct _GDBusServer
{
* @new_connection: Signal class handler for the #GDBusServer::new-connection signal.
*
* Class structure for #GDBusServer.
+ *
+ * Since: 2.26
*/
struct _GDBusServerClass
{
* Checks if @string is a valid D-Bus bus name (either unique or well-known).
*
* Returns: %TRUE if valid, %FALSE otherwise.
+ *
+ * Since: 2.26
*/
gboolean
g_dbus_is_name (const gchar *string)
* Checks if @string is a valid D-Bus unique bus name.
*
* Returns: %TRUE if valid, %FALSE otherwise.
+ *
+ * Since: 2.26
*/
gboolean
g_dbus_is_unique_name (const gchar *string)
* Checks if @string is a valid D-Bus member (e.g. signal or method) name.
*
* Returns: %TRUE if valid, %FALSE otherwise.
+ *
+ * Since: 2.26
*/
gboolean
g_dbus_is_member_name (const gchar *string)
* Checks if @string is a valid D-Bus interface name.
*
* Returns: %TRUE if valid, %FALSE otherwise.
+ *
+ * Since: 2.26
*/
gboolean
g_dbus_is_interface_name (const gchar *string)
* GUID (for example, D-Bus GUIDs are not RFC-4122 compliant).
*
* Returns: A valid D-Bus GUID. Free with g_free().
+ *
+ * Since: 2.26
*/
gchar *
g_dbus_generate_guid (void)
* GUID (for example, D-Bus GUIDs are not RFC-4122 compliant).
*
* Returns: %TRUE if @string is a guid, %FALSE otherwise.
+ *
+ * Since: 2.26
*/
gboolean
g_dbus_is_guid (const gchar *string)
/* ---------------------------------------------------------------------------------------------------- */
-
/**
* g_dbus_is_activated:
*
* 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.
+ *
+ * Since: 2.26
*/
gboolean
g_dbus_is_activated (void)
* @G_BUS_TYPE_STARTER: Connect to the bus that activated the program.
*
* An enumeration to specify the type of a #GDBusConnection.
+ *
+ * Since: 2.26
*/
typedef enum
{
* specified #G_BUS_NAME_OWNER_FLAGS_ALLOW_REPLACEMENT, then take the name from the other connection.
*
* Flags used in g_bus_own_name().
+ *
+ * Since: 2.26
*/
typedef enum
{
* name.
*
* Flags used in g_bus_watch_name().
+ *
+ * Since: 2.26
*/
typedef enum
{
* @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.
+ *
+ * Since: 2.26
*/
typedef enum
{
* There's already an object with the requested object path.
*
* Error codes for the %G_DBUS_ERROR error domain.
+ *
+ * Since: 2.26
*/
typedef enum
{
G_DBUS_ERROR_ADT_AUDIT_DATA_UNKNOWN, /* org.freedesktop.DBus.Error.AdtAuditDataUnknown */
G_DBUS_ERROR_OBJECT_PATH_IN_USE, /* org.freedesktop.DBus.Error.ObjectPathInUse */
} 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:
* message bus. This means that the Hello() method will be invoked as part of the connection setup.
*
* Flags used when creating a new #GDBusConnection.
+ *
+ * Since: 2.26
*/
typedef enum {
G_DBUS_CONNECTION_FLAGS_NONE = 0,
* supports exchanging UNIX file descriptors with the remote peer.
*
* Capabilities negotiated with the remote peer.
+ *
+ * Since: 2.26
*/
typedef enum {
G_DBUS_CAPABILITY_FLAGS_NONE = 0,
* invocation.
*
* Flags used in g_dbus_connection_invoke_method() and similar APIs.
+ *
+ * Since: 2.26
*/
typedef enum {
G_DBUS_INVOKE_METHOD_FLAGS_NONE = 0,
* @G_DBUS_MESSAGE_TYPE_SIGNAL: Signal emission.
*
* Message types used in #GDBusMessage.
+ *
+ * Since: 2.26
*/
typedef enum {
G_DBUS_MESSAGE_TYPE_INVALID,
* owner for the destination name in response to this message.
*
* Message flags used in #GDBusMessage.
+ *
+ * Since: 2.26
*/
typedef enum {
G_DBUS_MESSAGE_FLAGS_NONE = 0,
* @G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS: The number of UNIX file descriptors that accompany the message.
*
* Header fields used in #GDBusMessage.
+ *
+ * Since: 2.26
*/
typedef enum {
G_DBUS_MESSAGE_HEADER_FIELD_INVALID,
* @G_DBUS_PROPERTY_INFO_FLAGS_WRITABLE: Property is writable.
*
* Flags describing the access control of a D-Bus property.
+ *
+ * Since: 2.26
*/
typedef enum
{
* to dynamically spawn objects in the subtree.
*
* Flags passed to g_dbus_connection_register_subtree().
+ *
+ * Since: 2.26
*/
typedef enum
{
* authentication method.
*
* Flags used when creating a #GDBusServer.
+ *
+ * Since: 2.26
*/
typedef enum
{
* GUnixCredentialsMessage:credentials:
*
* The credentials stored in the message.
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_CREDENTIALS,
* Gets the credentials stored in @message.
*
* Returns: A #GCredentials instance. Do not free, it is owned by @message.
+ *
+ * Since: 2.26
*/
GCredentials *
g_unix_credentials_message_get_credentials (GUnixCredentialsMessage *message)
typedef struct _GUnixCredentialsMessagePrivate GUnixCredentialsMessagePrivate;
typedef struct _GUnixCredentialsMessageClass GUnixCredentialsMessageClass;
+/**
+ * GUnixCredentialsMessageClass:
+ *
+ * Class structure for #GUnixCredentialsMessage.
+ *
+ * Since: 2.26
+ */
struct _GUnixCredentialsMessageClass
{
GSocketControlMessageClass parent_class;
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
{
GSocketControlMessage parent_instance;