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-types.h>
  32 #include <stdarg.h>
  33
  34 DBUS_BEGIN_DECLS;
  35
  36 typedef struct DBusMessage DBusMessage;
  37 typedef struct DBusMessageIter DBusMessageIter;
  38
  39 DBusMessage* dbus_message_new              (const char        *service,
  40                                             const char        *name);
  41 DBusMessage* dbus_message_new_reply        (const char        *name,
  42                                             DBusMessage       *original_message);
  43 DBusMessage *dbus_message_new_from_message (const DBusMessage *message);
  44
  45 void         dbus_message_ref   (DBusMessage *message);
  46 void         dbus_message_unref (DBusMessage *message);
  47
  48 const char* dbus_message_get_name             (DBusMessage *message);
  49 const char* dbus_message_get_service          (DBusMessage *message);
  50 dbus_bool_t dbus_message_set_sender           (DBusMessage *message,
  51                                                const char  *sender);
  52 const char* dbus_message_get_sender           (DBusMessage *message);
  53 void        dbus_message_set_is_error         (DBusMessage *message,
  54                                                dbus_bool_t  is_error_reply);
  55 dbus_bool_t dbus_message_get_is_error         (DBusMessage *message);
  56
  57
  58 dbus_bool_t dbus_message_append_fields        (DBusMessage          *message,
  59                                                int                   first_field_type,
  60                                                ...);
  61 dbus_bool_t dbus_message_append_fields_valist (DBusMessage          *message,
  62                                                int                   first_field_type,
  63                                                va_list               var_args);
  64 dbus_bool_t dbus_message_append_int32         (DBusMessage          *message,
  65                                                dbus_int32_t          value);
  66 dbus_bool_t dbus_message_append_uint32        (DBusMessage          *message,
  67                                                dbus_uint32_t         value);
  68 dbus_bool_t dbus_message_append_double        (DBusMessage          *message,
  69                                                double                value);
  70 dbus_bool_t dbus_message_append_string        (DBusMessage          *message,
  71                                                const char           *value);
  72 dbus_bool_t dbus_message_append_byte_array    (DBusMessage          *message,
  73                                                unsigned const char  *value,
  74                                                int                   len);
  75 dbus_bool_t dbus_message_append_string_array  (DBusMessage          *message,
  76                                                const char          **value,
  77                                                int                   len);
  78
  79
  80
  81 DBusMessageIter *dbus_message_get_fields_iter     (DBusMessage     *message);
  82 DBusResultCode   dbus_message_get_fields          (DBusMessage     *message,
  83                                                    int              first_field_type,
  84                                                    ...);
  85 DBusResultCode  dbus_message_get_fields_valist   (DBusMessage     *message,
  86                                                   int              first_field_type,
  87                                                   va_list          var_args);
  88
  89 void             dbus_message_iter_ref            (DBusMessageIter *iter);
  90 void             dbus_message_iter_unref          (DBusMessageIter *iter);
  91
  92 dbus_bool_t      dbus_message_iter_has_next       (DBusMessageIter *iter);
  93 dbus_bool_t      dbus_message_iter_next           (DBusMessageIter *iter);
  94 int              dbus_message_iter_get_field_type (DBusMessageIter *iter);
  95 int              dbus_message_iter_get_int32      (DBusMessageIter *iter);
  96 int              dbus_message_iter_get_uint32     (DBusMessageIter *iter);
  97 double           dbus_message_iter_get_double     (DBusMessageIter *iter);
  98 char *           dbus_message_iter_get_string     (DBusMessageIter *iter);
  99 unsigned char *  dbus_message_iter_get_byte_array (DBusMessageIter *iter,
 100                                                    int             *len);
 101 char **          dbus_message_iter_get_string_array (DBusMessageIter *iter,
 102                                                      int             *len)
 103
 104
 105
 106
 107 DBUS_END_DECLS;
 108
 109 #endif /* DBUS_MESSAGE_H */