2010-05-06 20:13:59 +02:00
|
|
|
/* GDBus - GLib D-Bus Library
|
|
|
|
|
*
|
2010-05-09 19:14:55 +02:00
|
|
|
* Copyright (C) 2008-2010 Red Hat, Inc.
|
2010-05-06 20:13:59 +02:00
|
|
|
*
|
|
|
|
|
* This library is free software; you can redistribute it and/or
|
|
|
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
|
|
|
* License as published by the Free Software Foundation; either
|
|
|
|
|
* version 2 of the License, or (at your option) any later version.
|
|
|
|
|
*
|
|
|
|
|
* This library is distributed in the hope that it will be useful,
|
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
|
|
* Lesser General Public License for more details.
|
|
|
|
|
*
|
|
|
|
|
* You should have received a copy of the GNU Lesser General
|
|
|
|
|
* Public License along with this library; if not, write to the
|
|
|
|
|
* Free Software Foundation, Inc., 59 Temple Place, Suite 330,
|
|
|
|
|
* Boston, MA 02111-1307, USA.
|
|
|
|
|
*
|
|
|
|
|
* Author: David Zeuthen <davidz@redhat.com>
|
|
|
|
|
*/
|
|
|
|
|
|
2010-06-06 22:20:21 +02:00
|
|
|
#if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
|
|
|
|
|
#error "Only <gio/gio.h> can be included directly."
|
|
|
|
|
#endif
|
|
|
|
|
|
2010-05-06 20:13:59 +02:00
|
|
|
#ifndef __G_DBUS_CONNECTION_H__
|
|
|
|
|
#define __G_DBUS_CONNECTION_H__
|
|
|
|
|
|
|
|
|
|
#include <gio/giotypes.h>
|
|
|
|
|
|
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
|
|
|
|
|
|
#define G_TYPE_DBUS_CONNECTION (g_dbus_connection_get_type ())
|
|
|
|
|
#define G_DBUS_CONNECTION(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_DBUS_CONNECTION, GDBusConnection))
|
|
|
|
|
#define G_IS_DBUS_CONNECTION(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_DBUS_CONNECTION))
|
|
|
|
|
|
|
|
|
|
GType g_dbus_connection_get_type (void) G_GNUC_CONST;
|
|
|
|
|
|
|
|
|
|
/* ---------------------------------------------------------------------------------------------------- */
|
|
|
|
|
|
|
|
|
|
void g_bus_get (GBusType bus_type,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GAsyncReadyCallback callback,
|
|
|
|
|
gpointer user_data);
|
|
|
|
|
GDBusConnection *g_bus_get_finish (GAsyncResult *res,
|
|
|
|
|
GError **error);
|
|
|
|
|
GDBusConnection *g_bus_get_sync (GBusType bus_type,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
|
|
|
|
|
/* ---------------------------------------------------------------------------------------------------- */
|
|
|
|
|
|
|
|
|
|
void g_dbus_connection_new (GIOStream *stream,
|
|
|
|
|
const gchar *guid,
|
|
|
|
|
GDBusConnectionFlags flags,
|
2010-05-12 02:57:44 +02:00
|
|
|
GDBusAuthObserver *observer,
|
2010-05-06 20:13:59 +02:00
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GAsyncReadyCallback callback,
|
|
|
|
|
gpointer user_data);
|
|
|
|
|
GDBusConnection *g_dbus_connection_new_finish (GAsyncResult *res,
|
|
|
|
|
GError **error);
|
|
|
|
|
GDBusConnection *g_dbus_connection_new_sync (GIOStream *stream,
|
|
|
|
|
const gchar *guid,
|
|
|
|
|
GDBusConnectionFlags flags,
|
2010-05-12 02:57:44 +02:00
|
|
|
GDBusAuthObserver *observer,
|
2010-05-06 20:13:59 +02:00
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
|
|
|
|
|
void g_dbus_connection_new_for_address (const gchar *address,
|
|
|
|
|
GDBusConnectionFlags flags,
|
2010-05-13 22:32:11 +02:00
|
|
|
GDBusAuthObserver *observer,
|
2010-05-06 20:13:59 +02:00
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GAsyncReadyCallback callback,
|
|
|
|
|
gpointer user_data);
|
|
|
|
|
GDBusConnection *g_dbus_connection_new_for_address_finish (GAsyncResult *res,
|
|
|
|
|
GError **error);
|
|
|
|
|
GDBusConnection *g_dbus_connection_new_for_address_sync (const gchar *address,
|
|
|
|
|
GDBusConnectionFlags flags,
|
2010-05-13 22:32:11 +02:00
|
|
|
GDBusAuthObserver *observer,
|
2010-05-06 20:13:59 +02:00
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
|
|
|
|
|
/* ---------------------------------------------------------------------------------------------------- */
|
|
|
|
|
|
2010-06-30 17:43:42 +02:00
|
|
|
void g_dbus_connection_start_message_processing (GDBusConnection *connection);
|
2010-05-06 20:13:59 +02:00
|
|
|
gboolean g_dbus_connection_is_closed (GDBusConnection *connection);
|
|
|
|
|
GIOStream *g_dbus_connection_get_stream (GDBusConnection *connection);
|
|
|
|
|
const gchar *g_dbus_connection_get_guid (GDBusConnection *connection);
|
|
|
|
|
const gchar *g_dbus_connection_get_unique_name (GDBusConnection *connection);
|
|
|
|
|
GCredentials *g_dbus_connection_get_peer_credentials (GDBusConnection *connection);
|
|
|
|
|
gboolean g_dbus_connection_get_exit_on_close (GDBusConnection *connection);
|
|
|
|
|
void g_dbus_connection_set_exit_on_close (GDBusConnection *connection,
|
|
|
|
|
gboolean exit_on_close);
|
|
|
|
|
GDBusCapabilityFlags g_dbus_connection_get_capabilities (GDBusConnection *connection);
|
2010-07-07 21:00:23 +02:00
|
|
|
|
|
|
|
|
/* ---------------------------------------------------------------------------------------------------- */
|
|
|
|
|
|
2010-07-14 18:37:32 +02:00
|
|
|
void g_dbus_connection_close (GDBusConnection *connection,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GAsyncReadyCallback callback,
|
|
|
|
|
gpointer user_data);
|
|
|
|
|
gboolean g_dbus_connection_close_finish (GDBusConnection *connection,
|
|
|
|
|
GAsyncResult *res,
|
|
|
|
|
GError **error);
|
|
|
|
|
gboolean g_dbus_connection_close_sync (GDBusConnection *connection,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
|
|
|
|
|
/* ---------------------------------------------------------------------------------------------------- */
|
|
|
|
|
|
2010-07-07 21:00:23 +02:00
|
|
|
void g_dbus_connection_flush (GDBusConnection *connection,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GAsyncReadyCallback callback,
|
|
|
|
|
gpointer user_data);
|
|
|
|
|
gboolean g_dbus_connection_flush_finish (GDBusConnection *connection,
|
|
|
|
|
GAsyncResult *res,
|
|
|
|
|
GError **error);
|
|
|
|
|
gboolean g_dbus_connection_flush_sync (GDBusConnection *connection,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
|
2010-05-06 20:13:59 +02:00
|
|
|
/* ---------------------------------------------------------------------------------------------------- */
|
|
|
|
|
|
|
|
|
|
gboolean g_dbus_connection_send_message (GDBusConnection *connection,
|
|
|
|
|
GDBusMessage *message,
|
2010-07-19 22:07:57 +02:00
|
|
|
GDBusSendMessageFlags flags,
|
2010-05-06 20:13:59 +02:00
|
|
|
volatile guint32 *out_serial,
|
|
|
|
|
GError **error);
|
|
|
|
|
void g_dbus_connection_send_message_with_reply (GDBusConnection *connection,
|
|
|
|
|
GDBusMessage *message,
|
2010-07-19 22:07:57 +02:00
|
|
|
GDBusSendMessageFlags flags,
|
2010-05-06 20:13:59 +02:00
|
|
|
gint timeout_msec,
|
|
|
|
|
volatile guint32 *out_serial,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GAsyncReadyCallback callback,
|
|
|
|
|
gpointer user_data);
|
|
|
|
|
GDBusMessage *g_dbus_connection_send_message_with_reply_finish (GDBusConnection *connection,
|
|
|
|
|
GAsyncResult *res,
|
|
|
|
|
GError **error);
|
|
|
|
|
GDBusMessage *g_dbus_connection_send_message_with_reply_sync (GDBusConnection *connection,
|
|
|
|
|
GDBusMessage *message,
|
2010-07-19 22:07:57 +02:00
|
|
|
GDBusSendMessageFlags flags,
|
2010-05-06 20:13:59 +02:00
|
|
|
gint timeout_msec,
|
|
|
|
|
volatile guint32 *out_serial,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
|
|
|
|
|
/* ---------------------------------------------------------------------------------------------------- */
|
|
|
|
|
|
|
|
|
|
gboolean g_dbus_connection_emit_signal (GDBusConnection *connection,
|
|
|
|
|
const gchar *destination_bus_name,
|
|
|
|
|
const gchar *object_path,
|
|
|
|
|
const gchar *interface_name,
|
|
|
|
|
const gchar *signal_name,
|
|
|
|
|
GVariant *parameters,
|
|
|
|
|
GError **error);
|
2010-05-10 17:47:08 +02:00
|
|
|
void g_dbus_connection_call (GDBusConnection *connection,
|
2010-05-06 20:13:59 +02:00
|
|
|
const gchar *bus_name,
|
|
|
|
|
const gchar *object_path,
|
|
|
|
|
const gchar *interface_name,
|
|
|
|
|
const gchar *method_name,
|
|
|
|
|
GVariant *parameters,
|
2010-05-24 22:46:24 +02:00
|
|
|
const GVariantType *reply_type,
|
2010-05-10 17:47:08 +02:00
|
|
|
GDBusCallFlags flags,
|
2010-05-06 20:13:59 +02:00
|
|
|
gint timeout_msec,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GAsyncReadyCallback callback,
|
|
|
|
|
gpointer user_data);
|
2010-05-10 17:47:08 +02:00
|
|
|
GVariant *g_dbus_connection_call_finish (GDBusConnection *connection,
|
2010-05-06 20:13:59 +02:00
|
|
|
GAsyncResult *res,
|
|
|
|
|
GError **error);
|
2010-05-10 17:47:08 +02:00
|
|
|
GVariant *g_dbus_connection_call_sync (GDBusConnection *connection,
|
2010-05-06 20:13:59 +02:00
|
|
|
const gchar *bus_name,
|
|
|
|
|
const gchar *object_path,
|
|
|
|
|
const gchar *interface_name,
|
|
|
|
|
const gchar *method_name,
|
|
|
|
|
GVariant *parameters,
|
2010-05-24 22:46:24 +02:00
|
|
|
const GVariantType *reply_type,
|
2010-05-10 17:47:08 +02:00
|
|
|
GDBusCallFlags flags,
|
2010-05-06 20:13:59 +02:00
|
|
|
gint timeout_msec,
|
|
|
|
|
GCancellable *cancellable,
|
2011-07-21 22:03:27 +02:00
|
|
|
GError **error);
|
2012-05-25 14:42:50 +02:00
|
|
|
GLIB_AVAILABLE_IN_2_30
|
2011-07-21 22:03:27 +02:00
|
|
|
void g_dbus_connection_call_with_unix_fd_list (GDBusConnection *connection,
|
|
|
|
|
const gchar *bus_name,
|
|
|
|
|
const gchar *object_path,
|
|
|
|
|
const gchar *interface_name,
|
|
|
|
|
const gchar *method_name,
|
|
|
|
|
GVariant *parameters,
|
|
|
|
|
const GVariantType *reply_type,
|
|
|
|
|
GDBusCallFlags flags,
|
|
|
|
|
gint timeout_msec,
|
|
|
|
|
GUnixFDList *fd_list,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GAsyncReadyCallback callback,
|
|
|
|
|
gpointer user_data);
|
2012-05-25 14:42:50 +02:00
|
|
|
GLIB_AVAILABLE_IN_2_30
|
2011-07-21 22:03:27 +02:00
|
|
|
GVariant *g_dbus_connection_call_with_unix_fd_list_finish (GDBusConnection *connection,
|
|
|
|
|
GUnixFDList **out_fd_list,
|
|
|
|
|
GAsyncResult *res,
|
|
|
|
|
GError **error);
|
2012-05-25 14:42:50 +02:00
|
|
|
GLIB_AVAILABLE_IN_2_30
|
2011-07-21 22:03:27 +02:00
|
|
|
GVariant *g_dbus_connection_call_with_unix_fd_list_sync (GDBusConnection *connection,
|
|
|
|
|
const gchar *bus_name,
|
|
|
|
|
const gchar *object_path,
|
|
|
|
|
const gchar *interface_name,
|
|
|
|
|
const gchar *method_name,
|
|
|
|
|
GVariant *parameters,
|
|
|
|
|
const GVariantType *reply_type,
|
|
|
|
|
GDBusCallFlags flags,
|
|
|
|
|
gint timeout_msec,
|
|
|
|
|
GUnixFDList *fd_list,
|
|
|
|
|
GUnixFDList **out_fd_list,
|
|
|
|
|
GCancellable *cancellable,
|
2010-05-06 20:13:59 +02:00
|
|
|
GError **error);
|
|
|
|
|
|
|
|
|
|
/* ---------------------------------------------------------------------------------------------------- */
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* GDBusInterfaceMethodCallFunc:
|
|
|
|
|
* @connection: A #GDBusConnection.
|
|
|
|
|
* @sender: The unique bus name of the remote caller.
|
|
|
|
|
* @object_path: The object path that the method was invoked on.
|
|
|
|
|
* @interface_name: The D-Bus interface name the method was invoked on.
|
|
|
|
|
* @method_name: The name of the method that was invoked.
|
|
|
|
|
* @parameters: A #GVariant tuple with parameters.
|
|
|
|
|
* @invocation: A #GDBusMethodInvocation object that can be used to return a value or error.
|
|
|
|
|
* @user_data: The @user_data #gpointer passed to g_dbus_connection_register_object().
|
|
|
|
|
*
|
|
|
|
|
* The type of the @method_call function in #GDBusInterfaceVTable.
|
2010-05-06 22:02:08 +02:00
|
|
|
*
|
|
|
|
|
* Since: 2.26
|
2010-05-06 20:13:59 +02:00
|
|
|
*/
|
|
|
|
|
typedef void (*GDBusInterfaceMethodCallFunc) (GDBusConnection *connection,
|
|
|
|
|
const gchar *sender,
|
|
|
|
|
const gchar *object_path,
|
|
|
|
|
const gchar *interface_name,
|
|
|
|
|
const gchar *method_name,
|
|
|
|
|
GVariant *parameters,
|
|
|
|
|
GDBusMethodInvocation *invocation,
|
|
|
|
|
gpointer user_data);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* GDBusInterfaceGetPropertyFunc:
|
|
|
|
|
* @connection: A #GDBusConnection.
|
|
|
|
|
* @sender: The unique bus name of the remote caller.
|
|
|
|
|
* @object_path: The object path that the method was invoked on.
|
|
|
|
|
* @interface_name: The D-Bus interface name for the property.
|
|
|
|
|
* @property_name: The name of the property to get the value of.
|
|
|
|
|
* @error: Return location for error.
|
|
|
|
|
* @user_data: The @user_data #gpointer passed to g_dbus_connection_register_object().
|
|
|
|
|
*
|
|
|
|
|
* The type of the @get_property function in #GDBusInterfaceVTable.
|
|
|
|
|
*
|
2010-08-25 20:45:28 +02:00
|
|
|
* Returns: A #GVariant with the value for @property_name or %NULL if
|
|
|
|
|
* @error is set. If the returned #GVariant is floating, it is
|
|
|
|
|
* consumed - otherwise its reference count is decreased by one.
|
2010-05-06 22:02:08 +02:00
|
|
|
*
|
|
|
|
|
* Since: 2.26
|
2010-05-06 20:13:59 +02:00
|
|
|
*/
|
|
|
|
|
typedef GVariant *(*GDBusInterfaceGetPropertyFunc) (GDBusConnection *connection,
|
|
|
|
|
const gchar *sender,
|
|
|
|
|
const gchar *object_path,
|
|
|
|
|
const gchar *interface_name,
|
|
|
|
|
const gchar *property_name,
|
|
|
|
|
GError **error,
|
|
|
|
|
gpointer user_data);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* GDBusInterfaceSetPropertyFunc:
|
|
|
|
|
* @connection: A #GDBusConnection.
|
|
|
|
|
* @sender: The unique bus name of the remote caller.
|
|
|
|
|
* @object_path: The object path that the method was invoked on.
|
|
|
|
|
* @interface_name: The D-Bus interface name for the property.
|
|
|
|
|
* @property_name: The name of the property to get the value of.
|
|
|
|
|
* @value: The value to set the property to.
|
|
|
|
|
* @error: Return location for error.
|
|
|
|
|
* @user_data: The @user_data #gpointer passed to g_dbus_connection_register_object().
|
|
|
|
|
*
|
|
|
|
|
* The type of the @set_property function in #GDBusInterfaceVTable.
|
|
|
|
|
*
|
|
|
|
|
* Returns: %TRUE if the property was set to @value, %FALSE if @error is set.
|
2010-05-06 22:02:08 +02:00
|
|
|
*
|
|
|
|
|
* Since: 2.26
|
2010-05-06 20:13:59 +02:00
|
|
|
*/
|
|
|
|
|
typedef gboolean (*GDBusInterfaceSetPropertyFunc) (GDBusConnection *connection,
|
|
|
|
|
const gchar *sender,
|
|
|
|
|
const gchar *object_path,
|
|
|
|
|
const gchar *interface_name,
|
|
|
|
|
const gchar *property_name,
|
|
|
|
|
GVariant *value,
|
|
|
|
|
GError **error,
|
|
|
|
|
gpointer user_data);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* GDBusInterfaceVTable:
|
|
|
|
|
* @method_call: Function for handling incoming method calls.
|
|
|
|
|
* @get_property: Function for getting a property.
|
|
|
|
|
* @set_property: Function for setting a property.
|
|
|
|
|
*
|
|
|
|
|
* Virtual table for handling properties and method calls for a D-Bus
|
|
|
|
|
* interface.
|
|
|
|
|
*
|
|
|
|
|
* 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().
|
2010-05-06 22:02:08 +02:00
|
|
|
*
|
|
|
|
|
* Since: 2.26
|
2010-05-06 20:13:59 +02:00
|
|
|
*/
|
|
|
|
|
struct _GDBusInterfaceVTable
|
|
|
|
|
{
|
|
|
|
|
GDBusInterfaceMethodCallFunc method_call;
|
|
|
|
|
GDBusInterfaceGetPropertyFunc get_property;
|
|
|
|
|
GDBusInterfaceSetPropertyFunc set_property;
|
|
|
|
|
|
|
|
|
|
/*< private >*/
|
2010-07-14 20:46:12 +02:00
|
|
|
/* Padding for future expansion - also remember to update
|
|
|
|
|
* gdbusconnection.c:_g_dbus_interface_vtable_copy() when
|
|
|
|
|
* changing this.
|
|
|
|
|
*/
|
2010-06-22 18:12:16 +02:00
|
|
|
gpointer padding[8];
|
2010-05-06 20:13:59 +02:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
guint g_dbus_connection_register_object (GDBusConnection *connection,
|
|
|
|
|
const gchar *object_path,
|
2010-07-19 21:45:27 +02:00
|
|
|
GDBusInterfaceInfo *interface_info,
|
2010-05-06 20:13:59 +02:00
|
|
|
const GDBusInterfaceVTable *vtable,
|
|
|
|
|
gpointer user_data,
|
|
|
|
|
GDestroyNotify user_data_free_func,
|
|
|
|
|
GError **error);
|
|
|
|
|
gboolean g_dbus_connection_unregister_object (GDBusConnection *connection,
|
|
|
|
|
guint registration_id);
|
|
|
|
|
|
|
|
|
|
/* ---------------------------------------------------------------------------------------------------- */
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* GDBusSubtreeEnumerateFunc:
|
|
|
|
|
* @connection: A #GDBusConnection.
|
|
|
|
|
* @sender: The unique bus name of the remote caller.
|
|
|
|
|
* @object_path: The object path that was registered with g_dbus_connection_register_subtree().
|
|
|
|
|
* @user_data: The @user_data #gpointer passed to g_dbus_connection_register_subtree().
|
|
|
|
|
*
|
|
|
|
|
* The type of the @enumerate function in #GDBusSubtreeVTable.
|
|
|
|
|
*
|
2010-07-15 22:47:32 +02:00
|
|
|
* This function is called when generating introspection data and also
|
|
|
|
|
* when preparing to dispatch incoming messages in the event that the
|
|
|
|
|
* %G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES flag is not
|
|
|
|
|
* specified (ie: to verify that the object path is valid).
|
|
|
|
|
*
|
|
|
|
|
* Hierarchies are not supported; the items that you return should not
|
|
|
|
|
* contain the '/' character.
|
|
|
|
|
*
|
|
|
|
|
* The return value will be freed with g_strfreev().
|
|
|
|
|
*
|
2010-05-06 20:13:59 +02:00
|
|
|
* Returns: A newly allocated array of strings for node names that are children of @object_path.
|
2010-05-06 22:02:08 +02:00
|
|
|
*
|
|
|
|
|
* Since: 2.26
|
2010-05-06 20:13:59 +02:00
|
|
|
*/
|
|
|
|
|
typedef gchar** (*GDBusSubtreeEnumerateFunc) (GDBusConnection *connection,
|
|
|
|
|
const gchar *sender,
|
|
|
|
|
const gchar *object_path,
|
|
|
|
|
gpointer user_data);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* GDBusSubtreeIntrospectFunc:
|
|
|
|
|
* @connection: A #GDBusConnection.
|
|
|
|
|
* @sender: The unique bus name of the remote caller.
|
|
|
|
|
* @object_path: The object path that was registered with g_dbus_connection_register_subtree().
|
2010-07-15 22:53:43 +02:00
|
|
|
* @node: A node that is a child of @object_path (relative to @object_path) or %NULL for the root of the subtree.
|
2010-05-06 20:13:59 +02:00
|
|
|
* @user_data: The @user_data #gpointer passed to g_dbus_connection_register_subtree().
|
|
|
|
|
*
|
|
|
|
|
* The type of the @introspect function in #GDBusSubtreeVTable.
|
|
|
|
|
*
|
2010-07-15 22:53:43 +02:00
|
|
|
* Subtrees are flat. @node, if non-%NULL, is always exactly one
|
|
|
|
|
* segment of the object path (ie: it never contains a slash).
|
|
|
|
|
*
|
2010-07-15 22:26:42 +02:00
|
|
|
* This function should return %NULL to indicate that there is no object
|
|
|
|
|
* at this node.
|
|
|
|
|
*
|
|
|
|
|
* If this function returns non-%NULL, the return value is expected to
|
|
|
|
|
* be a %NULL-terminated array of pointers to #GDBusInterfaceInfo
|
|
|
|
|
* structures describing the interfaces implemented by @node. This
|
|
|
|
|
* array will have g_dbus_interface_info_unref() called on each item
|
|
|
|
|
* before being freed with g_free().
|
|
|
|
|
*
|
|
|
|
|
* The difference between returning %NULL and an array containing zero
|
|
|
|
|
* items is that the standard DBus interfaces will returned to the
|
|
|
|
|
* remote introspector in the empty array case, but not in the %NULL
|
|
|
|
|
* case.
|
|
|
|
|
*
|
|
|
|
|
* Returns: A %NULL-terminated array of pointers to #GDBusInterfaceInfo, or %NULL.
|
2010-05-06 22:02:08 +02:00
|
|
|
*
|
|
|
|
|
* Since: 2.26
|
2010-05-06 20:13:59 +02:00
|
|
|
*/
|
2010-07-15 22:26:42 +02:00
|
|
|
typedef GDBusInterfaceInfo ** (*GDBusSubtreeIntrospectFunc) (GDBusConnection *connection,
|
|
|
|
|
const gchar *sender,
|
|
|
|
|
const gchar *object_path,
|
|
|
|
|
const gchar *node,
|
|
|
|
|
gpointer user_data);
|
2010-05-06 20:13:59 +02:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* GDBusSubtreeDispatchFunc:
|
|
|
|
|
* @connection: A #GDBusConnection.
|
|
|
|
|
* @sender: The unique bus name of the remote caller.
|
|
|
|
|
* @object_path: The object path that was registered with g_dbus_connection_register_subtree().
|
|
|
|
|
* @interface_name: The D-Bus interface name that the method call or property access is for.
|
2010-07-15 22:53:43 +02:00
|
|
|
* @node: A node that is a child of @object_path (relative to @object_path) or %NULL for the root of the subtree.
|
2010-05-06 20:13:59 +02:00
|
|
|
* @out_user_data: Return location for user data to pass to functions in the returned #GDBusInterfaceVTable (never %NULL).
|
|
|
|
|
* @user_data: The @user_data #gpointer passed to g_dbus_connection_register_subtree().
|
|
|
|
|
*
|
|
|
|
|
* The type of the @dispatch function in #GDBusSubtreeVTable.
|
|
|
|
|
*
|
2010-07-15 22:53:43 +02:00
|
|
|
* Subtrees are flat. @node, if non-%NULL, is always exactly one
|
|
|
|
|
* segment of the object path (ie: it never contains a slash).
|
|
|
|
|
*
|
2010-05-06 20:13:59 +02:00
|
|
|
* Returns: A #GDBusInterfaceVTable or %NULL if you don't want to handle the methods.
|
2010-05-06 22:02:08 +02:00
|
|
|
*
|
|
|
|
|
* Since: 2.26
|
2010-05-06 20:13:59 +02:00
|
|
|
*/
|
|
|
|
|
typedef const GDBusInterfaceVTable * (*GDBusSubtreeDispatchFunc) (GDBusConnection *connection,
|
|
|
|
|
const gchar *sender,
|
|
|
|
|
const gchar *object_path,
|
|
|
|
|
const gchar *interface_name,
|
|
|
|
|
const gchar *node,
|
|
|
|
|
gpointer *out_user_data,
|
|
|
|
|
gpointer user_data);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* GDBusSubtreeVTable:
|
|
|
|
|
* @enumerate: Function for enumerating child nodes.
|
|
|
|
|
* @introspect: Function for introspecting 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().
|
2010-05-06 22:02:08 +02:00
|
|
|
*
|
|
|
|
|
* Since: 2.26
|
2010-05-06 20:13:59 +02:00
|
|
|
*/
|
|
|
|
|
struct _GDBusSubtreeVTable
|
|
|
|
|
{
|
|
|
|
|
GDBusSubtreeEnumerateFunc enumerate;
|
|
|
|
|
GDBusSubtreeIntrospectFunc introspect;
|
|
|
|
|
GDBusSubtreeDispatchFunc dispatch;
|
|
|
|
|
|
|
|
|
|
/*< private >*/
|
2010-07-14 20:46:12 +02:00
|
|
|
/* Padding for future expansion - also remember to update
|
|
|
|
|
* gdbusconnection.c:_g_dbus_subtree_vtable_copy() when
|
|
|
|
|
* changing this.
|
|
|
|
|
*/
|
|
|
|
|
gpointer padding[8];
|
2010-05-06 20:13:59 +02:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
guint g_dbus_connection_register_subtree (GDBusConnection *connection,
|
|
|
|
|
const gchar *object_path,
|
|
|
|
|
const GDBusSubtreeVTable *vtable,
|
|
|
|
|
GDBusSubtreeFlags flags,
|
|
|
|
|
gpointer user_data,
|
|
|
|
|
GDestroyNotify user_data_free_func,
|
|
|
|
|
GError **error);
|
|
|
|
|
gboolean g_dbus_connection_unregister_subtree (GDBusConnection *connection,
|
|
|
|
|
guint registration_id);
|
|
|
|
|
|
|
|
|
|
/* ---------------------------------------------------------------------------------------------------- */
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* GDBusSignalCallback:
|
|
|
|
|
* @connection: A #GDBusConnection.
|
|
|
|
|
* @sender_name: The unique bus name of the sender of the signal.
|
|
|
|
|
* @object_path: The object path that the signal was emitted on.
|
2010-06-07 19:25:39 +02:00
|
|
|
* @interface_name: The name of the interface.
|
2010-05-06 20:13:59 +02:00
|
|
|
* @signal_name: The name of the signal.
|
|
|
|
|
* @parameters: A #GVariant tuple with parameters for the signal.
|
|
|
|
|
* @user_data: User data passed when subscribing to the signal.
|
|
|
|
|
*
|
|
|
|
|
* Signature for callback function used in g_dbus_connection_signal_subscribe().
|
2010-05-06 22:02:08 +02:00
|
|
|
*
|
|
|
|
|
* Since: 2.26
|
2010-05-06 20:13:59 +02:00
|
|
|
*/
|
|
|
|
|
typedef void (*GDBusSignalCallback) (GDBusConnection *connection,
|
|
|
|
|
const gchar *sender_name,
|
|
|
|
|
const gchar *object_path,
|
|
|
|
|
const gchar *interface_name,
|
|
|
|
|
const gchar *signal_name,
|
|
|
|
|
GVariant *parameters,
|
|
|
|
|
gpointer user_data);
|
|
|
|
|
|
|
|
|
|
guint g_dbus_connection_signal_subscribe (GDBusConnection *connection,
|
|
|
|
|
const gchar *sender,
|
|
|
|
|
const gchar *interface_name,
|
|
|
|
|
const gchar *member,
|
|
|
|
|
const gchar *object_path,
|
|
|
|
|
const gchar *arg0,
|
2010-07-19 21:03:00 +02:00
|
|
|
GDBusSignalFlags flags,
|
2010-05-06 20:13:59 +02:00
|
|
|
GDBusSignalCallback callback,
|
|
|
|
|
gpointer user_data,
|
|
|
|
|
GDestroyNotify user_data_free_func);
|
|
|
|
|
void g_dbus_connection_signal_unsubscribe (GDBusConnection *connection,
|
|
|
|
|
guint subscription_id);
|
|
|
|
|
|
|
|
|
|
/* ---------------------------------------------------------------------------------------------------- */
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* GDBusMessageFilterFunction:
|
2010-09-09 19:21:35 +02:00
|
|
|
* @connection: (transfer none): A #GDBusConnection.
|
|
|
|
|
* @message: (transfer full): A locked #GDBusMessage that the filter function takes ownership of.
|
2010-06-21 22:08:53 +02:00
|
|
|
* @incoming: %TRUE if it is a message received from the other peer, %FALSE if it is
|
|
|
|
|
* a message to be sent to the other peer.
|
2010-05-06 20:13:59 +02:00
|
|
|
* @user_data: User data passed when adding the filter.
|
|
|
|
|
*
|
|
|
|
|
* Signature for function used in g_dbus_connection_add_filter().
|
|
|
|
|
*
|
2010-09-09 19:21:35 +02:00
|
|
|
* A filter function is passed a #GDBusMessage and expected to return
|
|
|
|
|
* a #GDBusMessage too. Passive filter functions that don't modify the
|
|
|
|
|
* message can simply return the @message object:
|
|
|
|
|
* |[
|
|
|
|
|
* static GDBusMessage *
|
|
|
|
|
* passive_filter (GDBusConnection *connection
|
|
|
|
|
* GDBusMessage *message,
|
|
|
|
|
* gboolean incoming,
|
|
|
|
|
* gpointer user_data)
|
|
|
|
|
* {
|
|
|
|
|
* /<!-- -->* inspect @message *<!-- -->/
|
|
|
|
|
* return message;
|
|
|
|
|
* }
|
|
|
|
|
* ]|
|
|
|
|
|
* Filter functions that wants to drop a message can simply return %NULL:
|
|
|
|
|
* |[
|
|
|
|
|
* static GDBusMessage *
|
|
|
|
|
* drop_filter (GDBusConnection *connection
|
|
|
|
|
* GDBusMessage *message,
|
|
|
|
|
* gboolean incoming,
|
|
|
|
|
* gpointer user_data)
|
|
|
|
|
* {
|
|
|
|
|
* if (should_drop_message)
|
|
|
|
|
* {
|
|
|
|
|
* g_object_unref (message);
|
|
|
|
|
* message = NULL;
|
|
|
|
|
* }
|
|
|
|
|
* return message;
|
|
|
|
|
* }
|
|
|
|
|
* ]|
|
|
|
|
|
* Finally, a filter function may modify a message by copying it:
|
|
|
|
|
* |[
|
|
|
|
|
* static GDBusMessage *
|
|
|
|
|
* modifying_filter (GDBusConnection *connection
|
|
|
|
|
* GDBusMessage *message,
|
|
|
|
|
* gboolean incoming,
|
|
|
|
|
* gpointer user_data)
|
|
|
|
|
* {
|
|
|
|
|
* GDBusMessage *copy;
|
|
|
|
|
* GError *error;
|
|
|
|
|
*
|
|
|
|
|
* error = NULL;
|
|
|
|
|
* copy = g_dbus_message_copy (message, &error);
|
|
|
|
|
* /<!-- -->* handle @error being is set *<!-- -->/
|
|
|
|
|
* g_object_unref (message);
|
|
|
|
|
*
|
|
|
|
|
* /<!-- -->* modify @copy *<!-- -->/
|
|
|
|
|
*
|
|
|
|
|
* return copy;
|
|
|
|
|
* }
|
|
|
|
|
* ]|
|
2010-09-09 21:15:13 +02:00
|
|
|
* If the returned #GDBusMessage is different from @message and cannot
|
|
|
|
|
* be sent on @connection (it could use features, such as file
|
|
|
|
|
* descriptors, not compatible with @connection), then a warning is
|
|
|
|
|
* logged to <emphasis>standard error</emphasis>. Applications can
|
|
|
|
|
* check this ahead of time using g_dbus_message_to_blob() passing a
|
|
|
|
|
* #GDBusCapabilityFlags value obtained from @connection.
|
2010-09-09 19:21:35 +02:00
|
|
|
*
|
|
|
|
|
* Returns: (transfer full) (allow-none): A #GDBusMessage that will be freed with
|
|
|
|
|
* g_object_unref() or %NULL to drop the message. Passive filter
|
|
|
|
|
* functions can simply return the passed @message object.
|
2010-05-06 22:02:08 +02:00
|
|
|
*
|
|
|
|
|
* Since: 2.26
|
2010-05-06 20:13:59 +02:00
|
|
|
*/
|
2010-09-09 19:21:35 +02:00
|
|
|
typedef GDBusMessage *(*GDBusMessageFilterFunction) (GDBusConnection *connection,
|
|
|
|
|
GDBusMessage *message,
|
|
|
|
|
gboolean incoming,
|
|
|
|
|
gpointer user_data);
|
2010-05-06 20:13:59 +02:00
|
|
|
|
|
|
|
|
guint g_dbus_connection_add_filter (GDBusConnection *connection,
|
|
|
|
|
GDBusMessageFilterFunction filter_function,
|
|
|
|
|
gpointer user_data,
|
|
|
|
|
GDestroyNotify user_data_free_func);
|
|
|
|
|
|
|
|
|
|
void g_dbus_connection_remove_filter (GDBusConnection *connection,
|
|
|
|
|
guint filter_id);
|
|
|
|
|
|
|
|
|
|
/* ---------------------------------------------------------------------------------------------------- */
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
G_END_DECLS
|
|
|
|
|
|
|
|
|
|
#endif /* __G_DBUS_CONNECTION_H__ */
|
