diff options
Diffstat (limited to 'src/gdbusobject.h')
| -rw-r--r-- | src/gdbusobject.h | 105 |
1 files changed, 105 insertions, 0 deletions
diff --git a/src/gdbusobject.h b/src/gdbusobject.h new file mode 100644 index 0000000..58e1278 --- /dev/null +++ b/src/gdbusobject.h @@ -0,0 +1,105 @@ +/* GDBus - GLib D-Bus Library + * + * Copyright (C) 2008-2010 Red Hat, Inc. + * + * 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> + */ + +#ifndef __G_DBUS_OBJECT_H__ +#define __G_DBUS_OBJECT_H__ + +#include <gio/gio.h> +#include <gdbusinterface.h> + +G_BEGIN_DECLS + +typedef struct _GDBusObject GDBusObject; + +#define G_TYPE_DBUS_OBJECT (g_dbus_object_get_type()) +#define G_DBUS_OBJECT(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_DBUS_OBJECT, GDBusObject)) +#define G_IS_DBUS_OBJECT(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_DBUS_OBJECT)) +#define G_DBUS_OBJECT_GET_IFACE(o) (G_TYPE_INSTANCE_GET_INTERFACE((o), G_TYPE_DBUS_OBJECT, GDBusObjectIface)) + +/** + * GDBusObject: + * + * A D-Bus object. + */ +typedef struct _GDBusObject GDBusObject; /* Dummy typedef */ + +typedef struct _GDBusObjectIface GDBusObjectIface; + +/** + * GDBusObjectIface: + * @parent_iface: The parent interface. + * @get_object_path: Returns the object path. See g_dbus_object_get_object_path(). + * @get_interfaces: Returns all interfaces. See g_dbus_object_get_interfaces(). + * @get_interface: Returns an interface by name. See g_dbus_object_get_interface(). + * @lookup_with_typecheck: Like @get_interface but warns on stderr if the returned object, if any, + * does not conform to @type. Returned object must be freed by the caller. + * @peek_with_typecheck: Like @lookup_with_typecheck but does not transfer the reference. + * @interface_added: Signal handler for the #GDBusObject::interface-added signal. + * @interface_removed: Signal handler for the #GDBusObject::interface-removed signal. + * + * Base object type for D-Bus objects. + * + * <note><para>The @lookup_with_typecheck and @peek_with_typecheck + * virtual functions should only be used by D-Bus interface + * implementations.</para></note> + */ +struct _GDBusObjectIface +{ + GTypeInterface parent_iface; + + /* VTable */ + const gchar *(*get_object_path) (GDBusObject *object); + GList *(*get_interfaces) (GDBusObject *object); + GDBusInterface *(*get_interface) (GDBusObject *object, + const gchar *interface_name); + + gpointer (*lookup_with_typecheck) (GDBusObject *object, + const gchar *interface_name, + GType type); + gpointer (*peek_with_typecheck) (GDBusObject *object, + const gchar *interface_name, + GType type); + + /* Signals */ + void (*interface_added) (GDBusObject *object, + GDBusInterface *interface); + void (*interface_removed) (GDBusObject *object, + GDBusInterface *interface); + +}; + +GType g_dbus_object_get_type (void) G_GNUC_CONST; +const gchar *g_dbus_object_get_object_path (GDBusObject *object); +GList *g_dbus_object_get_interfaces (GDBusObject *object); +GDBusInterface *g_dbus_object_get_interface (GDBusObject *object, + const gchar *interface_name); + +gpointer g_dbus_object_peek_with_typecheck (GDBusObject *object, + const gchar *interface_name, + GType type); +gpointer g_dbus_object_lookup_with_typecheck (GDBusObject *object, + const gchar *interface_name, + GType type); + +G_END_DECLS + +#endif /* __G_DBUS_OBJECT_H__ */ |