D-Bus: dbus-message-internal.h Source File

D-Bus 1.14.4

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 * 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 *
22 */
23#ifndef DBUS_MESSAGE_INTERNAL_H
24#define DBUS_MESSAGE_INTERNAL_H
25
26#include <dbus/dbus-marshal-validate.h>
27#include <dbus/dbus-message.h>
28#include <dbus/dbus-resources.h>
29#include <dbus/dbus-list.h>
30
31 DBUS_BEGIN_DECLS
32
33#ifdef DBUS_ENABLE_VERBOSE_MODE
34void _dbus_message_trace_ref (DBusMessage *message,
35 int old_refcount,
36 int new_refcount,
37 const char *why);
38#else
39/* this bypasses any "unused" warnings for the old and new refcount */
40#define _dbus_message_trace_ref(m, o, n, w) \
41 do \
42 {\
43 (void) (o); \
44 (void) (n); \
45 } while (0)
46#endif
47
48 typedef struct DBusMessageLoader DBusMessageLoader;
49
50void _dbus_message_get_network_data (DBusMessage *message,
51 const DBusString **header,
52 const DBusString **body);
53DBUS_PRIVATE_EXPORT
54void _dbus_message_get_unix_fds (DBusMessage *message,
55 const int **fds,
56 unsigned *n_fds);
57
58unsigned int _dbus_message_get_n_unix_fds (DBusMessage *message);
59void _dbus_message_lock (DBusMessage *message);
60void _dbus_message_unlock (DBusMessage *message);
61 dbus_bool_t _dbus_message_add_counter (DBusMessage *message,
62 DBusCounter *counter);
63void _dbus_message_add_counter_link (DBusMessage *message,
64 DBusList *link);
65void _dbus_message_remove_counter (DBusMessage *message,
66 DBusCounter *counter);
67DBUS_PRIVATE_EXPORT
68 dbus_bool_t _dbus_message_remove_unknown_fields (DBusMessage *message);
69
70DBUS_PRIVATE_EXPORT
71 DBusMessageLoader* _dbus_message_loader_new (void);
72DBUS_PRIVATE_EXPORT
73 DBusMessageLoader* _dbus_message_loader_ref (DBusMessageLoader *loader);
74DBUS_PRIVATE_EXPORT
75void _dbus_message_loader_unref (DBusMessageLoader *loader);
76
77DBUS_PRIVATE_EXPORT
78void _dbus_message_loader_get_buffer (DBusMessageLoader *loader,
79 DBusString **buffer,
80 int *max_to_read,
81 dbus_bool_t *may_read_unix_fds);
82DBUS_PRIVATE_EXPORT
83void _dbus_message_loader_return_buffer (DBusMessageLoader *loader,
84 DBusString *buffer);
85
86
87#ifdef HAVE_UNIX_FD_PASSING
88DBUS_PRIVATE_EXPORT
89 dbus_bool_t _dbus_message_loader_get_unix_fds (DBusMessageLoader *loader,
90 int **fds,
91 unsigned *max_n_fds);
92
93DBUS_PRIVATE_EXPORT
94void _dbus_message_loader_return_unix_fds (DBusMessageLoader *loader,
95 int *fds,
96 unsigned n_fds);
97#endif
98
99DBUS_PRIVATE_EXPORT
100 dbus_bool_t _dbus_message_loader_queue_messages (DBusMessageLoader *loader);
101 DBusMessage* _dbus_message_loader_peek_message (DBusMessageLoader *loader);
102DBUS_PRIVATE_EXPORT
103 DBusMessage* _dbus_message_loader_pop_message (DBusMessageLoader *loader);
104 DBusList* _dbus_message_loader_pop_message_link (DBusMessageLoader *loader);
105void _dbus_message_loader_putback_message_link (DBusMessageLoader *loader,
106 DBusList *link);
107
108DBUS_PRIVATE_EXPORT
109 dbus_bool_t _dbus_message_loader_get_is_corrupted (DBusMessageLoader *loader);
110 DBusValidity _dbus_message_loader_get_corruption_reason (DBusMessageLoader *loader);
111
112void _dbus_message_loader_set_max_message_size (DBusMessageLoader *loader,
113 long size);
114DBUS_PRIVATE_EXPORT
115long _dbus_message_loader_get_max_message_size (DBusMessageLoader *loader);
116
117void _dbus_message_loader_set_max_message_unix_fds(DBusMessageLoader *loader,
118 long n);
119long _dbus_message_loader_get_max_message_unix_fds(DBusMessageLoader *loader);
120int _dbus_message_loader_get_pending_fds_count (DBusMessageLoader *loader);
121void _dbus_message_loader_set_pending_fds_function (DBusMessageLoader *loader,
122 void (* callback) (void *),
123 void *data);
124
125typedef struct DBusVariant DBusVariant;
126DBUS_PRIVATE_EXPORT
127 DBusVariant *_dbus_variant_read (DBusMessageIter *reader);
128DBUS_PRIVATE_EXPORT
129 dbus_bool_t _dbus_variant_write (DBusVariant *self,
130 DBusMessageIter *writer);
131DBUS_PRIVATE_EXPORT
132void _dbus_variant_free (DBusVariant *self);
133DBUS_PRIVATE_EXPORT
134int _dbus_variant_get_length (DBusVariant *self);
135DBUS_PRIVATE_EXPORT
136const DBusString *_dbus_variant_peek (DBusVariant *self);
137DBUS_PRIVATE_EXPORT
138const char *_dbus_variant_get_signature (DBusVariant *self);
139
140static inline void
141_dbus_clear_variant (DBusVariant **variant_p)
142{
143 _dbus_clear_pointer_impl (DBusVariant, variant_p, _dbus_variant_free);
144}
145
146 DBUS_END_DECLS
147
148#endif /* DBUS_MESSAGE_INTERNAL_H */
DBUS_BEGIN_DECLS
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
DBUS_END_DECLS
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.
DBusValidity
DBusValidity
This is primarily used in unit testing, so we can verify that each invalid message is invalid for the...
Definition: dbus-marshal-validate.h:52
_dbus_message_loader_set_max_message_size
void _dbus_message_loader_set_max_message_size(DBusMessageLoader *loader, long size)
Sets the maximum size message we allow.
Definition: dbus-message.c:4821
_dbus_message_remove_unknown_fields
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:272
_dbus_variant_read
DBUS_PRIVATE_EXPORT DBusVariant * _dbus_variant_read(DBusMessageIter *reader)
Copy a single D-Bus message item from reader into a newly-allocated DBusVariant.
Definition: dbus-message.c:5324
_dbus_variant_write
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_variant_write(DBusVariant *self, DBusMessageIter *writer)
Copy the single D-Bus message item from self into writer.
Definition: dbus-message.c:5487
_dbus_message_loader_get_is_corrupted
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_message_loader_get_is_corrupted(DBusMessageLoader *loader)
Checks whether the loader is confused due to bad data.
Definition: dbus-message.c:4792
_dbus_message_get_n_unix_fds
unsigned int _dbus_message_get_n_unix_fds(DBusMessage *message)
Gets the number of unix fds attached to this message.
Definition: dbus-message-util.c:40
_dbus_message_loader_unref
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.
Definition: dbus-message.c:4217
_dbus_message_get_unix_fds
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:250
_dbus_message_loader_pop_message
DBUS_PRIVATE_EXPORT DBusMessage * _dbus_message_loader_pop_message(DBusMessageLoader *loader)
Pops a loaded message (passing ownership of the message to the caller).
Definition: dbus-message.c:4750
_dbus_message_get_network_data
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:231
_dbus_message_loader_set_pending_fds_function
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...
Definition: dbus-message.c:4900
_dbus_message_loader_putback_message_link
void _dbus_message_loader_putback_message_link(DBusMessageLoader *loader, DBusList *link)
Returns a popped message link, used to undo a pop.
Definition: dbus-message.c:4776
_dbus_message_loader_get_pending_fds_count
int _dbus_message_loader_get_pending_fds_count(DBusMessageLoader *loader)
Return how many file descriptors are pending in the loader.
Definition: dbus-message.c:4882
_dbus_variant_get_signature
DBUS_PRIVATE_EXPORT const char * _dbus_variant_get_signature(DBusVariant *self)
Return the signature of the item stored in self.
Definition: dbus-message.c:5460
_dbus_message_loader_get_buffer
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.
Definition: dbus-message.c:4252
_dbus_message_remove_counter
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:387
_dbus_message_add_counter
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,...
Definition: dbus-message.c:364
_dbus_message_loader_peek_message
DBusMessage * _dbus_message_loader_peek_message(DBusMessageLoader *loader)
Peeks at first loaded message, returns NULL if no messages have been queued.
Definition: dbus-message.c:4733
_dbus_message_loader_set_max_message_unix_fds
void _dbus_message_loader_set_max_message_unix_fds(DBusMessageLoader *loader, long n)
Sets the maximum unix fds per message we allow.
Definition: dbus-message.c:4852
_dbus_message_loader_get_max_message_size
DBUS_PRIVATE_EXPORT long _dbus_message_loader_get_max_message_size(DBusMessageLoader *loader)
Gets the maximum allowed message size in bytes.
Definition: dbus-message.c:4840
_dbus_message_loader_new
DBUS_PRIVATE_EXPORT DBusMessageLoader * _dbus_message_loader_new(void)
Creates a new message loader.
Definition: dbus-message.c:4155
_dbus_message_loader_pop_message_link
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).
Definition: dbus-message.c:4764
_dbus_message_loader_queue_messages
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_message_loader_queue_messages(DBusMessageLoader *loader)
Converts buffered data into messages, if we have enough data.
Definition: dbus-message.c:4670
_dbus_message_loader_return_buffer
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...
Definition: dbus-message.c:4358
_dbus_message_loader_ref
DBUS_PRIVATE_EXPORT DBusMessageLoader * _dbus_message_loader_ref(DBusMessageLoader *loader)
Increments the reference count of the loader.
Definition: dbus-message.c:4203
_dbus_message_loader_get_max_message_unix_fds
long _dbus_message_loader_get_max_message_unix_fds(DBusMessageLoader *loader)
Gets the maximum allowed number of unix fds per message.
Definition: dbus-message.c:4871
_dbus_message_add_counter_link
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,...
Definition: dbus-message.c:315
_dbus_message_loader_get_corruption_reason
DBusValidity _dbus_message_loader_get_corruption_reason(DBusMessageLoader *loader)
Checks what kind of bad data confused the loader.
Definition: dbus-message.c:4806
dbus_bool_t
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
DBusCounter
Internals of DBusCounter.
Definition: dbus-resources.c:55
DBusList
A node in a linked list.
Definition: dbus-list.h:35
DBusMessageIter
DBusMessageIter struct; contains no public fields.
Definition: dbus-message.h:62
DBusMessageLoader
Implementation details of DBusMessageLoader.
Definition: dbus-message-private.h:61
DBusMessageLoader::data
DBusString data
Buffered data.
Definition: dbus-message-private.h:64
DBusMessage
Internals of DBusMessage.
Definition: dbus-message-private.h:100
DBusString
Definition: dbus-string.h:43
DBusVariant
An opaque data structure containing the serialized form of any single D-Bus message item,...
Definition: dbus-message.c:5308