Add helpers for appending flexible D-Bus arrays
[framework/connectivity/connman.git] / include / dbus.h
1 /*
2  *
3  *  Connection Manager
4  *
5  *  Copyright (C) 2007-2009  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                 "org.moblin.connman"
32
33 #define CONNMAN_DEBUG_INTERFACE         CONNMAN_SERVICE ".Debug"
34 #define CONNMAN_ERROR_INTERFACE         CONNMAN_SERVICE ".Error"
35 #define CONNMAN_AGENT_INTERFACE         CONNMAN_SERVICE ".Agent"
36
37 #define CONNMAN_MANAGER_INTERFACE       CONNMAN_SERVICE ".Manager"
38 #define CONNMAN_MANAGER_PATH            "/"
39
40 #define CONNMAN_TASK_INTERFACE          CONNMAN_SERVICE ".Task"
41 #define CONNMAN_PROFILE_INTERFACE       CONNMAN_SERVICE ".Profile"
42 #define CONNMAN_SERVICE_INTERFACE       CONNMAN_SERVICE ".Service"
43 #define CONNMAN_DEVICE_INTERFACE        CONNMAN_SERVICE ".Device"
44 #define CONNMAN_NETWORK_INTERFACE       CONNMAN_SERVICE ".Network"
45 #define CONNMAN_CONNECTION_INTERFACE    CONNMAN_SERVICE ".Connection"
46 #define CONNMAN_PROVIDER_INTERFACE      CONNMAN_SERVICE ".Provider"
47
48 typedef void (* connman_dbus_append_cb_t) (DBusMessageIter *iter);
49
50 DBusConnection *connman_dbus_get_connection(void);
51
52 void connman_dbus_property_append_variant(DBusMessageIter *property,
53                                         const char *key, int type, void *val);
54
55 static inline void connman_dbus_dict_open(DBusMessageIter *iter,
56                                                         DBusMessageIter *dict)
57 {
58         dbus_message_iter_open_container(iter, DBUS_TYPE_ARRAY,
59                         DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
60                         DBUS_TYPE_STRING_AS_STRING DBUS_TYPE_VARIANT_AS_STRING
61                         DBUS_DICT_ENTRY_END_CHAR_AS_STRING, dict);
62 }
63
64 static inline void connman_dbus_dict_close(DBusMessageIter *iter,
65                                                         DBusMessageIter *dict)
66 {
67         dbus_message_iter_close_container(iter, dict);
68 }
69
70 void connman_dbus_dict_append_variant(DBusMessageIter *dict,
71                                         const char *key, int type, void *val);
72
73 void connman_dbus_dict_append_fixed_array(DBusMessageIter *dict,
74                                 const char *key, int type, void *val, int len);
75 void connman_dbus_dict_append_variable_array(DBusMessageIter *dict,
76                 const char *key, int type, connman_dbus_append_cb_t function);
77
78 dbus_bool_t connman_dbus_validate_ident(const char *ident);
79 char *connman_dbus_encode_string(const char *value);
80
81 #ifdef __cplusplus
82 }
83 #endif
84
85 #endif /* __CONNMAN_DBUS_H */