dbus/dbus-marshal-header.h

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-marshal-header.h  Managing marshaling/demarshaling of message headers
   3  *
   4  * Copyright (C) 2005  Red Hat, Inc.
   5  *
   6  * Licensed under the Academic Free License version 2.1
   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
  24 #ifndef DBUS_MARSHAL_HEADER_H
  25 #define DBUS_MARSHAL_HEADER_H
  26
  27 #include <config.h>
  28 #include <dbus/dbus-marshal-basic.h>
  29 #include <dbus/dbus-marshal-validate.h>
  30
  31 #ifndef PACKAGE
  32 #error "config.h not included here"
  33 #endif
  34
  35 typedef struct DBusHeader      DBusHeader;
  36 typedef struct DBusHeaderField DBusHeaderField;
  37
  38 #define _DBUS_HEADER_FIELD_VALUE_UNKNOWN -1
  39 #define _DBUS_HEADER_FIELD_VALUE_NONEXISTENT -2
  40
  41 /**
  42  * Cached information about a header field in the message
  43  */
  44 struct DBusHeaderField
  45 {
  46   int            value_pos; /**< Position of field value, or -1/-2 */
  47 };
  48
  49 struct DBusHeader
  50 {
  51   DBusString data; /**< Header network data, stored
  52                     * separately from body so we can
  53                     * independently realloc it.
  54                     */
  55
  56   DBusHeaderField fields[DBUS_HEADER_FIELD_LAST + 1]; /**< Track the location
  57                                                        * of each field in header
  58                                                        */
  59
  60   dbus_uint32_t padding : 3;        /**< bytes of alignment in header */
  61   dbus_uint32_t byte_order : 8;     /**< byte order of header */
  62 };
  63
  64 dbus_bool_t   _dbus_header_init                   (DBusHeader        *header,
  65                                                    int                byte_order);
  66 void          _dbus_header_free                   (DBusHeader        *header);
  67 void          _dbus_header_reinit                 (DBusHeader        *header,
  68                                                    int                byte_order);
  69 dbus_bool_t   _dbus_header_create                 (DBusHeader        *header,
  70                                                    int                type,
  71                                                    const char        *destination,
  72                                                    const char        *path,
  73                                                    const char        *interface,
  74                                                    const char        *member,
  75                                                    const char        *error_name);
  76 dbus_bool_t   _dbus_header_copy                   (const DBusHeader  *header,
  77                                                    DBusHeader        *dest);
  78 int           _dbus_header_get_message_type       (DBusHeader        *header);
  79 void          _dbus_header_set_serial             (DBusHeader        *header,
  80                                                    dbus_uint32_t      serial);
  81 dbus_uint32_t _dbus_header_get_serial             (DBusHeader        *header);
  82 void          _dbus_header_update_lengths         (DBusHeader        *header,
  83                                                    int                body_len);
  84 dbus_bool_t   _dbus_header_set_field_basic        (DBusHeader        *header,
  85                                                    int                field,
  86                                                    int                type,
  87                                                    const void        *value);
  88 dbus_bool_t   _dbus_header_get_field_basic        (DBusHeader        *header,
  89                                                    int                field,
  90                                                    int                type,
  91                                                    void              *value);
  92 dbus_bool_t   _dbus_header_get_field_raw          (DBusHeader        *header,
  93                                                    int                field,
  94                                                    const DBusString **str,
  95                                                    int               *pos);
  96 dbus_bool_t   _dbus_header_delete_field           (DBusHeader        *header,
  97                                                    int                field);
  98 void          _dbus_header_toggle_flag            (DBusHeader        *header,
  99                                                    dbus_uint32_t      flag,
 100                                                    dbus_bool_t        value);
 101 dbus_bool_t   _dbus_header_get_flag               (DBusHeader        *header,
 102                                                    dbus_uint32_t      flag);
 103 dbus_bool_t   _dbus_header_ensure_signature       (DBusHeader        *header,
 104                                                    DBusString       **type_str,
 105                                                    int               *type_pos);
 106 dbus_bool_t   _dbus_header_have_message_untrusted (int                max_message_length,
 107                                                    DBusValidity      *validity,
 108                                                    int               *byte_order,
 109                                                    int               *fields_array_len,
 110                                                    int               *header_len,
 111                                                    int               *body_len,
 112                                                    const DBusString  *str,
 113                                                    int                start,
 114                                                    int                len);
 115 dbus_bool_t   _dbus_header_load_untrusted         (DBusHeader        *header,
 116                                                    DBusValidity      *validity,
 117                                                    int                byte_order,
 118                                                    int                fields_array_len,
 119                                                    int                header_len,
 120                                                    int                body_len,
 121                                                    const DBusString  *str,
 122                                                    int                start,
 123                                                    int                len);
 124
 125
 126
 127
 128 #endif /* DBUS_MARSHAL_HEADER_H */