src/dbus.h

   1 /*-*- Mode: C; c-basic-offset: 8 -*-*/
   2
   3 #ifndef foodbushfoo
   4 #define foodbushfoo
   5
   6 /***
   7   This file is part of systemd.
   8
   9   Copyright 2010 Lennart Poettering
  10
  11   systemd is free software; you can redistribute it and/or modify it
  12   under the terms of the GNU General Public License as published by
  13   the Free Software Foundation; either version 2 of the License, or
  14   (at your option) any later version.
  15
  16   systemd is distributed in the hope that it will be useful, but
  17   WITHOUT ANY WARRANTY; without even the implied warranty of
  18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19   General Public License for more details.
  20
  21   You should have received a copy of the GNU General Public License
  22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  23 ***/
  24
  25 #include <dbus/dbus.h>
  26
  27 #include "manager.h"
  28
  29 typedef int (*BusPropertyCallback)(Manager *m, DBusMessageIter *iter, const char *property, void *data);
  30
  31 typedef struct BusProperty {
  32         const char *interface;           /* interface of the property */
  33         const char *property;            /* name of the property */
  34         BusPropertyCallback append;      /* Function that is called to serialize this property */
  35         const char *signature;
  36         const void *data;                /* The data of this property */
  37 } BusProperty;
  38
  39 #define BUS_PROPERTIES_INTERFACE                                        \
  40         " <interface name=\"org.freedesktop.DBus.Properties\">\n"       \
  41         "  <method name=\"Get\">\n"                                     \
  42         "   <arg name=\"interface\" direction=\"in\" type=\"s\"/>\n"    \
  43         "   <arg name=\"property\" direction=\"in\" type=\"s\"/>\n"     \
  44         "   <arg name=\"value\" direction=\"out\" type=\"v\"/>\n"       \
  45         "  </method>\n"                                                 \
  46         "  <method name=\"GetAll\">\n"                                  \
  47         "   <arg name=\"interface\" direction=\"in\" type=\"s\"/>\n"    \
  48         "   <arg name=\"properties\" direction=\"out\" type=\"a{sv}\"/>\n" \
  49         "  </method>\n"                                                 \
  50         " </interface>\n"
  51
  52 #define BUS_INTROSPECTABLE_INTERFACE                                    \
  53         " <interface name=\"org.freedesktop.DBus.Introspectable\">\n"   \
  54         "  <method name=\"Introspect\">\n"                              \
  55         "   <arg name=\"data\" type=\"s\" direction=\"out\"/>\n"        \
  56         "  </method>\n"                                                 \
  57         " </interface>\n"
  58
  59 int bus_init(Manager *m);
  60 void bus_done(Manager *m);
  61
  62 unsigned bus_dispatch(Manager *m);
  63
  64 void bus_watch_event(Manager *m, Watch *w, int events);
  65 void bus_timeout_event(Manager *m, Watch *w, int events);
  66
  67 int bus_query_pid(Manager *m, const char *name);
  68
  69 DBusHandlerResult bus_default_message_handler(Manager *m, DBusConnection *c, DBusMessage *message, const char* introspection, const BusProperty *properties);
  70 DBusHandlerResult bus_send_error_reply(Manager *m, DBusConnection *c, DBusMessage *message, DBusError *bus_error, int error);
  71
  72 int bus_broadcast(Manager *m, DBusMessage *message);
  73
  74 int bus_property_append_string(Manager *m, DBusMessageIter *i, const char *property, void *data);
  75 int bus_property_append_strv(Manager *m, DBusMessageIter *i, const char *property, void *data);
  76 int bus_property_append_bool(Manager *m, DBusMessageIter *i, const char *property, void *data);
  77 int bus_property_append_int32(Manager *m, DBusMessageIter *i, const char *property, void *data);
  78 int bus_property_append_uint32(Manager *m, DBusMessageIter *i, const char *property, void *data);
  79 int bus_property_append_uint64(Manager *m, DBusMessageIter *i, const char *property, void *data);
  80 int bus_property_append_size(Manager *m, DBusMessageIter *i, const char *property, void *data);
  81
  82 #define bus_property_append_int bus_property_append_int32
  83 #define bus_property_append_pid bus_property_append_uint32
  84 #define bus_property_append_mode bus_property_append_uint32
  85 #define bus_property_append_unsigned bus_property_append_uint32
  86 #define bus_property_append_usec bus_property_append_uint64
  87
  88 #define DEFINE_BUS_PROPERTY_APPEND_ENUM(function,name,type)             \
  89         int function(Manager *m, DBusMessageIter *i, const char *property, void *data) { \
  90                 const char *value;                                      \
  91                 type *field = data;                                     \
  92                                                                         \
  93                 assert(m);                                              \
  94                 assert(i);                                              \
  95                 assert(property);                                       \
  96                                                                         \
  97                 value = name##_to_string(*field);                       \
  98                                                                         \
  99                 if (!dbus_message_iter_append_basic(i, DBUS_TYPE_STRING, &value)) \
 100                         return -ENOMEM;                                 \
 101                                                                         \
 102                 return 0;                                               \
 103         }
 104
 105 int bus_parse_strv(DBusMessage *m, char ***_l);
 106
 107 extern const char * const bus_interface_table[];
 108
 109 #endif