include/dbus.h

   1 /*
   2  *
   3  *  Connection Manager
   4  *
   5  *  Copyright (C) 2007-2010  Intel Corporation. All rights reserved.
   6  *
   7  *  This program is free software; you can redistribute it and/or modify
   8  *  it under the terms of the GNU General Public License version 2 as
   9  *  published by the Free Software Foundation.
  10  *
  11  *  This program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with this program; if not, write to the Free Software
  18  *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  */
  21
  22 #ifndef __CONNMAN_DBUS_H
  23 #define __CONNMAN_DBUS_H
  24
  25 #include <dbus/dbus.h>
  26
  27 #ifdef __cplusplus
  28 extern "C" {
  29 #endif
  30
  31 #define CONNMAN_SERVICE                 "net.connman"
  32 #define CONNMAN_PATH                    "/net/connman"
  33
  34 #define CONNMAN_DEBUG_INTERFACE         CONNMAN_SERVICE ".Debug"
  35 #define CONNMAN_ERROR_INTERFACE         CONNMAN_SERVICE ".Error"
  36 #define CONNMAN_AGENT_INTERFACE         CONNMAN_SERVICE ".Agent"
  37 #define CONNMAN_COUNTER_INTERFACE       CONNMAN_SERVICE ".Counter"
  38
  39 #define CONNMAN_MANAGER_INTERFACE       CONNMAN_SERVICE ".Manager"
  40 #define CONNMAN_MANAGER_PATH            "/"
  41
  42 #define CONNMAN_CLOCK_INTERFACE         CONNMAN_SERVICE ".Clock"
  43 #define CONNMAN_TASK_INTERFACE          CONNMAN_SERVICE ".Task"
  44 #define CONNMAN_SERVICE_INTERFACE       CONNMAN_SERVICE ".Service"
  45 #define CONNMAN_PROVIDER_INTERFACE      CONNMAN_SERVICE ".Provider"
  46 #define CONNMAN_TECHNOLOGY_INTERFACE    CONNMAN_SERVICE ".Technology"
  47 #define CONNMAN_SESSION_INTERFACE       CONNMAN_SERVICE ".Session"
  48 #define CONNMAN_NOTIFICATION_INTERFACE  CONNMAN_SERVICE ".Notification"
  49
  50 #define CONNMAN_PRIVILEGE_MODIFY        1
  51 #define CONNMAN_PRIVILEGE_SECRET        2
  52
  53 typedef void (* connman_dbus_append_cb_t) (DBusMessageIter *iter,
  54                                                         void *user_data);
  55
  56 DBusConnection *connman_dbus_get_connection(void);
  57
  58 void connman_dbus_property_append_basic(DBusMessageIter *iter,
  59                                         const char *key, int type, void *val);
  60 void connman_dbus_property_append_dict(DBusMessageIter *iter, const char *key,
  61                         connman_dbus_append_cb_t function, void *user_data);
  62 void connman_dbus_property_append_array(DBusMessageIter *iter,
  63                                                 const char *key, int type,
  64                         connman_dbus_append_cb_t function, void *user_data);
  65 void connman_dbus_property_append_fixed_array(DBusMessageIter *iter,
  66                                 const char *key, int type, void *val, int len);
  67
  68 dbus_bool_t connman_dbus_property_changed_basic(const char *path,
  69                                 const char *interface, const char *key,
  70                                                         int type, void *val);
  71 #if defined TIZEN_EXT
  72 dbus_bool_t connman_dbus_service_property_changed_with_error_cause(const char *path,
  73                                 const char *interface, const char *key1, int type1, void *val1,
  74                                 const char *key2, int type2, void *val2);
  75 #endif
  76 dbus_bool_t connman_dbus_property_changed_dict(const char *path,
  77                                 const char *interface, const char *key,
  78                         connman_dbus_append_cb_t function, void *user_data);
  79 dbus_bool_t connman_dbus_property_changed_array(const char *path,
  80                         const char *interface, const char *key, int type,
  81                         connman_dbus_append_cb_t function, void *user_data);
  82
  83 dbus_bool_t connman_dbus_setting_changed_basic(const char *owner,
  84                                 const char *path, const char *key,
  85                                 int type, void *val);
  86 dbus_bool_t connman_dbus_setting_changed_dict(const char *owner,
  87                                 const char *path, const char *key,
  88                                 connman_dbus_append_cb_t function,
  89                                 void *user_data);
  90 dbus_bool_t connman_dbus_setting_changed_array(const char *owner,
  91                                 const char *path, const char *key, int type,
  92                                 connman_dbus_append_cb_t function,
  93                                 void *user_data);
  94 #if defined TIZEN_EXT
  95 /*
  96  * August 22nd, 2011. TIZEN
  97  *
  98  * This part is added to send a DBus signal which means scan is completed
  99  * because scan UX of a Wi-Fi setting application has an active scan procedure
 100  * and it needs scan complete signal whether success or not
 101  */
 102 dbus_bool_t connman_dbus_scan_completed_basic(const char *path,
 103                                 const char *interface,int type, void *val);
 104 #endif
 105
 106 static inline void connman_dbus_dict_open(DBusMessageIter *iter,
 107                                                         DBusMessageIter *dict)
 108 {
 109         dbus_message_iter_open_container(iter, DBUS_TYPE_ARRAY,
 110                         DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
 111                         DBUS_TYPE_STRING_AS_STRING DBUS_TYPE_VARIANT_AS_STRING
 112                         DBUS_DICT_ENTRY_END_CHAR_AS_STRING, dict);
 113 }
 114
 115 static inline void connman_dbus_dict_close(DBusMessageIter *iter,
 116                                                         DBusMessageIter *dict)
 117 {
 118         dbus_message_iter_close_container(iter, dict);
 119 }
 120
 121 static inline void connman_dbus_dict_append_basic(DBusMessageIter *dict,
 122                                         const char *key, int type, void *val)
 123 {
 124         DBusMessageIter entry;
 125
 126         dbus_message_iter_open_container(dict, DBUS_TYPE_DICT_ENTRY,
 127                                                                 NULL, &entry);
 128         connman_dbus_property_append_basic(&entry, key, type, val);
 129         dbus_message_iter_close_container(dict, &entry);
 130 }
 131
 132 static inline void connman_dbus_dict_append_dict(DBusMessageIter *dict,
 133                         const char *key, connman_dbus_append_cb_t function,
 134                                                         void *user_data)
 135 {
 136         DBusMessageIter entry;
 137
 138         dbus_message_iter_open_container(dict, DBUS_TYPE_DICT_ENTRY,
 139                                                                 NULL, &entry);
 140         connman_dbus_property_append_dict(&entry, key, function, user_data);
 141         dbus_message_iter_close_container(dict, &entry);
 142 }
 143
 144 static inline void connman_dbus_dict_append_array(DBusMessageIter *dict,
 145                 const char *key, int type, connman_dbus_append_cb_t function,
 146                                                         void *user_data)
 147 {
 148         DBusMessageIter entry;
 149
 150         dbus_message_iter_open_container(dict, DBUS_TYPE_DICT_ENTRY,
 151                                                                 NULL, &entry);
 152         connman_dbus_property_append_array(&entry, key,
 153                                                 type, function, user_data);
 154         dbus_message_iter_close_container(dict, &entry);
 155 }
 156
 157 static inline void connman_dbus_dict_append_fixed_array(DBusMessageIter *dict,
 158                                 const char *key, int type, void *val, int len)
 159 {
 160         DBusMessageIter entry;
 161
 162         dbus_message_iter_open_container(dict, DBUS_TYPE_DICT_ENTRY,
 163                                                                 NULL, &entry);
 164         connman_dbus_property_append_fixed_array(&entry, key, type, val, len);
 165         dbus_message_iter_close_container(dict, &entry);
 166 }
 167
 168 dbus_bool_t connman_dbus_validate_ident(const char *ident);
 169 char *connman_dbus_encode_string(const char *value);
 170
 171 #ifdef __cplusplus
 172 }
 173 #endif
 174
 175 #endif /* __CONNMAN_DBUS_H */