wpa_supplicant/dbus/dbus_new_helpers.h

   1 /*
   2  * WPA Supplicant / dbus-based control interface
   3  * Copyright (c) 2006, Dan Williams <dcbw@redhat.com> and Red Hat, Inc.
   4  * Copyright (c) 2009, Witold Sowa <witold.sowa@gmail.com>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 as
   8  * published by the Free Software Foundation.
   9  *
  10  * Alternatively, this software may be distributed under the terms of BSD
  11  * license.
  12  *
  13  * See README and COPYING for more details.
  14  */
  15
  16 #ifndef WPA_DBUS_CTRL_H
  17 #define WPA_DBUS_CTRL_H
  18
  19 #include <dbus/dbus.h>
  20
  21 typedef DBusMessage * (* WPADBusMethodHandler)(DBusMessage *message,
  22                                                void *user_data);
  23 typedef void (* WPADBusArgumentFreeFunction)(void *handler_arg);
  24
  25 typedef DBusMessage * (* WPADBusPropertyAccessor)(DBusMessage *message,
  26                                                   const void *user_data);
  27
  28 struct wpa_dbus_object_desc {
  29         DBusConnection *connection;
  30
  31         /* list of methods, properties and signals registered with object */
  32         struct wpa_dbus_method_desc *methods;
  33         struct wpa_dbus_signal_desc *signals;
  34         struct wpa_dbus_property_desc *properties;
  35
  36         /* argument for method handlers and properties
  37          * getter and setter functions */
  38         void *user_data;
  39         /* function used to free above argument */
  40         WPADBusArgumentFreeFunction user_data_free_func;
  41 };
  42
  43 enum dbus_prop_access { R, W, RW };
  44
  45 enum dbus_arg_direction { ARG_IN, ARG_OUT };
  46
  47 struct wpa_dbus_argument {
  48         char *name;
  49         char *type;
  50         enum dbus_arg_direction dir;
  51 };
  52
  53 #define END_ARGS { NULL, NULL, ARG_IN }
  54
  55 #ifndef SIGPOLL
  56 #ifdef SIGIO
  57 /*
  58  * If we do not have SIGPOLL, try to use SIGIO instead. This is needed for
  59  * FreeBSD.
  60  */
  61 #define SIGPOLL SIGIO
  62 #endif
  63 #endif
  64
  65 #define WPAS_DBUS_OBJECT_PATH_MAX 150
  66 #define WPAS_DBUS_INTERFACE_MAX 150
  67 #define WPAS_DBUS_METHOD_SIGNAL_PROP_MAX 50
  68
  69 #define WPA_DBUS_INTROSPECTION_INTERFACE "org.freedesktop.DBus.Introspectable"
  70 #define WPA_DBUS_INTROSPECTION_METHOD "Introspect"
  71 #define WPA_DBUS_PROPERTIES_INTERFACE "org.freedesktop.DBus.Properties"
  72 #define WPA_DBUS_PROPERTIES_GET "Get"
  73 #define WPA_DBUS_PROPERTIES_SET "Set"
  74 #define WPA_DBUS_PROPERTIES_GETALL "GetAll"
  75
  76 void free_dbus_object_desc(struct wpa_dbus_object_desc *obj_dsc);
  77
  78 int wpa_dbus_ctrl_iface_init(struct wpas_dbus_priv *iface, char *dbus_path,
  79                              char *dbus_service,
  80                              struct wpa_dbus_object_desc *obj_desc);
  81
  82 int wpa_dbus_register_object_per_iface(
  83         struct wpas_dbus_priv *ctrl_iface,
  84         const char *path, const char *ifname,
  85         struct wpa_dbus_object_desc *obj_desc);
  86
  87 int wpa_dbus_unregister_object_per_iface(
  88         struct wpas_dbus_priv *ctrl_iface,
  89         const char *path);
  90
  91 int wpa_dbus_method_register(struct wpa_dbus_object_desc *obj_dsc,
  92                              const char *dbus_interface,
  93                              const char *dbus_method,
  94                              WPADBusMethodHandler method_handler,
  95                              const struct wpa_dbus_argument args[]);
  96
  97 int wpa_dbus_signal_register(struct wpa_dbus_object_desc *obj_dsc,
  98                              const char *dbus_interface,
  99                              const char *dbus_signal,
 100                              const struct wpa_dbus_argument args[]);
 101
 102 int wpa_dbus_property_register(
 103         struct wpa_dbus_object_desc *obj_dsc,
 104         const char *dbus_interface, const char *dbus_property,
 105         const char *type,
 106         WPADBusPropertyAccessor getter,
 107         WPADBusPropertyAccessor setter,
 108         enum dbus_prop_access _access);
 109
 110 void wpa_dbus_signal_property_changed(struct wpas_dbus_priv *iface,
 111                                       WPADBusPropertyAccessor property_getter,
 112                                       void *getter_arg,
 113                                       const char *path,
 114                                       const char *interface_name,
 115                                       const char *property_name);
 116
 117 void wpa_dbus_get_object_properties(struct wpas_dbus_priv *iface,
 118                                     const char *path, const char *interface,
 119                                     DBusMessageIter *dict_iter);
 120
 121 #endif /* WPA_DBUS_CTRL_H */