dbus/dbus-message.h

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-message.h DBusMessage object
   3  *
   4  * Copyright (C) 2002  Red Hat Inc.
   5  *
   6  * Licensed under the Academic Free License version 1.2
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  *
  22  */
  23 #if !defined (DBUS_INSIDE_DBUS_H) && !defined (DBUS_COMPILATION)
  24 #error "Only <dbus/dbus.h> can be included directly, this file may disappear or change contents."
  25 #endif
  26
  27 #ifndef DBUS_MESSAGE_H
  28 #define DBUS_MESSAGE_H
  29
  30 #include <dbus/dbus-macros.h>
  31 #include <dbus/dbus-dict.h>
  32 #include <dbus/dbus-types.h>
  33 #include <stdarg.h>
  34
  35 DBUS_BEGIN_DECLS;
  36
  37 typedef struct DBusMessage DBusMessage;
  38 typedef struct DBusMessageIter DBusMessageIter;
  39
  40 DBusMessage* dbus_message_new              (const char        *service,
  41                                             const char        *name);
  42 DBusMessage* dbus_message_new_reply        (DBusMessage       *original_message);
  43 DBusMessage* dbus_message_new_error_reply  (DBusMessage       *original_message,
  44                                             const char        *error_name,
  45                                             const char        *error_message);
  46 DBusMessage *dbus_message_copy             (const DBusMessage *message);
  47
  48 void         dbus_message_ref   (DBusMessage *message);
  49 void         dbus_message_unref (DBusMessage *message);
  50
  51 const char*  dbus_message_get_name         (DBusMessage  *message);
  52 const char*  dbus_message_get_service      (DBusMessage  *message);
  53 dbus_bool_t  dbus_message_set_sender       (DBusMessage  *message,
  54                                             const char   *sender);
  55 const char*  dbus_message_get_sender       (DBusMessage  *message);
  56 void         dbus_message_set_is_error     (DBusMessage  *message,
  57                                             dbus_bool_t   is_error_reply);
  58 dbus_bool_t  dbus_message_get_is_error     (DBusMessage  *message);
  59 dbus_bool_t  dbus_message_name_is          (DBusMessage  *message,
  60                                             const char   *name);
  61 dbus_int32_t dbus_message_get_serial       (DBusMessage  *message);
  62 dbus_bool_t  dbus_message_set_reply_serial (DBusMessage  *message,
  63                                             dbus_int32_t  reply_serial);
  64 dbus_int32_t dbus_message_get_reply_serial (DBusMessage  *message);
  65
  66
  67 dbus_bool_t dbus_message_append_args          (DBusMessage          *message,
  68                                                int                   first_arg_type,
  69                                                ...);
  70 dbus_bool_t dbus_message_append_args_valist   (DBusMessage          *message,
  71                                                int                   first_arg_type,
  72                                                va_list               var_args);
  73 dbus_bool_t dbus_message_append_nil           (DBusMessage          *message);
  74 dbus_bool_t dbus_message_append_boolean       (DBusMessage          *message,
  75                                                dbus_bool_t           value);
  76 dbus_bool_t dbus_message_append_int32         (DBusMessage          *message,
  77                                                dbus_int32_t          value);
  78 dbus_bool_t dbus_message_append_uint32        (DBusMessage          *message,
  79                                                dbus_uint32_t         value);
  80 dbus_bool_t dbus_message_append_double        (DBusMessage          *message,
  81                                                double                value);
  82 dbus_bool_t dbus_message_append_string        (DBusMessage          *message,
  83                                                const char           *value);
  84 dbus_bool_t dbus_message_append_boolean_array (DBusMessage          *message,
  85                                                unsigned const char  *value,
  86                                                int                   len);
  87 dbus_bool_t dbus_message_append_int32_array   (DBusMessage          *message,
  88                                                const dbus_int32_t   *value,
  89                                                int                   len);
  90 dbus_bool_t dbus_message_append_uint32_array  (DBusMessage          *message,
  91                                                const dbus_uint32_t  *value,
  92                                                int                   len);
  93 dbus_bool_t dbus_message_append_double_array  (DBusMessage          *message,
  94                                                const double         *value,
  95                                                int                   len);
  96 dbus_bool_t dbus_message_append_byte_array    (DBusMessage          *message,
  97                                                unsigned const char  *value,
  98                                                int                   len);
  99 dbus_bool_t dbus_message_append_string_array  (DBusMessage          *message,
 100                                                const char          **value,
 101                                                int                   len);
 102 dbus_bool_t dbus_message_append_dict          (DBusMessage          *message,
 103                                                DBusDict             *dict);
 104
 105 DBusMessageIter *dbus_message_get_args_iter   (DBusMessage *message);
 106 dbus_bool_t      dbus_message_get_args        (DBusMessage *message,
 107                                                DBusError   *error,
 108                                                int          first_arg_type,
 109                                                ...);
 110 dbus_bool_t      dbus_message_get_args_valist (DBusMessage *message,
 111                                                DBusError   *error,
 112                                                int          first_arg_type,
 113                                                va_list      var_args);
 114
 115
 116 void          dbus_message_iter_ref               (DBusMessageIter   *iter);
 117 void          dbus_message_iter_unref             (DBusMessageIter   *iter);
 118 dbus_bool_t   dbus_message_iter_has_next          (DBusMessageIter   *iter);
 119 dbus_bool_t   dbus_message_iter_next              (DBusMessageIter   *iter);
 120 int           dbus_message_iter_get_arg_type      (DBusMessageIter   *iter);
 121 dbus_bool_t   dbus_message_iter_get_boolean       (DBusMessageIter   *iter);
 122 int           dbus_message_iter_get_int32         (DBusMessageIter   *iter);
 123 int           dbus_message_iter_get_uint32        (DBusMessageIter   *iter);
 124 double        dbus_message_iter_get_double        (DBusMessageIter   *iter);
 125 char *        dbus_message_iter_get_string        (DBusMessageIter   *iter);
 126 dbus_bool_t   dbus_message_iter_get_boolean_array (DBusMessageIter   *iter,
 127                                                    unsigned char    **value,
 128                                                    int               *len);
 129 dbus_bool_t   dbus_message_iter_get_int32_array   (DBusMessageIter   *iter,
 130                                                    dbus_int32_t     **value,
 131                                                    int               *len);
 132 dbus_bool_t   dbus_message_iter_get_uint32_array  (DBusMessageIter   *iter,
 133                                                    dbus_uint32_t    **value,
 134                                                    int               *len);
 135 dbus_bool_t   dbus_message_iter_get_double_array  (DBusMessageIter   *iter,
 136                                                    double           **value,
 137                                                    int               *len);
 138 dbus_bool_t   dbus_message_iter_get_byte_array    (DBusMessageIter   *iter,
 139                                                    unsigned char    **value,
 140                                                    int               *len);
 141 dbus_bool_t   dbus_message_iter_get_string_array  (DBusMessageIter   *iter,
 142                                                    char            ***value,
 143                                                    int               *len);
 144 dbus_bool_t   dbus_message_iter_get_dict          (DBusMessageIter   *iter,
 145                                                    DBusDict         **dict);
 146
 147 DBUS_END_DECLS;
 148
 149 #endif /* DBUS_MESSAGE_H */