]> git.ipfire.org Git - thirdparty/systemd.git/blob - src/systemd/sd-bus.h
9c37e7e6c97550416cb861cf3774d657a4152d05
[thirdparty/systemd.git] / src / systemd / sd-bus.h
1 /* SPDX-License-Identifier: LGPL-2.1+ */
2 #ifndef foosdbushfoo
3 #define foosdbushfoo
4
5 /***
6 systemd is free software; you can redistribute it and/or modify it
7 under the terms of the GNU Lesser General Public License as published by
8 the Free Software Foundation; either version 2.1 of the License, or
9 (at your option) any later version.
10
11 systemd is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Lesser General Public License for more details.
15
16 You should have received a copy of the GNU Lesser General Public License
17 along with systemd; If not, see <http://www.gnu.org/licenses/>.
18 ***/
19
20 #include <inttypes.h>
21 #include <stdarg.h>
22 #include <stdio.h>
23 #include <sys/types.h>
24 #include <sys/uio.h>
25
26 #include "sd-event.h"
27 #include "sd-id128.h"
28
29 #include "_sd-common.h"
30
31 _SD_BEGIN_DECLARATIONS;
32
33 #define SD_BUS_DEFAULT ((sd_bus *) 1)
34 #define SD_BUS_DEFAULT_USER ((sd_bus *) 2)
35 #define SD_BUS_DEFAULT_SYSTEM ((sd_bus *) 3)
36
37 /* Types */
38
39 typedef struct sd_bus sd_bus;
40 typedef struct sd_bus_message sd_bus_message;
41 typedef struct sd_bus_slot sd_bus_slot;
42 typedef struct sd_bus_creds sd_bus_creds;
43 typedef struct sd_bus_track sd_bus_track;
44
45 typedef struct {
46 const char *name;
47 const char *message;
48 int _need_free;
49 } sd_bus_error;
50
51 typedef struct {
52 const char *name;
53 int code;
54 } sd_bus_error_map;
55
56 /* Flags */
57
58 enum {
59 SD_BUS_CREDS_PID = 1ULL << 0,
60 SD_BUS_CREDS_TID = 1ULL << 1,
61 SD_BUS_CREDS_PPID = 1ULL << 2,
62 SD_BUS_CREDS_UID = 1ULL << 3,
63 SD_BUS_CREDS_EUID = 1ULL << 4,
64 SD_BUS_CREDS_SUID = 1ULL << 5,
65 SD_BUS_CREDS_FSUID = 1ULL << 6,
66 SD_BUS_CREDS_GID = 1ULL << 7,
67 SD_BUS_CREDS_EGID = 1ULL << 8,
68 SD_BUS_CREDS_SGID = 1ULL << 9,
69 SD_BUS_CREDS_FSGID = 1ULL << 10,
70 SD_BUS_CREDS_SUPPLEMENTARY_GIDS = 1ULL << 11,
71 SD_BUS_CREDS_COMM = 1ULL << 12,
72 SD_BUS_CREDS_TID_COMM = 1ULL << 13,
73 SD_BUS_CREDS_EXE = 1ULL << 14,
74 SD_BUS_CREDS_CMDLINE = 1ULL << 15,
75 SD_BUS_CREDS_CGROUP = 1ULL << 16,
76 SD_BUS_CREDS_UNIT = 1ULL << 17,
77 SD_BUS_CREDS_SLICE = 1ULL << 18,
78 SD_BUS_CREDS_USER_UNIT = 1ULL << 19,
79 SD_BUS_CREDS_USER_SLICE = 1ULL << 20,
80 SD_BUS_CREDS_SESSION = 1ULL << 21,
81 SD_BUS_CREDS_OWNER_UID = 1ULL << 22,
82 SD_BUS_CREDS_EFFECTIVE_CAPS = 1ULL << 23,
83 SD_BUS_CREDS_PERMITTED_CAPS = 1ULL << 24,
84 SD_BUS_CREDS_INHERITABLE_CAPS = 1ULL << 25,
85 SD_BUS_CREDS_BOUNDING_CAPS = 1ULL << 26,
86 SD_BUS_CREDS_SELINUX_CONTEXT = 1ULL << 27,
87 SD_BUS_CREDS_AUDIT_SESSION_ID = 1ULL << 28,
88 SD_BUS_CREDS_AUDIT_LOGIN_UID = 1ULL << 29,
89 SD_BUS_CREDS_TTY = 1ULL << 30,
90 SD_BUS_CREDS_UNIQUE_NAME = 1ULL << 31,
91 SD_BUS_CREDS_WELL_KNOWN_NAMES = 1ULL << 32,
92 SD_BUS_CREDS_DESCRIPTION = 1ULL << 33,
93 SD_BUS_CREDS_AUGMENT = 1ULL << 63, /* special flag, if on sd-bus will augment creds struct, in a potentially race-full way. */
94 _SD_BUS_CREDS_ALL = (1ULL << 34) -1
95 };
96
97 enum {
98 SD_BUS_NAME_REPLACE_EXISTING = 1ULL << 0,
99 SD_BUS_NAME_ALLOW_REPLACEMENT = 1ULL << 1,
100 SD_BUS_NAME_QUEUE = 1ULL << 2
101 };
102
103 enum {
104 SD_BUS_MESSAGE_DUMP_WITH_HEADER = 1ULL << 0,
105 SD_BUS_MESSAGE_DUMP_SUBTREE_ONLY = 1ULL << 1,
106 };
107
108 /* Callbacks */
109
110 typedef int (*sd_bus_message_handler_t)(sd_bus_message *m, void *userdata, sd_bus_error *ret_error);
111 typedef int (*sd_bus_property_get_t) (sd_bus *bus, const char *path, const char *interface, const char *property, sd_bus_message *reply, void *userdata, sd_bus_error *ret_error);
112 typedef int (*sd_bus_property_set_t) (sd_bus *bus, const char *path, const char *interface, const char *property, sd_bus_message *value, void *userdata, sd_bus_error *ret_error);
113 typedef int (*sd_bus_object_find_t) (sd_bus *bus, const char *path, const char *interface, void *userdata, void **ret_found, sd_bus_error *ret_error);
114 typedef int (*sd_bus_node_enumerator_t) (sd_bus *bus, const char *prefix, void *userdata, char ***ret_nodes, sd_bus_error *ret_error);
115 typedef int (*sd_bus_track_handler_t) (sd_bus_track *track, void *userdata);
116 typedef _sd_destroy_t sd_bus_destroy_t;
117
118 #include "sd-bus-protocol.h"
119 #include "sd-bus-vtable.h"
120
121 /* Naming */
122
123 int sd_bus_interface_name_is_valid(const char *p);
124 int sd_bus_service_name_is_valid(const char *p);
125 int sd_bus_member_name_is_valid(const char *p);
126 int sd_bus_object_path_is_valid(const char *p);
127
128 /* Connections */
129
130 int sd_bus_default(sd_bus **ret);
131 int sd_bus_default_user(sd_bus **ret);
132 int sd_bus_default_system(sd_bus **ret);
133
134 int sd_bus_open(sd_bus **ret);
135 int sd_bus_open_with_description(sd_bus **ret, const char *description);
136 int sd_bus_open_user(sd_bus **ret);
137 int sd_bus_open_user_with_description(sd_bus **ret, const char *description);
138 int sd_bus_open_system(sd_bus **ret);
139 int sd_bus_open_system_with_description(sd_bus **ret, const char *description);
140 int sd_bus_open_system_remote(sd_bus **ret, const char *host);
141 int sd_bus_open_system_machine(sd_bus **ret, const char *machine);
142
143 int sd_bus_new(sd_bus **ret);
144
145 int sd_bus_set_address(sd_bus *bus, const char *address);
146 int sd_bus_set_fd(sd_bus *bus, int input_fd, int output_fd);
147 int sd_bus_set_exec(sd_bus *bus, const char *path, char *const *argv);
148 int sd_bus_get_address(sd_bus *bus, const char **address);
149 int sd_bus_set_bus_client(sd_bus *bus, int b);
150 int sd_bus_is_bus_client(sd_bus *bus);
151 int sd_bus_set_server(sd_bus *bus, int b, sd_id128_t bus_id);
152 int sd_bus_is_server(sd_bus *bus);
153 int sd_bus_set_anonymous(sd_bus *bus, int b);
154 int sd_bus_is_anonymous(sd_bus *bus);
155 int sd_bus_set_trusted(sd_bus *bus, int b);
156 int sd_bus_is_trusted(sd_bus *bus);
157 int sd_bus_set_monitor(sd_bus *bus, int b);
158 int sd_bus_is_monitor(sd_bus *bus);
159 int sd_bus_set_description(sd_bus *bus, const char *description);
160 int sd_bus_get_description(sd_bus *bus, const char **description);
161 int sd_bus_negotiate_creds(sd_bus *bus, int b, uint64_t creds_mask);
162 int sd_bus_negotiate_timestamp(sd_bus *bus, int b);
163 int sd_bus_negotiate_fds(sd_bus *bus, int b);
164 int sd_bus_can_send(sd_bus *bus, char type);
165 int sd_bus_get_creds_mask(sd_bus *bus, uint64_t *creds_mask);
166 int sd_bus_set_allow_interactive_authorization(sd_bus *bus, int b);
167 int sd_bus_get_allow_interactive_authorization(sd_bus *bus);
168 int sd_bus_set_exit_on_disconnect(sd_bus *bus, int b);
169 int sd_bus_get_exit_on_disconnect(sd_bus *bus);
170 int sd_bus_set_close_on_exit(sd_bus *bus, int b);
171 int sd_bus_get_close_on_exit(sd_bus *bus);
172 int sd_bus_set_watch_bind(sd_bus *bus, int b);
173 int sd_bus_get_watch_bind(sd_bus *bus);
174 int sd_bus_set_connected_signal(sd_bus *bus, int b);
175 int sd_bus_get_connected_signal(sd_bus *bus);
176 int sd_bus_set_sender(sd_bus *bus, const char *sender);
177 int sd_bus_get_sender(sd_bus *bus, const char **ret);
178
179 int sd_bus_start(sd_bus *bus);
180
181 int sd_bus_try_close(sd_bus *bus) _sd_deprecated_;
182 void sd_bus_close(sd_bus *bus);
183
184 sd_bus* sd_bus_ref(sd_bus *bus);
185 sd_bus* sd_bus_unref(sd_bus *bus);
186 sd_bus* sd_bus_close_unref(sd_bus *bus);
187 sd_bus* sd_bus_flush_close_unref(sd_bus *bus);
188
189 void sd_bus_default_flush_close(void);
190
191 int sd_bus_is_open(sd_bus *bus);
192 int sd_bus_is_ready(sd_bus *bus);
193
194 int sd_bus_get_bus_id(sd_bus *bus, sd_id128_t *id);
195 int sd_bus_get_scope(sd_bus *bus, const char **scope);
196 int sd_bus_get_tid(sd_bus *bus, pid_t *tid);
197 int sd_bus_get_owner_creds(sd_bus *bus, uint64_t creds_mask, sd_bus_creds **ret);
198
199 int sd_bus_send(sd_bus *bus, sd_bus_message *m, uint64_t *cookie);
200 int sd_bus_send_to(sd_bus *bus, sd_bus_message *m, const char *destination, uint64_t *cookie);
201 int sd_bus_call(sd_bus *bus, sd_bus_message *m, uint64_t usec, sd_bus_error *ret_error, sd_bus_message **reply);
202 int sd_bus_call_async(sd_bus *bus, sd_bus_slot **slot, sd_bus_message *m, sd_bus_message_handler_t callback, void *userdata, uint64_t usec);
203
204 int sd_bus_get_fd(sd_bus *bus);
205 int sd_bus_get_events(sd_bus *bus);
206 int sd_bus_get_timeout(sd_bus *bus, uint64_t *timeout_usec);
207 int sd_bus_process(sd_bus *bus, sd_bus_message **r);
208 int sd_bus_process_priority(sd_bus *bus, int64_t max_priority, sd_bus_message **r) _sd_deprecated_;
209 int sd_bus_wait(sd_bus *bus, uint64_t timeout_usec);
210 int sd_bus_flush(sd_bus *bus);
211 int sd_bus_enqueue_for_read(sd_bus *bus, sd_bus_message *m);
212
213 sd_bus_slot* sd_bus_get_current_slot(sd_bus *bus);
214 sd_bus_message* sd_bus_get_current_message(sd_bus *bus);
215 sd_bus_message_handler_t sd_bus_get_current_handler(sd_bus *bus);
216 void* sd_bus_get_current_userdata(sd_bus *bus);
217
218 int sd_bus_attach_event(sd_bus *bus, sd_event *e, int priority);
219 int sd_bus_detach_event(sd_bus *bus);
220 sd_event* sd_bus_get_event(sd_bus *bus);
221
222 int sd_bus_get_n_queued_read(sd_bus *bus, uint64_t *ret);
223 int sd_bus_get_n_queued_write(sd_bus *bus, uint64_t *ret);
224
225 int sd_bus_set_method_call_timeout(sd_bus *bus, uint64_t usec);
226 int sd_bus_get_method_call_timeout(sd_bus *bus, uint64_t *ret);
227
228 int sd_bus_add_filter(sd_bus *bus, sd_bus_slot **slot, sd_bus_message_handler_t callback, void *userdata);
229 int sd_bus_add_match(sd_bus *bus, sd_bus_slot **slot, const char *match, sd_bus_message_handler_t callback, void *userdata);
230 int sd_bus_add_match_async(sd_bus *bus, sd_bus_slot **slot, const char *match, sd_bus_message_handler_t callback, sd_bus_message_handler_t install_callback, void *userdata);
231 int sd_bus_add_object(sd_bus *bus, sd_bus_slot **slot, const char *path, sd_bus_message_handler_t callback, void *userdata);
232 int sd_bus_add_fallback(sd_bus *bus, sd_bus_slot **slot, const char *prefix, sd_bus_message_handler_t callback, void *userdata);
233 int sd_bus_add_object_vtable(sd_bus *bus, sd_bus_slot **slot, const char *path, const char *interface, const sd_bus_vtable *vtable, void *userdata);
234 int sd_bus_add_fallback_vtable(sd_bus *bus, sd_bus_slot **slot, const char *prefix, const char *interface, const sd_bus_vtable *vtable, sd_bus_object_find_t find, void *userdata);
235 int sd_bus_add_node_enumerator(sd_bus *bus, sd_bus_slot **slot, const char *path, sd_bus_node_enumerator_t callback, void *userdata);
236 int sd_bus_add_object_manager(sd_bus *bus, sd_bus_slot **slot, const char *path);
237
238 /* Slot object */
239
240 sd_bus_slot* sd_bus_slot_ref(sd_bus_slot *slot);
241 sd_bus_slot* sd_bus_slot_unref(sd_bus_slot *slot);
242
243 sd_bus* sd_bus_slot_get_bus(sd_bus_slot *slot);
244 void* sd_bus_slot_get_userdata(sd_bus_slot *slot);
245 void* sd_bus_slot_set_userdata(sd_bus_slot *slot, void *userdata);
246 int sd_bus_slot_set_description(sd_bus_slot *slot, const char *description);
247 int sd_bus_slot_get_description(sd_bus_slot *slot, const char **description);
248 int sd_bus_slot_get_floating(sd_bus_slot *slot);
249 int sd_bus_slot_set_floating(sd_bus_slot *slot, int b);
250 int sd_bus_slot_set_destroy_callback(sd_bus_slot *s, sd_bus_destroy_t callback);
251 int sd_bus_slot_get_destroy_callback(sd_bus_slot *s, sd_bus_destroy_t *callback);
252
253 sd_bus_message* sd_bus_slot_get_current_message(sd_bus_slot *slot);
254 sd_bus_message_handler_t sd_bus_slot_get_current_handler(sd_bus_slot *slot);
255 void* sd_bus_slot_get_current_userdata(sd_bus_slot *slot);
256
257 /* Message object */
258
259 int sd_bus_message_new(sd_bus *bus, sd_bus_message **m, uint8_t type);
260 int sd_bus_message_new_signal(sd_bus *bus, sd_bus_message **m, const char *path, const char *interface, const char *member);
261 int sd_bus_message_new_method_call(sd_bus *bus, sd_bus_message **m, const char *destination, const char *path, const char *interface, const char *member);
262 int sd_bus_message_new_method_return(sd_bus_message *call, sd_bus_message **m);
263 int sd_bus_message_new_method_error(sd_bus_message *call, sd_bus_message **m, const sd_bus_error *e);
264 int sd_bus_message_new_method_errorf(sd_bus_message *call, sd_bus_message **m, const char *name, const char *format, ...) _sd_printf_(4, 5);
265 int sd_bus_message_new_method_errno(sd_bus_message *call, sd_bus_message **m, int error, const sd_bus_error *e);
266 int sd_bus_message_new_method_errnof(sd_bus_message *call, sd_bus_message **m, int error, const char *format, ...) _sd_printf_(4, 5);
267
268 sd_bus_message* sd_bus_message_ref(sd_bus_message *m);
269 sd_bus_message* sd_bus_message_unref(sd_bus_message *m);
270
271 int sd_bus_message_seal(sd_bus_message *m, uint64_t cookie, uint64_t timeout_usec);
272
273 int sd_bus_message_get_type(sd_bus_message *m, uint8_t *type);
274 int sd_bus_message_get_cookie(sd_bus_message *m, uint64_t *cookie);
275 int sd_bus_message_get_reply_cookie(sd_bus_message *m, uint64_t *cookie);
276 int sd_bus_message_get_priority(sd_bus_message *m, int64_t *priority) _sd_deprecated_;
277
278 int sd_bus_message_get_expect_reply(sd_bus_message *m);
279 int sd_bus_message_get_auto_start(sd_bus_message *m);
280 int sd_bus_message_get_allow_interactive_authorization(sd_bus_message *m);
281
282 const char* sd_bus_message_get_signature(sd_bus_message *m, int complete);
283 const char* sd_bus_message_get_path(sd_bus_message *m);
284 const char* sd_bus_message_get_interface(sd_bus_message *m);
285 const char* sd_bus_message_get_member(sd_bus_message *m);
286 const char* sd_bus_message_get_destination(sd_bus_message *m);
287 const char* sd_bus_message_get_sender(sd_bus_message *m);
288 const sd_bus_error* sd_bus_message_get_error(sd_bus_message *m);
289 int sd_bus_message_get_errno(sd_bus_message *m);
290
291 int sd_bus_message_get_monotonic_usec(sd_bus_message *m, uint64_t *usec);
292 int sd_bus_message_get_realtime_usec(sd_bus_message *m, uint64_t *usec);
293 int sd_bus_message_get_seqnum(sd_bus_message *m, uint64_t *seqnum);
294
295 sd_bus* sd_bus_message_get_bus(sd_bus_message *m);
296 sd_bus_creds* sd_bus_message_get_creds(sd_bus_message *m); /* do not unref the result */
297
298 int sd_bus_message_is_signal(sd_bus_message *m, const char *interface, const char *member);
299 int sd_bus_message_is_method_call(sd_bus_message *m, const char *interface, const char *member);
300 int sd_bus_message_is_method_error(sd_bus_message *m, const char *name);
301 int sd_bus_message_is_empty(sd_bus_message *m);
302 int sd_bus_message_has_signature(sd_bus_message *m, const char *signature);
303
304 int sd_bus_message_set_expect_reply(sd_bus_message *m, int b);
305 int sd_bus_message_set_auto_start(sd_bus_message *m, int b);
306 int sd_bus_message_set_allow_interactive_authorization(sd_bus_message *m, int b);
307
308 int sd_bus_message_set_destination(sd_bus_message *m, const char *destination);
309 int sd_bus_message_set_sender(sd_bus_message *m, const char *sender);
310 int sd_bus_message_set_priority(sd_bus_message *m, int64_t priority) _sd_deprecated_;
311
312 int sd_bus_message_append(sd_bus_message *m, const char *types, ...);
313 int sd_bus_message_appendv(sd_bus_message *m, const char *types, va_list ap);
314 int sd_bus_message_append_basic(sd_bus_message *m, char type, const void *p);
315 int sd_bus_message_append_array(sd_bus_message *m, char type, const void *ptr, size_t size);
316 int sd_bus_message_append_array_space(sd_bus_message *m, char type, size_t size, void **ptr);
317 int sd_bus_message_append_array_iovec(sd_bus_message *m, char type, const struct iovec *iov, unsigned n);
318 int sd_bus_message_append_array_memfd(sd_bus_message *m, char type, int memfd, uint64_t offset, uint64_t size);
319 int sd_bus_message_append_string_space(sd_bus_message *m, size_t size, char **s);
320 int sd_bus_message_append_string_iovec(sd_bus_message *m, const struct iovec *iov, unsigned n);
321 int sd_bus_message_append_string_memfd(sd_bus_message *m, int memfd, uint64_t offset, uint64_t size);
322 int sd_bus_message_append_strv(sd_bus_message *m, char **l);
323 int sd_bus_message_open_container(sd_bus_message *m, char type, const char *contents);
324 int sd_bus_message_close_container(sd_bus_message *m);
325 int sd_bus_message_copy(sd_bus_message *m, sd_bus_message *source, int all);
326
327 int sd_bus_message_read(sd_bus_message *m, const char *types, ...);
328 int sd_bus_message_readv(sd_bus_message *m, const char *types, va_list ap);
329 int sd_bus_message_read_basic(sd_bus_message *m, char type, void *p);
330 int sd_bus_message_read_array(sd_bus_message *m, char type, const void **ptr, size_t *size);
331 int sd_bus_message_read_strv(sd_bus_message *m, char ***l); /* free the result! */
332 int sd_bus_message_skip(sd_bus_message *m, const char *types);
333 int sd_bus_message_enter_container(sd_bus_message *m, char type, const char *contents);
334 int sd_bus_message_exit_container(sd_bus_message *m);
335 int sd_bus_message_peek_type(sd_bus_message *m, char *type, const char **contents);
336 int sd_bus_message_verify_type(sd_bus_message *m, char type, const char *contents);
337 int sd_bus_message_at_end(sd_bus_message *m, int complete);
338 int sd_bus_message_rewind(sd_bus_message *m, int complete);
339 int sd_bus_message_sensitive(sd_bus_message *m);
340
341 int sd_bus_message_dump(sd_bus_message *m, FILE *f, uint64_t flags);
342
343 /* Bus management */
344
345 int sd_bus_get_unique_name(sd_bus *bus, const char **unique);
346 int sd_bus_request_name(sd_bus *bus, const char *name, uint64_t flags);
347 int sd_bus_request_name_async(sd_bus *bus, sd_bus_slot **ret_slot, const char *name, uint64_t flags, sd_bus_message_handler_t callback, void *userdata);
348 int sd_bus_release_name(sd_bus *bus, const char *name);
349 int sd_bus_release_name_async(sd_bus *bus, sd_bus_slot **ret_slot, const char *name, sd_bus_message_handler_t callback, void *userdata);
350 int sd_bus_list_names(sd_bus *bus, char ***acquired, char ***activatable); /* free the results */
351 int sd_bus_get_name_creds(sd_bus *bus, const char *name, uint64_t mask, sd_bus_creds **creds); /* unref the result! */
352 int sd_bus_get_name_machine_id(sd_bus *bus, const char *name, sd_id128_t *machine);
353
354 /* Convenience calls */
355
356 int sd_bus_call_methodv(sd_bus *bus, const char *destination, const char *path, const char *interface, const char *member, sd_bus_error *ret_error, sd_bus_message **reply, const char *types, va_list ap);
357 int sd_bus_call_method(sd_bus *bus, const char *destination, const char *path, const char *interface, const char *member, sd_bus_error *ret_error, sd_bus_message **reply, const char *types, ...);
358 int sd_bus_call_method_asyncv(sd_bus *bus, sd_bus_slot **slot, const char *destination, const char *path, const char *interface, const char *member, sd_bus_message_handler_t callback, void *userdata, const char *types, va_list ap);
359 int sd_bus_call_method_async(sd_bus *bus, sd_bus_slot **slot, const char *destination, const char *path, const char *interface, const char *member, sd_bus_message_handler_t callback, void *userdata, const char *types, ...);
360 int sd_bus_get_property(sd_bus *bus, const char *destination, const char *path, const char *interface, const char *member, sd_bus_error *ret_error, sd_bus_message **reply, const char *type);
361 int sd_bus_get_property_trivial(sd_bus *bus, const char *destination, const char *path, const char *interface, const char *member, sd_bus_error *ret_error, char type, void *ret_ptr);
362 int sd_bus_get_property_string(sd_bus *bus, const char *destination, const char *path, const char *interface, const char *member, sd_bus_error *ret_error, char **ret); /* free the result! */
363 int sd_bus_get_property_strv(sd_bus *bus, const char *destination, const char *path, const char *interface, const char *member, sd_bus_error *ret_error, char ***ret); /* free the result! */
364 int sd_bus_set_propertyv(sd_bus *bus, const char *destination, const char *path, const char *interface, const char *member, sd_bus_error *ret_error, const char *type, va_list ap);
365 int sd_bus_set_property(sd_bus *bus, const char *destination, const char *path, const char *interface, const char *member, sd_bus_error *ret_error, const char *type, ...);
366
367 int sd_bus_reply_method_returnv(sd_bus_message *call, const char *types, va_list ap);
368 int sd_bus_reply_method_return(sd_bus_message *call, const char *types, ...);
369 int sd_bus_reply_method_error(sd_bus_message *call, const sd_bus_error *e);
370 int sd_bus_reply_method_errorfv(sd_bus_message *call, const char *name, const char *format, va_list ap) _sd_printf_(3, 0);
371 int sd_bus_reply_method_errorf(sd_bus_message *call, const char *name, const char *format, ...) _sd_printf_(3, 4);
372 int sd_bus_reply_method_errno(sd_bus_message *call, int error, const sd_bus_error *e);
373 int sd_bus_reply_method_errnofv(sd_bus_message *call, int error, const char *format, va_list ap) _sd_printf_(3, 0);
374 int sd_bus_reply_method_errnof(sd_bus_message *call, int error, const char *format, ...) _sd_printf_(3, 4);
375
376 int sd_bus_emit_signalv(sd_bus *bus, const char *path, const char *interface, const char *member, const char *types, va_list ap);
377 int sd_bus_emit_signal(sd_bus *bus, const char *path, const char *interface, const char *member, const char *types, ...);
378
379 int sd_bus_emit_properties_changed_strv(sd_bus *bus, const char *path, const char *interface, char **names);
380 int sd_bus_emit_properties_changed(sd_bus *bus, const char *path, const char *interface, const char *name, ...) _sd_sentinel_;
381
382 int sd_bus_emit_object_added(sd_bus *bus, const char *path);
383 int sd_bus_emit_object_removed(sd_bus *bus, const char *path);
384 int sd_bus_emit_interfaces_added_strv(sd_bus *bus, const char *path, char **interfaces);
385 int sd_bus_emit_interfaces_added(sd_bus *bus, const char *path, const char *interface, ...) _sd_sentinel_;
386 int sd_bus_emit_interfaces_removed_strv(sd_bus *bus, const char *path, char **interfaces);
387 int sd_bus_emit_interfaces_removed(sd_bus *bus, const char *path, const char *interface, ...) _sd_sentinel_;
388
389 int sd_bus_query_sender_creds(sd_bus_message *m, uint64_t mask, sd_bus_creds **creds);
390 int sd_bus_query_sender_privilege(sd_bus_message *m, int capability);
391
392 int sd_bus_match_signal(sd_bus *bus, sd_bus_slot **ret, const char *sender, const char *path, const char *interface, const char *member, sd_bus_message_handler_t callback, void *userdata);
393 int sd_bus_match_signal_async(sd_bus *bus, sd_bus_slot **ret, const char *sender, const char *path, const char *interface, const char *member, sd_bus_message_handler_t match_callback, sd_bus_message_handler_t add_callback, void *userdata);
394
395 /* Credential handling */
396
397 int sd_bus_creds_new_from_pid(sd_bus_creds **ret, pid_t pid, uint64_t creds_mask);
398 sd_bus_creds* sd_bus_creds_ref(sd_bus_creds *c);
399 sd_bus_creds* sd_bus_creds_unref(sd_bus_creds *c);
400 uint64_t sd_bus_creds_get_mask(const sd_bus_creds *c);
401 uint64_t sd_bus_creds_get_augmented_mask(const sd_bus_creds *c);
402
403 int sd_bus_creds_get_pid(sd_bus_creds *c, pid_t *pid);
404 int sd_bus_creds_get_ppid(sd_bus_creds *c, pid_t *ppid);
405 int sd_bus_creds_get_tid(sd_bus_creds *c, pid_t *tid);
406 int sd_bus_creds_get_uid(sd_bus_creds *c, uid_t *uid);
407 int sd_bus_creds_get_euid(sd_bus_creds *c, uid_t *euid);
408 int sd_bus_creds_get_suid(sd_bus_creds *c, uid_t *suid);
409 int sd_bus_creds_get_fsuid(sd_bus_creds *c, uid_t *fsuid);
410 int sd_bus_creds_get_gid(sd_bus_creds *c, gid_t *gid);
411 int sd_bus_creds_get_egid(sd_bus_creds *c, gid_t *egid);
412 int sd_bus_creds_get_sgid(sd_bus_creds *c, gid_t *sgid);
413 int sd_bus_creds_get_fsgid(sd_bus_creds *c, gid_t *fsgid);
414 int sd_bus_creds_get_supplementary_gids(sd_bus_creds *c, const gid_t **gids);
415 int sd_bus_creds_get_comm(sd_bus_creds *c, const char **comm);
416 int sd_bus_creds_get_tid_comm(sd_bus_creds *c, const char **comm);
417 int sd_bus_creds_get_exe(sd_bus_creds *c, const char **exe);
418 int sd_bus_creds_get_cmdline(sd_bus_creds *c, char ***cmdline);
419 int sd_bus_creds_get_cgroup(sd_bus_creds *c, const char **cgroup);
420 int sd_bus_creds_get_unit(sd_bus_creds *c, const char **unit);
421 int sd_bus_creds_get_slice(sd_bus_creds *c, const char **slice);
422 int sd_bus_creds_get_user_unit(sd_bus_creds *c, const char **unit);
423 int sd_bus_creds_get_user_slice(sd_bus_creds *c, const char **slice);
424 int sd_bus_creds_get_session(sd_bus_creds *c, const char **session);
425 int sd_bus_creds_get_owner_uid(sd_bus_creds *c, uid_t *uid);
426 int sd_bus_creds_has_effective_cap(sd_bus_creds *c, int capability);
427 int sd_bus_creds_has_permitted_cap(sd_bus_creds *c, int capability);
428 int sd_bus_creds_has_inheritable_cap(sd_bus_creds *c, int capability);
429 int sd_bus_creds_has_bounding_cap(sd_bus_creds *c, int capability);
430 int sd_bus_creds_get_selinux_context(sd_bus_creds *c, const char **context);
431 int sd_bus_creds_get_audit_session_id(sd_bus_creds *c, uint32_t *sessionid);
432 int sd_bus_creds_get_audit_login_uid(sd_bus_creds *c, uid_t *loginuid);
433 int sd_bus_creds_get_tty(sd_bus_creds *c, const char **tty);
434 int sd_bus_creds_get_unique_name(sd_bus_creds *c, const char **name);
435 int sd_bus_creds_get_well_known_names(sd_bus_creds *c, char ***names);
436 int sd_bus_creds_get_description(sd_bus_creds *c, const char **name);
437
438 /* Error structures */
439
440 #define SD_BUS_ERROR_MAKE_CONST(name, message) ((const sd_bus_error) {(name), (message), 0})
441 #define SD_BUS_ERROR_NULL SD_BUS_ERROR_MAKE_CONST(NULL, NULL)
442
443 void sd_bus_error_free(sd_bus_error *e);
444 int sd_bus_error_set(sd_bus_error *e, const char *name, const char *message);
445 int sd_bus_error_setf(sd_bus_error *e, const char *name, const char *format, ...) _sd_printf_(3, 4);
446 int sd_bus_error_set_const(sd_bus_error *e, const char *name, const char *message);
447 int sd_bus_error_set_errno(sd_bus_error *e, int error);
448 int sd_bus_error_set_errnof(sd_bus_error *e, int error, const char *format, ...) _sd_printf_(3, 4);
449 int sd_bus_error_set_errnofv(sd_bus_error *e, int error, const char *format, va_list ap) _sd_printf_(3,0);
450 int sd_bus_error_get_errno(const sd_bus_error *e);
451 int sd_bus_error_copy(sd_bus_error *dest, const sd_bus_error *e);
452 int sd_bus_error_move(sd_bus_error *dest, sd_bus_error *e);
453 int sd_bus_error_is_set(const sd_bus_error *e);
454 int sd_bus_error_has_name(const sd_bus_error *e, const char *name);
455 int sd_bus_error_has_names_sentinel(const sd_bus_error *e, ...) _sd_sentinel_;
456 #define sd_bus_error_has_names(e, ...) sd_bus_error_has_names_sentinel(e, __VA_ARGS__, NULL)
457
458 #define SD_BUS_ERROR_MAP(_name, _code) \
459 { \
460 .name = _name, \
461 .code = _code, \
462 }
463 #define SD_BUS_ERROR_MAP_END \
464 { \
465 .name = NULL, \
466 .code = - 'x', \
467 }
468
469 int sd_bus_error_add_map(const sd_bus_error_map *map);
470
471 /* Auxiliary macros */
472
473 #define SD_BUS_MESSAGE_APPEND_ID128(x) 16, \
474 (x).bytes[0], (x).bytes[1], (x).bytes[2], (x).bytes[3], \
475 (x).bytes[4], (x).bytes[5], (x).bytes[6], (x).bytes[7], \
476 (x).bytes[8], (x).bytes[9], (x).bytes[10], (x).bytes[11], \
477 (x).bytes[12], (x).bytes[13], (x).bytes[14], (x).bytes[15]
478
479 #define SD_BUS_MESSAGE_READ_ID128(x) 16, \
480 &(x).bytes[0], &(x).bytes[1], &(x).bytes[2], &(x).bytes[3], \
481 &(x).bytes[4], &(x).bytes[5], &(x).bytes[6], &(x).bytes[7], \
482 &(x).bytes[8], &(x).bytes[9], &(x).bytes[10], &(x).bytes[11], \
483 &(x).bytes[12], &(x).bytes[13], &(x).bytes[14], &(x).bytes[15]
484
485 /* Label escaping */
486
487 int sd_bus_path_encode(const char *prefix, const char *external_id, char **ret_path);
488 int sd_bus_path_encode_many(char **out, const char *path_template, ...);
489 int sd_bus_path_decode(const char *path, const char *prefix, char **ret_external_id);
490 int sd_bus_path_decode_many(const char *path, const char *path_template, ...);
491
492 /* Tracking peers */
493
494 int sd_bus_track_new(sd_bus *bus, sd_bus_track **track, sd_bus_track_handler_t handler, void *userdata);
495 sd_bus_track* sd_bus_track_ref(sd_bus_track *track);
496 sd_bus_track* sd_bus_track_unref(sd_bus_track *track);
497
498 sd_bus* sd_bus_track_get_bus(sd_bus_track *track);
499 void* sd_bus_track_get_userdata(sd_bus_track *track);
500 void* sd_bus_track_set_userdata(sd_bus_track *track, void *userdata);
501
502 int sd_bus_track_add_sender(sd_bus_track *track, sd_bus_message *m);
503 int sd_bus_track_remove_sender(sd_bus_track *track, sd_bus_message *m);
504 int sd_bus_track_add_name(sd_bus_track *track, const char *name);
505 int sd_bus_track_remove_name(sd_bus_track *track, const char *name);
506
507 int sd_bus_track_set_recursive(sd_bus_track *track, int b);
508 int sd_bus_track_get_recursive(sd_bus_track *track);
509
510 unsigned sd_bus_track_count(sd_bus_track *track);
511 int sd_bus_track_count_sender(sd_bus_track *track, sd_bus_message *m);
512 int sd_bus_track_count_name(sd_bus_track *track, const char *name);
513
514 const char* sd_bus_track_contains(sd_bus_track *track, const char *name);
515 const char* sd_bus_track_first(sd_bus_track *track);
516 const char* sd_bus_track_next(sd_bus_track *track);
517
518 int sd_bus_track_set_destroy_callback(sd_bus_track *s, sd_bus_destroy_t callback);
519 int sd_bus_track_get_destroy_callback(sd_bus_track *s, sd_bus_destroy_t *ret);
520
521 /* Define helpers so that __attribute__((cleanup(sd_bus_unrefp))) and similar may be used. */
522 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus, sd_bus_unref);
523 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus, sd_bus_close_unref);
524 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus, sd_bus_flush_close_unref);
525 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus_slot, sd_bus_slot_unref);
526 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus_message, sd_bus_message_unref);
527 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus_creds, sd_bus_creds_unref);
528 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus_track, sd_bus_track_unref);
529
530 _SD_END_DECLARATIONS;
531
532 #endif