1 /* -*- mode: C; c-file-style: "gnu" -*- */
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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>
32 #error "config.h not included here"
35 typedef struct DBusHeader DBusHeader;
36 typedef struct DBusHeaderField DBusHeaderField;
38 #define _DBUS_HEADER_FIELD_VALUE_UNKNOWN -1
39 #define _DBUS_HEADER_FIELD_VALUE_NONEXISTENT -2
42 * Cached information about a header field in the message
44 struct DBusHeaderField
46 int value_pos; /**< Position of field value, or -1/-2 */
50 * Message header data and some cached details of it.
54 DBusString data; /**< Header network data, stored
55 * separately from body so we can
56 * independently realloc it.
59 DBusHeaderField fields[DBUS_HEADER_FIELD_LAST + 1]; /**< Track the location
60 * of each field in header
63 dbus_uint32_t padding : 3; /**< bytes of alignment in header */
64 dbus_uint32_t byte_order : 8; /**< byte order of header */
67 dbus_bool_t _dbus_header_init (DBusHeader *header,
69 void _dbus_header_free (DBusHeader *header);
70 void _dbus_header_reinit (DBusHeader *header,
72 dbus_bool_t _dbus_header_create (DBusHeader *header,
74 const char *destination,
76 const char *interface,
78 const char *error_name);
79 dbus_bool_t _dbus_header_copy (const DBusHeader *header,
81 int _dbus_header_get_message_type (DBusHeader *header);
82 void _dbus_header_set_serial (DBusHeader *header,
83 dbus_uint32_t serial);
84 dbus_uint32_t _dbus_header_get_serial (DBusHeader *header);
85 void _dbus_header_update_lengths (DBusHeader *header,
87 dbus_bool_t _dbus_header_set_field_basic (DBusHeader *header,
91 dbus_bool_t _dbus_header_get_field_basic (DBusHeader *header,
95 dbus_bool_t _dbus_header_get_field_raw (DBusHeader *header,
97 const DBusString **str,
99 dbus_bool_t _dbus_header_delete_field (DBusHeader *header,
101 void _dbus_header_toggle_flag (DBusHeader *header,
104 dbus_bool_t _dbus_header_get_flag (DBusHeader *header,
106 dbus_bool_t _dbus_header_ensure_signature (DBusHeader *header,
107 DBusString **type_str,
109 dbus_bool_t _dbus_header_have_message_untrusted (int max_message_length,
110 DBusValidity *validity,
112 int *fields_array_len,
115 const DBusString *str,
118 dbus_bool_t _dbus_header_load (DBusHeader *header,
119 DBusValidationMode mode,
120 DBusValidity *validity,
122 int fields_array_len,
125 const DBusString *str,
128 void _dbus_header_byteswap (DBusHeader *header,
133 #endif /* DBUS_MARSHAL_HEADER_H */