D-Bus  1.16.2
dbus-message-internal.h
1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-message-internal.h DBusMessage object internal interfaces
3  *
4  * Copyright (C) 2002 Red Hat Inc.
5  *
6  * SPDX-License-Identifier: AFL-2.1 OR GPL-2.0-or-later
7  *
8  * Licensed under the Academic Free License version 2.1
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23  *
24  */
25 #ifndef DBUS_MESSAGE_INTERNAL_H
26 #define DBUS_MESSAGE_INTERNAL_H
27 
28 #include <dbus/dbus-marshal-validate.h>
29 #include <dbus/dbus-message.h>
30 #include <dbus/dbus-resources.h>
31 #include <dbus/dbus-list.h>
32 
34 
35 #ifdef DBUS_ENABLE_VERBOSE_MODE
36 void _dbus_message_trace_ref (DBusMessage *message,
37  int old_refcount,
38  int new_refcount,
39  const char *why);
40 #else
41 /* this bypasses any "unused" warnings for the old and new refcount */
42 #define _dbus_message_trace_ref(m, o, n, w) \
43  do \
44  {\
45  (void) (o); \
46  (void) (n); \
47  } while (0)
48 #endif
49 
51 
53  const DBusString **header,
54  const DBusString **body);
55 DBUS_PRIVATE_EXPORT
57  const int **fds,
58  unsigned *n_fds);
59 
60 unsigned int _dbus_message_get_n_unix_fds (DBusMessage *message);
61 void _dbus_message_lock (DBusMessage *message);
62 void _dbus_message_unlock (DBusMessage *message);
64  DBusCounter *counter);
66  DBusList *link);
68  DBusCounter *counter);
69 DBUS_PRIVATE_EXPORT
71 
72 DBUS_PRIVATE_EXPORT
74 DBUS_PRIVATE_EXPORT
76 DBUS_PRIVATE_EXPORT
78 
79 DBUS_PRIVATE_EXPORT
81  DBusString **buffer,
82  int *max_to_read,
83  dbus_bool_t *may_read_unix_fds);
84 DBUS_PRIVATE_EXPORT
86  DBusString *buffer);
87 
88 
89 #ifdef HAVE_UNIX_FD_PASSING
90 DBUS_PRIVATE_EXPORT
91 dbus_bool_t _dbus_message_loader_get_unix_fds (DBusMessageLoader *loader,
92  int **fds,
93  unsigned *max_n_fds);
94 
95 DBUS_PRIVATE_EXPORT
96 void _dbus_message_loader_return_unix_fds (DBusMessageLoader *loader,
97  int *fds,
98  unsigned n_fds);
99 #endif
100 
101 DBUS_PRIVATE_EXPORT
104 DBUS_PRIVATE_EXPORT
108  DBusList *link);
109 
110 DBUS_PRIVATE_EXPORT
113 
115  long size);
116 DBUS_PRIVATE_EXPORT
118 
120  long n);
124  void (* callback) (void *),
125  void *data);
126 
127 typedef struct DBusVariant DBusVariant;
128 DBUS_PRIVATE_EXPORT
130 DBUS_PRIVATE_EXPORT
132  DBusMessageIter *writer);
133 DBUS_PRIVATE_EXPORT
134 void _dbus_variant_free (DBusVariant *self);
135 DBUS_PRIVATE_EXPORT
136 int _dbus_variant_get_length (DBusVariant *self);
137 DBUS_PRIVATE_EXPORT
138 const DBusString *_dbus_variant_peek (DBusVariant *self);
139 DBUS_PRIVATE_EXPORT
140 const char *_dbus_variant_get_signature (DBusVariant *self);
141 
142 static inline void
143 _dbus_clear_variant (DBusVariant **variant_p)
144 {
145  _dbus_clear_pointer_impl (DBusVariant, variant_p, _dbus_variant_free);
146 }
147 
149 
150 #endif /* DBUS_MESSAGE_INTERNAL_H */
DBUS_PRIVATE_EXPORT long _dbus_message_loader_get_max_message_size(DBusMessageLoader *loader)
Gets the maximum allowed message size in bytes.
void _dbus_message_loader_putback_message_link(DBusMessageLoader *loader, DBusList *link)
Returns a popped message link, used to undo a pop.
DBUS_PRIVATE_EXPORT void _dbus_message_loader_return_buffer(DBusMessageLoader *loader, DBusString *buffer)
Returns a buffer obtained from _dbus_message_loader_get_buffer(), indicating to the loader how many b...
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
DBUS_PRIVATE_EXPORT DBusMessage * _dbus_message_loader_pop_message(DBusMessageLoader *loader)
Pops a loaded message (passing ownership of the message to the caller).
DBUS_PRIVATE_EXPORT const char * _dbus_variant_get_signature(DBusVariant *self)
Return the signature of the item stored in self.
Internals of DBusCounter.
unsigned int _dbus_message_get_n_unix_fds(DBusMessage *message)
Gets the number of unix fds attached to this message.
An opaque data structure containing the serialized form of any single D-Bus message item...
DBUS_PRIVATE_EXPORT void _dbus_message_loader_unref(DBusMessageLoader *loader)
Decrements the reference count of the loader and finalizes the loader when the count reaches zero...
DBusValidity _dbus_message_loader_get_corruption_reason(DBusMessageLoader *loader)
Checks what kind of bad data confused the loader.
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_message_remove_unknown_fields(DBusMessage *message)
Remove every header field not known to this version of dbus.
Definition: dbus-message.c:284
DBusValidity
This is primarily used in unit testing, so we can verify that each invalid message is invalid for the...
DBusMessageIter struct; contains no public fields.
Definition: dbus-message.h:63
dbus_bool_t _dbus_message_add_counter(DBusMessage *message, DBusCounter *counter)
Adds a counter to be incremented immediately with the size/unix fds of this message, and decremented by the size/unix fds of this message when this message if finalized.
Definition: dbus-message.c:376
void _dbus_message_add_counter_link(DBusMessage *message, DBusList *link)
Adds a counter to be incremented immediately with the size/unix fds of this message, and decremented by the size/unix fds of this message when this message if finalized.
Definition: dbus-message.c:327
Internals of DBusMessage.
void _dbus_message_loader_set_max_message_size(DBusMessageLoader *loader, long size)
Sets the maximum size message we allow.
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:37
DBusString data
Buffered data.
DBUS_PRIVATE_EXPORT DBusMessageLoader * _dbus_message_loader_ref(DBusMessageLoader *loader)
Increments the reference count of the loader.
void _dbus_message_remove_counter(DBusMessage *message, DBusCounter *counter)
Removes a counter tracking the size/unix fds of this message, and decrements the counter by the size/...
Definition: dbus-message.c:399
DBUS_PRIVATE_EXPORT DBusMessageLoader * _dbus_message_loader_new(void)
Creates a new message loader.
void _dbus_message_loader_set_pending_fds_function(DBusMessageLoader *loader, void(*callback)(void *), void *data)
Register a function to be called whenever the number of pending file descriptors in the loader change...
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_message_loader_get_is_corrupted(DBusMessageLoader *loader)
Checks whether the loader is confused due to bad data.
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_variant_write(DBusVariant *self, DBusMessageIter *writer)
Copy the single D-Bus message item from self into writer.
long _dbus_message_loader_get_max_message_unix_fds(DBusMessageLoader *loader)
Gets the maximum allowed number of unix fds per message.
void _dbus_message_get_network_data(DBusMessage *message, const DBusString **header, const DBusString **body)
Gets the data to be sent over the network for this message.
Definition: dbus-message.c:243
DBUS_PRIVATE_EXPORT DBusVariant * _dbus_variant_read(DBusMessageIter *reader)
Copy a single D-Bus message item from reader into a newly-allocated DBusVariant.
DBusList * _dbus_message_loader_pop_message_link(DBusMessageLoader *loader)
Pops a loaded message inside a list link (passing ownership of the message and link to the caller)...
A node in a linked list.
Definition: dbus-list.h:36
DBusMessage * _dbus_message_loader_peek_message(DBusMessageLoader *loader)
Peeks at first loaded message, returns NULL if no messages have been queued.
DBUS_PRIVATE_EXPORT void _dbus_message_loader_get_buffer(DBusMessageLoader *loader, DBusString **buffer, int *max_to_read, dbus_bool_t *may_read_unix_fds)
Gets the buffer to use for reading data from the network.
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_message_loader_queue_messages(DBusMessageLoader *loader)
Converts buffered data into messages, if we have enough data.
DBUS_PRIVATE_EXPORT void _dbus_message_get_unix_fds(DBusMessage *message, const int **fds, unsigned *n_fds)
Gets the unix fds to be sent over the network for this message.
Definition: dbus-message.c:262
void _dbus_message_loader_set_max_message_unix_fds(DBusMessageLoader *loader, long n)
Sets the maximum unix fds per message we allow.
Implementation details of DBusMessageLoader.
int _dbus_message_loader_get_pending_fds_count(DBusMessageLoader *loader)
Return how many file descriptors are pending in the loader.
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.