gio/gdbusinterface.c

   1 /* GDBus - GLib D-Bus Library
   2  *
   3  * Copyright (C) 2008-2010 Red Hat, Inc.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General
  16  * Public License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  *
  20  * Author: David Zeuthen <davidz@redhat.com>
  21  */
  22
  23 #include "config.h"
  24
  25 #include "gdbusobject.h"
  26 #include "gdbusinterface.h"
  27
  28 #include "glibintl.h"
  29
  30 /**
  31  * SECTION:gdbusinterface
  32  * @short_description: Base type for D-Bus interfaces
  33  * @include: gio/gio.h
  34  *
  35  * The #GDBusInterface type is the base type for D-Bus interfaces both
  36  * on the service side (see #GDBusInterfaceSkeleton) and client side
  37  * (see #GDBusProxy).
  38  */
  39
  40 typedef GDBusInterfaceIface GDBusInterfaceInterface;
  41 G_DEFINE_INTERFACE (GDBusInterface, g_dbus_interface, G_TYPE_OBJECT)
  42
  43 static void
  44 g_dbus_interface_default_init (GDBusInterfaceIface *iface)
  45 {
  46 }
  47
  48 /* ---------------------------------------------------------------------------------------------------- */
  49
  50 /**
  51  * g_dbus_interface_get_info:
  52  * @interface_: An exported D-Bus interface.
  53  *
  54  * Gets D-Bus introspection information for the D-Bus interface
  55  * implemented by @interface_.
  56  *
  57  * Returns: (transfer none): A #GDBusInterfaceInfo. Do not free.
  58  *
  59  * Since: 2.30
  60  */
  61 GDBusInterfaceInfo *
  62 g_dbus_interface_get_info (GDBusInterface *interface_)
  63 {
  64   g_return_val_if_fail (G_IS_DBUS_INTERFACE (interface_), NULL);
  65   return G_DBUS_INTERFACE_GET_IFACE (interface_)->get_info (interface_);
  66 }
  67
  68 /**
  69  * g_dbus_interface_get_object:
  70  * @interface_: An exported D-Bus interface.
  71  *
  72  * Gets the #GDBusObject that @interface_ belongs to, if any.
  73  *
  74  * Returns: (transfer none): A #GDBusObject or %NULL. The returned
  75  * reference belongs to @interface_ and should not be freed.
  76  *
  77  * Since: 2.30
  78  */
  79 GDBusObject *
  80 g_dbus_interface_get_object (GDBusInterface *interface_)
  81 {
  82   g_return_val_if_fail (G_IS_DBUS_INTERFACE (interface_), NULL);
  83   return G_DBUS_INTERFACE_GET_IFACE (interface_)->get_object (interface_);
  84 }
  85
  86 /**
  87  * g_dbus_interface_set_object:
  88  * @interface_: An exported D-Bus interface.
  89  * @object: A #GDBusObject or %NULL.
  90  *
  91  * Sets the #GDBusObject for @interface_ to @object.
  92  *
  93  * Note that @interface_ will hold a weak reference to @object.
  94  *
  95  * Since: 2.30
  96  */
  97 void
  98 g_dbus_interface_set_object (GDBusInterface    *interface_,
  99                              GDBusObject       *object)
 100 {
 101   g_return_if_fail (G_IS_DBUS_INTERFACE (interface_));
 102   g_return_if_fail (object == NULL || G_IS_DBUS_OBJECT (object));
 103   G_DBUS_INTERFACE_GET_IFACE (interface_)->set_object (interface_, object);
 104 }