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

D-Bus 1.10.22

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
34 void _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
50 void _dbus_message_get_network_data (DBusMessage *message,
51 const DBusString **header,
52 const DBusString **body);
53 DBUS_PRIVATE_EXPORT
54 void _dbus_message_get_unix_fds (DBusMessage *message,
55 const int **fds,
56 unsigned *n_fds);
57
58 void _dbus_message_lock (DBusMessage *message);
59 void _dbus_message_unlock (DBusMessage *message);
60 dbus_bool_t _dbus_message_add_counter (DBusMessage *message,
61 DBusCounter *counter);
62 void _dbus_message_add_counter_link (DBusMessage *message,
63 DBusList *link);
64 void _dbus_message_remove_counter (DBusMessage *message,
65 DBusCounter *counter);
66
67 DBUS_PRIVATE_EXPORT
68 DBusMessageLoader* _dbus_message_loader_new (void);
69 DBUS_PRIVATE_EXPORT
70 DBusMessageLoader* _dbus_message_loader_ref (DBusMessageLoader *loader);
71 DBUS_PRIVATE_EXPORT
72 void _dbus_message_loader_unref (DBusMessageLoader *loader);
73
74 DBUS_PRIVATE_EXPORT
75 void _dbus_message_loader_get_buffer (DBusMessageLoader *loader,
76 DBusString **buffer);
77 DBUS_PRIVATE_EXPORT
78 void _dbus_message_loader_return_buffer (DBusMessageLoader *loader,
79 DBusString *buffer);
80
81 DBUS_PRIVATE_EXPORT
82 dbus_bool_t _dbus_message_loader_get_unix_fds (DBusMessageLoader *loader,
83 int **fds,
84 unsigned *max_n_fds);
85 DBUS_PRIVATE_EXPORT
86 void _dbus_message_loader_return_unix_fds (DBusMessageLoader *loader,
87 int *fds,
88 unsigned n_fds);
89
90 DBUS_PRIVATE_EXPORT
91 dbus_bool_t _dbus_message_loader_queue_messages (DBusMessageLoader *loader);
92 DBusMessage* _dbus_message_loader_peek_message (DBusMessageLoader *loader);
93 DBUS_PRIVATE_EXPORT
94 DBusMessage* _dbus_message_loader_pop_message (DBusMessageLoader *loader);
95 DBusList* _dbus_message_loader_pop_message_link (DBusMessageLoader *loader);
96 void _dbus_message_loader_putback_message_link (DBusMessageLoader *loader,
97 DBusList *link);
98
99 DBUS_PRIVATE_EXPORT
100 dbus_bool_t _dbus_message_loader_get_is_corrupted (DBusMessageLoader *loader);
101 DBusValidity _dbus_message_loader_get_corruption_reason (DBusMessageLoader *loader);
102
103 void _dbus_message_loader_set_max_message_size (DBusMessageLoader *loader,
104 long size);
105 DBUS_PRIVATE_EXPORT
106 long _dbus_message_loader_get_max_message_size (DBusMessageLoader *loader);
107
108 void _dbus_message_loader_set_max_message_unix_fds(DBusMessageLoader *loader,
109 long n);
110 long _dbus_message_loader_get_max_message_unix_fds(DBusMessageLoader *loader);
111 int _dbus_message_loader_get_pending_fds_count (DBusMessageLoader *loader);
112 void _dbus_message_loader_set_pending_fds_function (DBusMessageLoader *loader,
113 void (* callback) (void *),
114 void *data);
115
116 typedef struct DBusInitialFDs DBusInitialFDs;
117 DBusInitialFDs *_dbus_check_fdleaks_enter (void);
118 void _dbus_check_fdleaks_leave (DBusInitialFDs *fds);
119
120 DBUS_END_DECLS
121
122 #endif /* DBUS_MESSAGE_INTERNAL_H */
_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:4563
_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:4499
_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:4073
_dbus_message_loader_return_unix_fds
DBUS_PRIVATE_EXPORT void _dbus_message_loader_return_unix_fds(DBusMessageLoader *loader, int *fds, unsigned n_fds)
Returns a buffer obtained from _dbus_message_loader_get_unix_fds().
Definition: dbus-message.c:4142
DBUS_BEGIN_DECLS
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
_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:4473
DBusCounter
Internals of DBusCounter.
Definition: dbus-resources.c:54
_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:4016
_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:4529
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:49
_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, and decremented by the size/unix fds of this message when this message if finalized.
Definition: dbus-message.c:352
_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, and decremented by the size/unix fds of this message when this message if finalized.
Definition: dbus-message.c:303
DBusMessage
Internals of DBusMessage.
Definition: dbus-message-private.h:99
DBusString
Definition: dbus-string.h:42
_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:4544
dbus_bool_t
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
DBusMessageLoader::data
DBusString data
Buffered data.
Definition: dbus-message-private.h:64
_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:4002
_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:375
_dbus_message_loader_new
DBUS_PRIVATE_EXPORT DBusMessageLoader * _dbus_message_loader_new(void)
Creates a new message loader.
Definition: dbus-message.c:3954
_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:4623
_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:4515
_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:4594
_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_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:4487
DBusList
A node in a linked list.
Definition: dbus-list.h:34
_dbus_message_loader_get_unix_fds
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_message_loader_get_unix_fds(DBusMessageLoader *loader, int **fds, unsigned *max_n_fds)
Gets the buffer to use for reading unix fds from the network.
Definition: dbus-message.c:4093
_dbus_message_loader_get_buffer
DBUS_PRIVATE_EXPORT void _dbus_message_loader_get_buffer(DBusMessageLoader *loader, DBusString **buffer)
Gets the buffer to use for reading data from the network.
Definition: dbus-message.c:4053
_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:4456
_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:4393
_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_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:4575
DBusMessageLoader
Implementation details of DBusMessageLoader.
Definition: dbus-message-private.h:60
_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:4605
DBUS_END_DECLS
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.