src/pulsecore/dbus-util.h

   1 #ifndef foodbusutilhfoo
   2 #define foodbusutilhfoo
   3
   4 /***
   5   This file is part of PulseAudio.
   6
   7   Copyright 2006 Shams E. King
   8
   9   PulseAudio is free software; you can redistribute it and/or modify
  10   it under the terms of the GNU Lesser General Public License as published
  11   by the Free Software Foundation; either version 2.1 of the License,
  12   or (at your option) any later version.
  13
  14   PulseAudio is distributed in the hope that it will be useful, but
  15   WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17   General Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser General Public License
  20   along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
  21 ***/
  22
  23 #include <dbus/dbus.h>
  24
  25 #include <pulse/gccmacro.h>
  26 #include <pulse/mainloop-api.h>
  27 #include <pulse/proplist.h>
  28
  29 #include <pulsecore/llist.h>
  30
  31 /* A wrap connection is not shared or refcounted, it is available in client side */
  32 typedef struct pa_dbus_wrap_connection pa_dbus_wrap_connection;
  33
  34 pa_dbus_wrap_connection* pa_dbus_wrap_connection_new(pa_mainloop_api *mainloop, bool use_rtclock, DBusBusType type, DBusError *error);
  35 pa_dbus_wrap_connection* pa_dbus_wrap_connection_new_from_existing(
  36         pa_mainloop_api *mainloop,
  37         bool use_rtclock,
  38         DBusConnection *conn);
  39 void pa_dbus_wrap_connection_free(pa_dbus_wrap_connection* conn);
  40
  41 DBusConnection* pa_dbus_wrap_connection_get(pa_dbus_wrap_connection *conn);
  42
  43 int pa_dbus_add_matches(DBusConnection *c, DBusError *error, ...) PA_GCC_SENTINEL;
  44 void pa_dbus_remove_matches(DBusConnection *c,  ...) PA_GCC_SENTINEL;
  45
  46 typedef struct pa_dbus_pending pa_dbus_pending;
  47
  48 struct pa_dbus_pending {
  49     DBusConnection *connection;
  50     DBusMessage *message;
  51     DBusPendingCall *pending;
  52
  53     void *context_data;
  54     void *call_data;
  55
  56     PA_LLIST_FIELDS(pa_dbus_pending);
  57 };
  58
  59 pa_dbus_pending *pa_dbus_pending_new(DBusConnection *c, DBusMessage *m, DBusPendingCall *pending, void *context_data, void *call_data);
  60 void pa_dbus_pending_free(pa_dbus_pending *p);
  61
  62 /* Sync up a list of pa_dbus_pending_call objects */
  63 void pa_dbus_sync_pending_list(pa_dbus_pending **p);
  64
  65 /* Free up a list of pa_dbus_pending_call objects */
  66 void pa_dbus_free_pending_list(pa_dbus_pending **p);
  67
  68 /* When receiving a DBusMessage with type DBUS_MESSAGE_TYPE_ERROR, the
  69  * DBusMessage may or may not contain an error message (a human-readable
  70  * explanation of what went wrong). Extracting the error message from the
  71  * DBusMessage object is a bit tedious, so here's a helper function that does
  72  * that. If the DBusMessage doesn't contain any error message,
  73  * "<no explanation>" is returned. */
  74 const char *pa_dbus_get_error_message(DBusMessage *m);
  75
  76 /* Sends an error message as the reply to the given message. */
  77 void pa_dbus_send_error(
  78         DBusConnection *c,
  79         DBusMessage *in_reply_to,
  80         const char *name,
  81         const char *format, ...) PA_GCC_PRINTF_ATTR(4, 5);
  82
  83 void pa_dbus_send_empty_reply(DBusConnection *c, DBusMessage *in_reply_to);
  84 void pa_dbus_send_basic_value_reply(DBusConnection *c, DBusMessage *in_reply_to, int type, void *data);
  85 void pa_dbus_send_basic_variant_reply(DBusConnection *c, DBusMessage *in_reply_to, int type, void *data);
  86 void pa_dbus_send_basic_array_variant_reply(
  87         DBusConnection *c,
  88         DBusMessage *in_reply_to,
  89         int item_type,
  90         void *array,
  91         unsigned n);
  92 void pa_dbus_send_proplist_variant_reply(DBusConnection *c, DBusMessage *in_reply_to, pa_proplist *proplist);
  93
  94 void pa_dbus_append_basic_array(DBusMessageIter *iter, int item_type, const void *array, unsigned n);
  95 void pa_dbus_append_basic_array_variant(DBusMessageIter *iter, int item_type, const void *array, unsigned n);
  96 void pa_dbus_append_basic_variant(DBusMessageIter *iter, int type, void *data);
  97 void pa_dbus_append_basic_variant_dict_entry(DBusMessageIter *dict_iter, const char *key, int type, void *data);
  98 void pa_dbus_append_basic_array_variant_dict_entry(
  99         DBusMessageIter *dict_iter,
 100         const char *key,
 101         int item_type,
 102         const void *array,
 103         unsigned n);
 104 void pa_dbus_append_proplist(DBusMessageIter *iter, pa_proplist *proplist);
 105 void pa_dbus_append_proplist_variant(DBusMessageIter *iter, pa_proplist *proplist);
 106 void pa_dbus_append_proplist_variant_dict_entry(DBusMessageIter *dict_iter, const char *key, pa_proplist *proplist);
 107
 108 /* Returns a new proplist that the caller has to free. If the proplist contains
 109  * invalid keys, an error reply is sent and NULL is returned. The iterator must
 110  * point to "a{say}" element. This function calls dbus_message_iter_next(iter)
 111  * before returning. */
 112 pa_proplist *pa_dbus_get_proplist_arg(DBusConnection *c, DBusMessage *msg, DBusMessageIter *iter);
 113
 114 #endif