src/lib/dbus/E_DBus.h

   1 #ifndef E_DBUS_H
   2 #define E_DBUS_H
   3
   4 #define DBUS_API_SUBJECT_TO_CHANGE
   5
   6 #include <stdio.h>
   7 #include <stdlib.h>
   8 #include <strings.h>
   9
  10 #include <dbus/dbus.h>
  11 #include <Ecore.h>
  12 #include <Eina.h>
  13
  14 #ifdef EAPI
  15 #undef EAPI
  16 #endif
  17 #ifdef _MSC_VER
  18 # ifdef BUILDING_DLL
  19 #  define EAPI __declspec(dllexport)
  20 # else
  21 #  define EAPI __declspec(dllimport)
  22 # endif
  23 #else
  24 # ifdef __GNUC__
  25 #  if __GNUC__ >= 4
  26 #   define EAPI __attribute__ ((visibility("default")))
  27 #  else
  28 #   define EAPI
  29 #  endif
  30 # else
  31 #  define EAPI
  32 # endif
  33 #endif
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif
  38
  39    EAPI extern int E_DBUS_EVENT_SIGNAL;
  40
  41    typedef struct E_DBus_Connection E_DBus_Connection;
  42    typedef struct E_DBus_Object E_DBus_Object;
  43    typedef struct E_DBus_Interface E_DBus_Interface;
  44    typedef struct E_DBus_Signal_Handler E_DBus_Signal_Handler;
  45
  46    typedef DBusMessage *(* E_DBus_Method_Cb)(E_DBus_Object *obj, DBusMessage *message);
  47    typedef void (*E_DBus_Method_Return_Cb) (void *data, DBusMessage *msg, DBusError *error);
  48    typedef void (*E_DBus_Signal_Cb) (void *data, DBusMessage *msg);
  49
  50    typedef void (*E_DBus_Object_Property_Get_Cb) (E_DBus_Object *obj, const char *property, int *type, void **value);
  51    typedef int  (*E_DBus_Object_Property_Set_Cb) (E_DBus_Object *obj, const char *property, int type, void *value);
  52
  53 /**
  54  * A callback function for a DBus call
  55  * @param user_data the data passed in to the method call
  56  * @param event_data a struct containing the return data.
  57  */
  58    typedef void (*E_DBus_Callback_Func) (void *user_data, void *method_return, DBusError *error);
  59    typedef void *(*E_DBus_Unmarshal_Func) (DBusMessage *msg, DBusError *err);
  60    typedef void (*E_DBus_Free_Func) (void *data);
  61
  62    typedef struct E_DBus_Callback E_DBus_Callback;
  63
  64
  65    EAPI int e_dbus_init(void);
  66    EAPI int e_dbus_shutdown(void);
  67
  68 /* setting up the connection */
  69
  70    EAPI E_DBus_Connection *e_dbus_bus_get(DBusBusType type);
  71
  72    EAPI void e_dbus_connection_ref(E_DBus_Connection *conn);
  73
  74    EAPI E_DBus_Connection *e_dbus_connection_setup(DBusConnection *conn);
  75    EAPI void e_dbus_connection_close(E_DBus_Connection *conn);
  76
  77 /* receiving method calls */
  78    EAPI E_DBus_Interface *e_dbus_interface_new(const char *interface);
  79    EAPI void e_dbus_interface_ref(E_DBus_Interface *iface);
  80    EAPI void e_dbus_interface_unref(E_DBus_Interface *iface);
  81    EAPI void e_dbus_object_interface_attach(E_DBus_Object *obj, E_DBus_Interface *iface);
  82    EAPI void e_dbus_object_interface_detach(E_DBus_Object *obj, E_DBus_Interface *iface);
  83    EAPI int e_dbus_interface_method_add(E_DBus_Interface *iface, const char *member, const char *signature, const char *reply_signature, E_DBus_Method_Cb func);
  84
  85    EAPI int e_dbus_interface_signal_add(E_DBus_Interface *iface, const char *name, const char *signature);
  86
  87    EAPI E_DBus_Object *e_dbus_object_add(E_DBus_Connection *conn, const char *object_path, void *data);
  88    EAPI void e_dbus_object_free(E_DBus_Object *obj);
  89    EAPI void *e_dbus_object_data_get(E_DBus_Object *obj);
  90    EAPI E_DBus_Connection *e_dbus_object_conn_get(E_DBus_Object *obj);
  91    EAPI const char *e_dbus_object_path_get(E_DBus_Object *obj);
  92    EAPI const Eina_List *e_dbus_object_interfaces_get(E_DBus_Object *obj);
  93
  94    EAPI void e_dbus_object_property_get_cb_set(E_DBus_Object *obj, E_DBus_Object_Property_Get_Cb func);
  95    EAPI void e_dbus_object_property_set_cb_set(E_DBus_Object *obj, E_DBus_Object_Property_Set_Cb func);
  96
  97
  98 /* sending method calls */
  99
 100
 101    EAPI DBusPendingCall *e_dbus_message_send(E_DBus_Connection *conn, DBusMessage *msg, E_DBus_Method_Return_Cb cb_return, int timeout, void *data);
 102
 103    EAPI DBusPendingCall *e_dbus_method_call_send(E_DBus_Connection *conn, DBusMessage *msg, E_DBus_Unmarshal_Func unmarshal_func, E_DBus_Callback_Func cb_func, E_DBus_Free_Func free_func, int timeout, void *data);
 104
 105
 106 /* signal receiving */
 107
 108    EAPI E_DBus_Signal_Handler *e_dbus_signal_handler_add(E_DBus_Connection *conn, const char *sender, const char *path, const char *interface, const char *member, E_DBus_Signal_Cb cb_signal, void *data);
 109    EAPI void e_dbus_signal_handler_del(E_DBus_Connection *conn, E_DBus_Signal_Handler *sh);
 110
 111 /* standard dbus method calls */
 112
 113    EAPI DBusPendingCall *e_dbus_request_name(E_DBus_Connection *conn, const char *name,
 114                                              unsigned int flags,
 115                                              E_DBus_Method_Return_Cb cb_return,
 116                                              const void *data);
 117    EAPI DBusPendingCall *e_dbus_release_name(E_DBus_Connection *conn, const char *name,
 118                                              E_DBus_Method_Return_Cb cb_return,
 119                                              const void *data);
 120
 121    EAPI DBusPendingCall *e_dbus_get_name_owner(E_DBus_Connection *conn, const char *name,
 122                                                E_DBus_Method_Return_Cb cb_return,
 123                                                const void *data);
 124    EAPI DBusPendingCall *e_dbus_list_names(E_DBus_Connection *conn,
 125                                            E_DBus_Method_Return_Cb cb_return,
 126                                            const void *data);
 127    EAPI DBusPendingCall *e_dbus_list_activatable_names(E_DBus_Connection *conn,
 128                                                        E_DBus_Method_Return_Cb cb_return,
 129                                                        const void *data);
 130    EAPI DBusPendingCall *e_dbus_name_has_owner(E_DBus_Connection *conn, const char *name,
 131                                                E_DBus_Method_Return_Cb cb_return,
 132                                                const void *data);
 133    EAPI DBusPendingCall *e_dbus_start_service_by_name(E_DBus_Connection *conn, const char *name,
 134                                                       E_DBus_Method_Return_Cb cb_return,
 135                                                       const void *data);
 136
 137 /* standard methods calls on objects */
 138    EAPI DBusPendingCall *e_dbus_peer_ping(E_DBus_Connection *conn, const char *destination,
 139                                           const char *path, E_DBus_Method_Return_Cb cb_return,
 140                                           const void *data);
 141    EAPI DBusPendingCall *e_dbus_peer_get_machine_id(E_DBus_Connection *conn,
 142                                                     const char *destination, const char *path,
 143                                                     E_DBus_Method_Return_Cb cb_return,
 144                                                     const void *data);
 145    EAPI DBusPendingCall *e_dbus_properties_get_all(E_DBus_Connection *conn, const char *destination,
 146                                                    const char *path, const char *interface,
 147                                                    E_DBus_Method_Return_Cb cb_return,
 148                                                    const void *data);
 149    EAPI DBusPendingCall *e_dbus_properties_get(E_DBus_Connection *conn, const char *destination,
 150                                                const char *path, const char *interface,
 151                                                const char *property,
 152                                                E_DBus_Method_Return_Cb cb_return,
 153                                                const void *data);
 154    EAPI DBusPendingCall *e_dbus_properties_set(E_DBus_Connection *conn, const char *destination,
 155                                                const char *path, const char *interface,
 156                                                const char *property, int value_type,
 157                                                const void *value, E_DBus_Method_Return_Cb cb_return,
 158                                                const void *data);
 159
 160
 161    EAPI E_DBus_Callback *e_dbus_callback_new(E_DBus_Callback_Func cb_func, E_DBus_Unmarshal_Func unmarshal_func, E_DBus_Free_Func free_func, void *user_data);
 162
 163    EAPI void e_dbus_callback_free(E_DBus_Callback *callback);
 164    EAPI void e_dbus_callback_call(E_DBus_Callback *cb, void *data, DBusError *error);
 165    EAPI void *e_dbus_callback_unmarshal(E_DBus_Callback *cb, DBusMessage *msg, DBusError *err);
 166    EAPI void e_dbus_callback_return_free(E_DBus_Callback *callback, void *data);
 167
 168 #ifdef __cplusplus
 169 }
 170 #endif
 171
 172 #endif