1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-message-private.h header shared between dbus-message.c and dbus-message-util.c
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
23 #ifndef DBUS_MESSAGE_PRIVATE_H
24 #define DBUS_MESSAGE_PRIVATE_H
28 #include <dbus/dbus-message.h>
29 #include <dbus/dbus-message-internal.h>
30 #include <dbus/dbus-string.h>
31 #include <dbus/dbus-dataslot.h>
32 #include <dbus/dbus-marshal-header.h>
37 * @addtogroup DBusMessageInternals
42 * @typedef DBusMessageLoader
44 * The DBusMessageLoader object encapsulates the process of converting
45 * a byte stream into a series of DBusMessage. It buffers the incoming
46 * bytes as efficiently as possible, and generates a queue of
47 * messages. DBusMessageLoader is typically used as part of a
48 * DBusTransport implementation. The DBusTransport then hands off
49 * the loaded messages to a DBusConnection, making the messages
50 * visible to the application.
52 * @todo write tests for break-loader that a) randomly delete header
53 * fields and b) set string fields to zero-length and other funky
59 * Implementation details of DBusMessageLoader.
60 * All members are private.
62 struct DBusMessageLoader
64 int refcount; /**< Reference count. */
66 DBusString data; /**< Buffered data */
68 DBusList *messages; /**< Complete messages. */
70 long max_message_size; /**< Maximum size of a message */
71 long max_message_unix_fds; /**< Maximum unix fds in a message */
73 DBusValidity corruption_reason; /**< why we were corrupted */
75 unsigned int corrupted : 1; /**< We got broken data, and are no longer working */
77 unsigned int buffer_outstanding : 1; /**< Someone is using the buffer to read */
79 #ifdef HAVE_UNIX_FD_PASSING
80 unsigned int unix_fds_outstanding : 1; /**< Someone is using the unix fd array to read */
82 int *unix_fds; /**< File descriptors that have been read from the transport but not yet been handed to any message. Array will be allocated at first use. */
83 unsigned n_unix_fds_allocated; /**< Number of file descriptors this array has space for */
84 unsigned n_unix_fds; /**< Number of valid file descriptors in array */
89 /** How many bits are in the changed_stamp used to validate iterators */
90 #define CHANGED_STAMP_BITS 21
93 * @brief Internals of DBusMessage
95 * Object representing a message received from or to be sent to
96 * another application. This is an opaque object, all members
101 DBusAtomic refcount; /**< Reference count */
103 DBusHeader header; /**< Header network data and associated cache */
105 DBusString body; /**< Body network data. */
107 char byte_order; /**< Message byte order. */
109 unsigned int locked : 1; /**< Message being sent, no modifications allowed. */
111 #ifndef DBUS_DISABLE_CHECKS
112 unsigned int in_cache : 1; /**< Has been "freed" since it's in the cache (this is a debug feature) */
115 DBusList *size_counters; /**< 0-N DBusCounter used to track message size. */
116 long size_counter_delta; /**< Size we incremented the size counters by. */
118 dbus_uint32_t changed_stamp : CHANGED_STAMP_BITS; /**< Incremented when iterators are invalidated. */
120 DBusDataSlotList slot_list; /**< Data stored by allocated integer ID */
122 #ifndef DBUS_DISABLE_CHECKS
123 int generation; /**< _dbus_current_generation when message was created */
126 #ifdef HAVE_UNIX_FD_PASSING
128 /**< Unix file descriptors associated with this message. These are
129 closed when the message is destroyed, hence make sure to dup()
130 them when adding or removing them here. */
131 unsigned n_unix_fds; /**< Number of valid fds in the array */
132 unsigned n_unix_fds_allocated; /**< Allocated size of the array */
136 dbus_bool_t _dbus_message_iter_get_args_valist (DBusMessageIter *iter,
142 void _dbus_check_fdleaks(void);
148 #endif /* DBUS_MESSAGE_H */