gio/gdbusproxywatching.h

   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 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  24 #error "Only <gio/gio.h> can be included directly."
  25 #endif
  26
  27 #ifndef __G_DBUS_PROXY_WATCHING_H__
  28 #define __G_DBUS_PROXY_WATCHING_H__
  29
  30 #include <gio/giotypes.h>
  31
  32 G_BEGIN_DECLS
  33
  34 /**
  35  * GBusProxyAppearedCallback:
  36  * @connection: The #GDBusConnection the proxy is being watched on.
  37  * @name: The name being watched.
  38  * @name_owner: Unique name of the owner of the name being watched.
  39  * @proxy: A #GDBusProxy (or derived) instance with all properties loaded.
  40  * @user_data: User data passed to g_bus_watch_proxy().
  41  *
  42  * Invoked when the proxy being watched is ready for use - the passed
  43  * @proxy object is valid until the #GBusProxyVanishedCallback
  44  * callback is invoked.
  45  *
  46  * Since: 2.26
  47  */
  48 typedef void (*GBusProxyAppearedCallback) (GDBusConnection *connection,
  49                                            const gchar     *name,
  50                                            const gchar     *name_owner,
  51                                            GDBusProxy      *proxy,
  52                                            gpointer         user_data);
  53
  54 /**
  55  * GBusProxyVanishedCallback:
  56  * @connection: The #GDBusConnection the proxy is being watched on.
  57  * @name: The name being watched.
  58  * @user_data: User data passed to g_bus_watch_proxy().
  59  *
  60  * Invoked when the proxy being watched has vanished. The #GDBusProxy
  61  * object passed in the #GBusProxyAppearedCallback callback is no
  62  * longer valid.
  63  *
  64  * Since: 2.26
  65  */
  66 typedef void (*GBusProxyVanishedCallback) (GDBusConnection *connection,
  67                                            const gchar     *name,
  68                                            gpointer         user_data);
  69
  70 guint g_bus_watch_proxy               (GBusType                   bus_type,
  71                                        const gchar               *name,
  72                                        GBusNameWatcherFlags       flags,
  73                                        const gchar               *object_path,
  74                                        const gchar               *interface_name,
  75                                        GType                      interface_type,
  76                                        GDBusProxyFlags            proxy_flags,
  77                                        GBusProxyAppearedCallback  proxy_appeared_handler,
  78                                        GBusProxyVanishedCallback  proxy_vanished_handler,
  79                                        gpointer                   user_data,
  80                                        GDestroyNotify             user_data_free_func);
  81 guint g_bus_watch_proxy_on_connection (GDBusConnection           *connection,
  82                                        const gchar               *name,
  83                                        GBusNameWatcherFlags       flags,
  84                                        const gchar               *object_path,
  85                                        const gchar               *interface_name,
  86                                        GType                      interface_type,
  87                                        GDBusProxyFlags            proxy_flags,
  88                                        GBusProxyAppearedCallback  proxy_appeared_handler,
  89                                        GBusProxyVanishedCallback  proxy_vanished_handler,
  90                                        gpointer                   user_data,
  91                                        GDestroyNotify             user_data_free_func);
  92 guint g_bus_watch_proxy_with_closures (GBusType                   bus_type,
  93                                        const gchar               *name,
  94                                        GBusNameWatcherFlags       flags,
  95                                        const gchar               *object_path,
  96                                        const gchar               *interface_name,
  97                                        GType                      interface_type,
  98                                        GDBusProxyFlags            proxy_flags,
  99                                        GClosure                  *proxy_appeared_closure,
 100                                        GClosure                  *proxy_vanished_closure);
 101 guint g_bus_watch_proxy_on_connection_with_closures (
 102                                        GDBusConnection           *connection,
 103                                        const gchar               *name,
 104                                        GBusNameWatcherFlags       flags,
 105                                        const gchar               *object_path,
 106                                        const gchar               *interface_name,
 107                                        GType                      interface_type,
 108                                        GDBusProxyFlags            proxy_flags,
 109                                        GClosure                  *proxy_appeared_closure,
 110                                        GClosure                  *proxy_vanished_closure);
 111 void  g_bus_unwatch_proxy             (guint                      watcher_id);
 112
 113 G_END_DECLS
 114
 115 #endif /* __G_DBUS_PROXY_WATCHING_H__ */