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
  44 void         dbus_message_ref   (DBusMessage *message);
  45 void         dbus_message_unref (DBusMessage *message);
  46
  47 const char* dbus_message_get_name    (DBusMessage *message);
  48 const char* dbus_message_get_service (DBusMessage *message);
  49 void        dbus_message_set_sender  (DBusMessage *message,
  50                                       const char  *sender);
  51 const char* dbus_message_get_sender  (DBusMessage *message);
  52
  53 dbus_bool_t dbus_message_append_fields        (DBusMessage          *message,
  54                                                int                   first_field_type,
  55                                                ...);
  56 dbus_bool_t dbus_message_append_fields_valist (DBusMessage          *message,
  57                                                int                   first_field_type,
  58                                                va_list               var_args);
  59 dbus_bool_t dbus_message_append_int32         (DBusMessage          *message,
  60                                                dbus_int32_t          value);
  61 dbus_bool_t dbus_message_append_uint32        (DBusMessage          *message,
  62                                                dbus_uint32_t         value);
  63 dbus_bool_t dbus_message_append_double        (DBusMessage          *message,
  64                                                double                value);
  65 dbus_bool_t dbus_message_append_string        (DBusMessage          *message,
  66                                                const char           *value);
  67 dbus_bool_t dbus_message_append_byte_array    (DBusMessage          *message,
  68                                                unsigned const char  *value,
  69                                                int                   len);
  70 dbus_bool_t dbus_message_append_string_array  (DBusMessage          *message,
  71                                                const char          **value,
  72                                                int                   len);
  73
  74
  75
  76 DBusMessageIter *dbus_message_get_fields_iter     (DBusMessage     *message);
  77 DBusResultCode   dbus_message_get_fields          (DBusMessage     *message,
  78                                                    int              first_field_type,
  79                                                    ...);
  80 DBusResultCode  dbus_message_get_fields_valist   (DBusMessage     *message,
  81                                                   int              first_field_type,
  82                                                   va_list          var_args);
  83
  84 void             dbus_message_iter_ref            (DBusMessageIter *iter);
  85 void             dbus_message_iter_unref          (DBusMessageIter *iter);
  86
  87 dbus_bool_t      dbus_message_iter_has_next       (DBusMessageIter *iter);
  88 dbus_bool_t      dbus_message_iter_next           (DBusMessageIter *iter);
  89 int              dbus_message_iter_get_field_type (DBusMessageIter *iter);
  90 int              dbus_message_iter_get_int32      (DBusMessageIter *iter);
  91 int              dbus_message_iter_get_uint32     (DBusMessageIter *iter);
  92 double           dbus_message_iter_get_double     (DBusMessageIter *iter);
  93 char *           dbus_message_iter_get_string     (DBusMessageIter *iter);
  94 unsigned char *  dbus_message_iter_get_byte_array (DBusMessageIter *iter,
  95                                                    int             *len);
  96 char **          dbus_message_iter_get_string_array (DBusMessageIter *iter,
  97                                                      int             *len)
  98
  99
 100
 101
 102 DBUS_END_DECLS;
 103
 104 #endif /* DBUS_MESSAGE_H */