1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-marshal-header.h Managing marshaling/demarshaling of message headers
4 * Copyright (C) 2005 Red Hat, Inc.
6 * Licensed under the Academic Free License version 2.1
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.
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.
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 #ifndef DBUS_MARSHAL_HEADER_H
25 #define DBUS_MARSHAL_HEADER_H
28 #include <dbus/dbus-marshal-basic.h>
29 #include <dbus/dbus-marshal-validate.h>
31 typedef struct DBusHeader DBusHeader;
32 typedef struct DBusHeaderField DBusHeaderField;
34 #define _DBUS_HEADER_FIELD_VALUE_UNKNOWN -1
35 #define _DBUS_HEADER_FIELD_VALUE_NONEXISTENT -2
38 * Cached information about a header field in the message
40 struct DBusHeaderField
42 int value_pos; /**< Position of field value, or -1/-2 */
46 * Message header data and some cached details of it.
50 DBusString data; /**< Header network data, stored
51 * separately from body so we can
52 * independently realloc it.
55 DBusHeaderField fields[DBUS_HEADER_FIELD_LAST + 1]; /**< Track the location
56 * of each field in header
59 dbus_uint32_t padding : 3; /**< bytes of alignment in header */
60 dbus_uint32_t byte_order : 8; /**< byte order of header */
63 dbus_bool_t _dbus_header_init (DBusHeader *header,
65 void _dbus_header_free (DBusHeader *header);
66 void _dbus_header_reinit (DBusHeader *header,
68 dbus_bool_t _dbus_header_create (DBusHeader *header,
70 const char *destination,
72 const char *interface,
74 const char *error_name);
75 dbus_bool_t _dbus_header_copy (const DBusHeader *header,
77 int _dbus_header_get_message_type (DBusHeader *header);
78 void _dbus_header_set_serial (DBusHeader *header,
79 dbus_uint32_t serial);
80 dbus_uint32_t _dbus_header_get_serial (DBusHeader *header);
81 void _dbus_header_update_lengths (DBusHeader *header,
83 dbus_bool_t _dbus_header_set_field_basic (DBusHeader *header,
87 dbus_bool_t _dbus_header_get_field_basic (DBusHeader *header,
91 dbus_bool_t _dbus_header_get_field_raw (DBusHeader *header,
93 const DBusString **str,
95 dbus_bool_t _dbus_header_delete_field (DBusHeader *header,
97 void _dbus_header_toggle_flag (DBusHeader *header,
100 dbus_bool_t _dbus_header_get_flag (DBusHeader *header,
102 dbus_bool_t _dbus_header_ensure_signature (DBusHeader *header,
103 DBusString **type_str,
105 dbus_bool_t _dbus_header_have_message_untrusted (int max_message_length,
106 DBusValidity *validity,
108 int *fields_array_len,
111 const DBusString *str,
114 dbus_bool_t _dbus_header_load (DBusHeader *header,
115 DBusValidationMode mode,
116 DBusValidity *validity,
118 int fields_array_len,
121 const DBusString *str,
124 void _dbus_header_byteswap (DBusHeader *header,
129 #endif /* DBUS_MARSHAL_HEADER_H */