dbus/helpers.h

   1 /* -*- Mode: C ; c-basic-offset: 2 -*- */
   2 /*
   3  * LADI Session Handler (ladish)
   4  *
   5  * Copyright (C) 2008, 2009, 2010 Nedko Arnaudov <nedko@arnaudov.name>
   6  * Copyright (C) 2008 Juuso Alasuutari <juuso.alasuutari@gmail.com>
   7  *
   8  **************************************************************************
   9  * This file contains interface to the D-Bus helpers code
  10  **************************************************************************
  11  *
  12  * Licensed under the Academic Free License version 2.1
  13  *
  14  * LADI Session Handler is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation; either version 2 of the License, or
  17  * (at your option) any later version.
  18  *
  19  * LADI Session Handler is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License
  25  * along with LADI Session Handler. If not, see <http://www.gnu.org/licenses/>
  26  * or write to the Free Software Foundation, Inc.,
  27  * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  28  */
  29
  30 #ifndef HELPERS_H__6C2107A6_A5E3_4806_869B_4BE609535BA2__INCLUDED
  31 #define HELPERS_H__6C2107A6_A5E3_4806_869B_4BE609535BA2__INCLUDED
  32
  33 #include <dbus/dbus.h>
  34
  35 extern DBusConnection * g_dbus_connection;
  36 extern DBusError g_dbus_error;
  37
  38 bool dbus_iter_get_dict_entry(DBusMessageIter * iter_ptr, const char * key, void * value, int * type, int * size);
  39 bool dbus_iter_get_dict_entry_string(DBusMessageIter * iter_ptr, const char * key, const char ** value);
  40 bool dbus_iter_append_variant(DBusMessageIter * iter, int type, const void * arg);
  41 bool dbus_iter_append_dict_entry(DBusMessageIter *iter, int type, const char * key, const void * value, int length);
  42 bool dbus_maybe_add_dict_entry_string(DBusMessageIter *dict_iter_ptr, const char * key, const char * value);
  43 bool dbus_add_dict_entry_uint32(DBusMessageIter * dict_iter_ptr, const char * key, dbus_uint32_t value);
  44 bool dbus_add_dict_entry_bool(DBusMessageIter * dict_iter_ptr, const char * key, dbus_bool_t value);
  45
  46 bool dbus_call(const char * service, const char * object, const char * iface, const char * method, const char * input_signature, ...);
  47
  48 bool
  49 dbus_register_object_signal_handler(
  50   DBusConnection * connection,
  51   const char * service,
  52   const char * object,
  53   const char * iface,
  54   const char * const * signals,
  55   DBusHandleMessageFunction handler,
  56   void * handler_data);
  57
  58 bool
  59 dbus_unregister_object_signal_handler(
  60   DBusConnection * connection,
  61   const char * service,
  62   const char * object,
  63   const char * iface,
  64   const char * const * signals,
  65   DBusHandleMessageFunction handler,
  66   void * handler_data);
  67
  68 struct dbus_signal_hook
  69 {
  70   const char * signal_name;
  71   void (* hook_function)(void * context, DBusMessage * message_ptr);
  72 };
  73
  74 bool
  75 dbus_register_object_signal_hooks(
  76   DBusConnection * connection,
  77   const char * service,
  78   const char * object,
  79   const char * iface,
  80   void * hook_context,
  81   const struct dbus_signal_hook * signal_hooks);
  82
  83 void
  84 dbus_unregister_object_signal_hooks(
  85   DBusConnection * connection,
  86   const char * service,
  87   const char * object,
  88   const char * iface);
  89
  90 bool
  91 dbus_register_service_lifetime_hook(
  92   DBusConnection * connection,
  93   const char * service,
  94   void (* hook_function)(bool appeared));
  95
  96 void
  97 dbus_unregister_service_lifetime_hook(
  98   DBusConnection * connection,
  99   const char * service);
 100
 101 #define DBUS_CALL_DEFAULT_TIMEOUT 3000 // in milliseconds
 102
 103 #include "method.h"
 104 #include "signal.h"
 105 #include "interface.h"
 106 #include "object_path.h"
 107
 108 #endif /* #ifndef HELPERS_H__6C2107A6_A5E3_4806_869B_4BE609535BA2__INCLUDED */