]> git.ipfire.org Git - thirdparty/systemd.git/blob - src/systemd/sd-bus.h
a89e9842d8a6ff9fb7a35c0ff50d4623d4a31a1d
[thirdparty/systemd.git] / src / systemd / sd-bus.h
1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
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 <https://www.gnu.org/licenses/>.
18 ***/
19
20 #include <stdio.h>
21 #include <sys/uio.h>
22
23 #include "_sd-common.h"
24 #include "sd-bus-protocol.h"
25 #include "sd-bus-vtable.h"
26 #include "sd-event.h"
27 #include "sd-id128.h"
28 #include "sd-json.h"
29
30 _SD_BEGIN_DECLARATIONS;
31
32 /* Naming */
33
34 int sd_bus_interface_name_is_valid(const char *p);
35 int sd_bus_service_name_is_valid(const char *p);
36 int sd_bus_member_name_is_valid(const char *p);
37 int sd_bus_object_path_is_valid(const char *p);
38
39 /* Connections */
40
41 int sd_bus_default(sd_bus **ret);
42 int sd_bus_default_user(sd_bus **ret);
43 int sd_bus_default_system(sd_bus **ret);
44
45 int sd_bus_open(sd_bus **ret);
46 int sd_bus_open_with_description(sd_bus **ret, const char *description);
47 int sd_bus_open_user(sd_bus **ret);
48 int sd_bus_open_user_with_description(sd_bus **ret, const char *description);
49 int sd_bus_open_user_machine(sd_bus **ret, const char *machine);
50 int sd_bus_open_system(sd_bus **ret);
51 int sd_bus_open_system_with_description(sd_bus **ret, const char *description);
52 int sd_bus_open_system_remote(sd_bus **ret, const char *host);
53 int sd_bus_open_system_machine(sd_bus **ret, const char *machine);
54
55 int sd_bus_new(sd_bus **ret);
56
57 int sd_bus_set_address(sd_bus *bus, const char *address);
58 int sd_bus_set_fd(sd_bus *bus, int input_fd, int output_fd);
59 int sd_bus_set_exec(sd_bus *bus, const char *path, char *const *argv);
60 int sd_bus_get_address(sd_bus *bus, const char **address);
61 int sd_bus_set_bus_client(sd_bus *bus, int b);
62 int sd_bus_is_bus_client(sd_bus *bus);
63 int sd_bus_set_server(sd_bus *bus, int b, sd_id128_t bus_id);
64 int sd_bus_is_server(sd_bus *bus);
65 int sd_bus_set_anonymous(sd_bus *bus, int b);
66 int sd_bus_is_anonymous(sd_bus *bus);
67 int sd_bus_set_trusted(sd_bus *bus, int b);
68 int sd_bus_is_trusted(sd_bus *bus);
69 int sd_bus_set_monitor(sd_bus *bus, int b);
70 int sd_bus_is_monitor(sd_bus *bus);
71 int sd_bus_set_description(sd_bus *bus, const char *description);
72 int sd_bus_get_description(sd_bus *bus, const char **ret);
73 int sd_bus_negotiate_creds(sd_bus *bus, int b, uint64_t creds_mask);
74 int sd_bus_negotiate_timestamp(sd_bus *bus, int b);
75 int sd_bus_negotiate_fds(sd_bus *bus, int b);
76 int sd_bus_can_send(sd_bus *bus, char type);
77 int sd_bus_get_creds_mask(sd_bus *bus, uint64_t *ret);
78 int sd_bus_set_allow_interactive_authorization(sd_bus *bus, int b);
79 int sd_bus_get_allow_interactive_authorization(sd_bus *bus);
80 int sd_bus_set_exit_on_disconnect(sd_bus *bus, int b);
81 int sd_bus_get_exit_on_disconnect(sd_bus *bus);
82 int sd_bus_set_close_on_exit(sd_bus *bus, int b);
83 int sd_bus_get_close_on_exit(sd_bus *bus);
84 int sd_bus_set_watch_bind(sd_bus *bus, int b);
85 int sd_bus_get_watch_bind(sd_bus *bus);
86 int sd_bus_set_connected_signal(sd_bus *bus, int b);
87 int sd_bus_get_connected_signal(sd_bus *bus);
88 int sd_bus_set_sender(sd_bus *bus, const char *sender);
89 int sd_bus_get_sender(sd_bus *bus, const char **ret);
90
91 int sd_bus_start(sd_bus *bus);
92
93 int sd_bus_try_close(sd_bus *bus) _sd_deprecated_;
94 void sd_bus_close(sd_bus *bus);
95
96 sd_bus* sd_bus_ref(sd_bus *bus);
97 sd_bus* sd_bus_unref(sd_bus *bus);
98 sd_bus* sd_bus_close_unref(sd_bus *bus);
99 sd_bus* sd_bus_flush_close_unref(sd_bus *bus);
100
101 void sd_bus_default_flush_close(void);
102
103 int sd_bus_is_open(sd_bus *bus);
104 int sd_bus_is_ready(sd_bus *bus);
105
106 int sd_bus_get_bus_id(sd_bus *bus, sd_id128_t *ret);
107 int sd_bus_get_scope(sd_bus *bus, const char **ret);
108 int sd_bus_get_tid(sd_bus *bus, pid_t *ret);
109 int sd_bus_get_owner_creds(sd_bus *bus, uint64_t creds_mask, sd_bus_creds **ret);
110
111 int sd_bus_send(sd_bus *bus, sd_bus_message *m, uint64_t *ret_cookie);
112 int sd_bus_send_to(sd_bus *bus, sd_bus_message *m, const char *destination, uint64_t *ret_cookie);
113 int sd_bus_call(sd_bus *bus, sd_bus_message *m, uint64_t usec, sd_bus_error *reterr_error, sd_bus_message **ret_reply);
114 int sd_bus_call_async(sd_bus *bus, sd_bus_slot **ret_slot, sd_bus_message *m, sd_bus_message_handler_t callback, void *userdata, uint64_t usec);
115
116 int sd_bus_get_fd(sd_bus *bus);
117 int sd_bus_get_events(sd_bus *bus);
118 int sd_bus_get_timeout(sd_bus *bus, uint64_t *ret);
119 int sd_bus_process(sd_bus *bus, sd_bus_message **ret);
120 int sd_bus_process_priority(sd_bus *bus, int64_t max_priority, sd_bus_message **ret) _sd_deprecated_;
121 int sd_bus_wait(sd_bus *bus, uint64_t timeout_usec);
122 int sd_bus_flush(sd_bus *bus);
123 int sd_bus_enqueue_for_read(sd_bus *bus, sd_bus_message *m);
124
125 sd_bus_slot* sd_bus_get_current_slot(sd_bus *bus);
126 sd_bus_message* sd_bus_get_current_message(sd_bus *bus);
127 sd_bus_message_handler_t sd_bus_get_current_handler(sd_bus *bus);
128 void* sd_bus_get_current_userdata(sd_bus *bus);
129
130 int sd_bus_attach_event(sd_bus *bus, sd_event *e, int priority);
131 int sd_bus_detach_event(sd_bus *bus);
132 sd_event* sd_bus_get_event(sd_bus *bus);
133
134 int sd_bus_get_n_queued_read(sd_bus *bus, uint64_t *ret);
135 int sd_bus_get_n_queued_write(sd_bus *bus, uint64_t *ret);
136
137 int sd_bus_set_method_call_timeout(sd_bus *bus, uint64_t usec);
138 int sd_bus_get_method_call_timeout(sd_bus *bus, uint64_t *ret);
139
140 int sd_bus_add_filter(sd_bus *bus, sd_bus_slot **ret_slot, sd_bus_message_handler_t callback, void *userdata);
141 int sd_bus_add_match(sd_bus *bus, sd_bus_slot **ret_slot, const char *match, sd_bus_message_handler_t callback, void *userdata);
142 int sd_bus_add_match_async(sd_bus *bus, sd_bus_slot **ret_slot, const char *match, sd_bus_message_handler_t callback, sd_bus_message_handler_t install_callback, void *userdata);
143 int sd_bus_add_object(sd_bus *bus, sd_bus_slot **ret_slot, const char *path, sd_bus_message_handler_t callback, void *userdata);
144 int sd_bus_add_fallback(sd_bus *bus, sd_bus_slot **ret_slot, const char *prefix, sd_bus_message_handler_t callback, void *userdata);
145 int sd_bus_add_object_vtable(sd_bus *bus, sd_bus_slot **ret_slot, const char *path, const char *interface, const sd_bus_vtable *vtable, void *userdata);
146 int sd_bus_add_fallback_vtable(sd_bus *bus, sd_bus_slot **ret_slot, const char *prefix, const char *interface, const sd_bus_vtable *vtable, sd_bus_object_find_t find, void *userdata);
147 int sd_bus_add_node_enumerator(sd_bus *bus, sd_bus_slot **ret_slot, const char *path, sd_bus_node_enumerator_t callback, void *userdata);
148 int sd_bus_add_object_manager(sd_bus *bus, sd_bus_slot **ret_slot, const char *path);
149
150 int sd_bus_pending_method_calls(sd_bus *bus);
151
152 /* Slot object */
153
154 sd_bus_slot* sd_bus_slot_ref(sd_bus_slot *slot);
155 sd_bus_slot* sd_bus_slot_unref(sd_bus_slot *slot);
156
157 sd_bus* sd_bus_slot_get_bus(sd_bus_slot *slot);
158 void* sd_bus_slot_get_userdata(sd_bus_slot *slot);
159 void* sd_bus_slot_set_userdata(sd_bus_slot *slot, void *userdata);
160 int sd_bus_slot_set_description(sd_bus_slot *slot, const char *description);
161 int sd_bus_slot_get_description(sd_bus_slot *slot, const char **ret);
162 int sd_bus_slot_get_floating(sd_bus_slot *slot);
163 int sd_bus_slot_set_floating(sd_bus_slot *slot, int b);
164 int sd_bus_slot_set_destroy_callback(sd_bus_slot *s, sd_bus_destroy_t callback);
165 int sd_bus_slot_get_destroy_callback(sd_bus_slot *s, sd_bus_destroy_t *ret);
166
167 sd_bus_message* sd_bus_slot_get_current_message(sd_bus_slot *slot);
168 sd_bus_message_handler_t sd_bus_slot_get_current_handler(sd_bus_slot *slot);
169 void* sd_bus_slot_get_current_userdata(sd_bus_slot *slot);
170
171 /* Message object */
172
173 int sd_bus_message_new(sd_bus *bus, sd_bus_message **ret, uint8_t type);
174 int sd_bus_message_new_signal(sd_bus *bus, sd_bus_message **ret, const char *path, const char *interface, const char *member);
175 int sd_bus_message_new_signal_to(sd_bus *bus, sd_bus_message **ret, const char *destination, const char *path, const char *interface, const char *member);
176 int sd_bus_message_new_method_call(sd_bus *bus, sd_bus_message **ret, const char *destination, const char *path, const char *interface, const char *member);
177 int sd_bus_message_new_method_return(sd_bus_message *call, sd_bus_message **ret);
178 int sd_bus_message_new_method_error(sd_bus_message *call, sd_bus_message **ret, const sd_bus_error *e);
179 int sd_bus_message_new_method_errorf(sd_bus_message *call, sd_bus_message **ret, const char *name, const char *format, ...) _sd_printf_(4, 5);
180 int sd_bus_message_new_method_errno(sd_bus_message *call, sd_bus_message **ret, int error, const sd_bus_error *e);
181 int sd_bus_message_new_method_errnof(sd_bus_message *call, sd_bus_message **ret, int error, const char *format, ...) _sd_printf_(4, 5);
182
183 sd_bus_message* sd_bus_message_ref(sd_bus_message *m);
184 sd_bus_message* sd_bus_message_unref(sd_bus_message *m);
185
186 int sd_bus_message_seal(sd_bus_message *m, uint64_t cookie, uint64_t timeout_usec);
187
188 int sd_bus_message_get_type(sd_bus_message *m, uint8_t *ret);
189 int sd_bus_message_get_cookie(sd_bus_message *m, uint64_t *ret);
190 int sd_bus_message_get_reply_cookie(sd_bus_message *m, uint64_t *ret);
191 int sd_bus_message_get_priority(sd_bus_message *m, int64_t *ret) _sd_deprecated_;
192
193 int sd_bus_message_get_expect_reply(sd_bus_message *m);
194 int sd_bus_message_get_auto_start(sd_bus_message *m);
195 int sd_bus_message_get_allow_interactive_authorization(sd_bus_message *m);
196
197 const char* sd_bus_message_get_signature(sd_bus_message *m, int complete);
198 const char* sd_bus_message_get_path(sd_bus_message *m);
199 const char* sd_bus_message_get_interface(sd_bus_message *m);
200 const char* sd_bus_message_get_member(sd_bus_message *m);
201 const char* sd_bus_message_get_destination(sd_bus_message *m);
202 const char* sd_bus_message_get_sender(sd_bus_message *m);
203 const sd_bus_error* sd_bus_message_get_error(sd_bus_message *m);
204 int sd_bus_message_get_errno(sd_bus_message *m);
205
206 int sd_bus_message_get_monotonic_usec(sd_bus_message *m, uint64_t *ret);
207 int sd_bus_message_get_realtime_usec(sd_bus_message *m, uint64_t *ret);
208 int sd_bus_message_get_seqnum(sd_bus_message *m, uint64_t *ret);
209
210 sd_bus* sd_bus_message_get_bus(sd_bus_message *m);
211 sd_bus_creds* sd_bus_message_get_creds(sd_bus_message *m); /* do not unref the result */
212
213 int sd_bus_message_is_signal(sd_bus_message *m, const char *interface, const char *member);
214 int sd_bus_message_is_method_call(sd_bus_message *m, const char *interface, const char *member);
215 int sd_bus_message_is_method_error(sd_bus_message *m, const char *name);
216 int sd_bus_message_is_empty(sd_bus_message *m);
217 int sd_bus_message_has_signature(sd_bus_message *m, const char *signature);
218
219 int sd_bus_message_set_expect_reply(sd_bus_message *m, int b);
220 int sd_bus_message_set_auto_start(sd_bus_message *m, int b);
221 int sd_bus_message_set_allow_interactive_authorization(sd_bus_message *m, int b);
222
223 int sd_bus_message_set_destination(sd_bus_message *m, const char *destination);
224 int sd_bus_message_set_sender(sd_bus_message *m, const char *sender);
225 int sd_bus_message_set_priority(sd_bus_message *m, int64_t priority) _sd_deprecated_;
226
227 int sd_bus_message_append(sd_bus_message *m, const char *types, ...);
228 int sd_bus_message_appendv(sd_bus_message *m, const char *types, va_list ap);
229 int sd_bus_message_append_basic(sd_bus_message *m, char type, const void *p);
230 int sd_bus_message_append_array(sd_bus_message *m, char type, const void *ptr, size_t size);
231 int sd_bus_message_append_array_space(sd_bus_message *m, char type, size_t size, void **ret);
232 int sd_bus_message_append_array_iovec(sd_bus_message *m, char type, const struct iovec *iov, unsigned n);
233 int sd_bus_message_append_array_memfd(sd_bus_message *m, char type, int memfd, uint64_t offset, uint64_t size);
234 int sd_bus_message_append_string_space(sd_bus_message *m, size_t size, char **ret);
235 int sd_bus_message_append_string_iovec(sd_bus_message *m, const struct iovec *iov, unsigned n);
236 int sd_bus_message_append_string_memfd(sd_bus_message *m, int memfd, uint64_t offset, uint64_t size);
237 int sd_bus_message_append_strv(sd_bus_message *m, char **l);
238 int sd_bus_message_open_container(sd_bus_message *m, char type, const char *contents);
239 int sd_bus_message_close_container(sd_bus_message *m);
240 int sd_bus_message_copy(sd_bus_message *m, sd_bus_message *source, int all);
241
242 int sd_bus_message_read(sd_bus_message *m, const char *types, ...);
243 int sd_bus_message_readv(sd_bus_message *m, const char *types, va_list ap);
244 int sd_bus_message_read_basic(sd_bus_message *m, char type, void *ret);
245 int sd_bus_message_read_array(sd_bus_message *m, char type, const void **ret_ptr, size_t *ret_size);
246 int sd_bus_message_read_strv(sd_bus_message *m, char ***ret); /* free the result! */
247 int sd_bus_message_read_strv_extend(sd_bus_message *m, char ***l);
248 int sd_bus_message_skip(sd_bus_message *m, const char *types);
249 int sd_bus_message_enter_container(sd_bus_message *m, char type, const char *contents);
250 int sd_bus_message_exit_container(sd_bus_message *m);
251 int sd_bus_message_peek_type(sd_bus_message *m, char *ret_type, const char **ret_contents);
252 int sd_bus_message_verify_type(sd_bus_message *m, char type, const char *contents);
253 int sd_bus_message_at_end(sd_bus_message *m, int complete);
254 int sd_bus_message_rewind(sd_bus_message *m, int complete);
255 int sd_bus_message_sensitive(sd_bus_message *m);
256
257 int sd_bus_message_dump(sd_bus_message *m, FILE *f, uint64_t flags);
258 int sd_bus_message_dump_json(sd_bus_message *m, uint64_t flags, sd_json_variant **ret);
259
260 /* Bus management */
261
262 int sd_bus_get_unique_name(sd_bus *bus, const char **unique);
263 int sd_bus_request_name(sd_bus *bus, const char *name, uint64_t flags);
264 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);
265 int sd_bus_release_name(sd_bus *bus, const char *name);
266 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);
267 int sd_bus_list_names(sd_bus *bus, char ***ret_acquired, char ***ret_activatable); /* free the results */
268 int sd_bus_get_name_creds(sd_bus *bus, const char *name, uint64_t mask, sd_bus_creds **ret); /* unref the result! */
269 int sd_bus_get_name_machine_id(sd_bus *bus, const char *name, sd_id128_t *ret);
270
271 /* Convenience calls */
272
273 int sd_bus_message_send(sd_bus_message *m);
274 int sd_bus_call_methodv(sd_bus *bus, const char *destination, const char *path, const char *interface, const char *member, sd_bus_error *reterr_error, sd_bus_message **ret_reply, const char *types, va_list ap);
275 int sd_bus_call_method(sd_bus *bus, const char *destination, const char *path, const char *interface, const char *member, sd_bus_error *reterr_error, sd_bus_message **ret_reply, const char *types, ...);
276 int sd_bus_call_method_asyncv(sd_bus *bus, sd_bus_slot **ret_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);
277 int sd_bus_call_method_async(sd_bus *bus, sd_bus_slot **ret_slot, const char *destination, const char *path, const char *interface, const char *member, sd_bus_message_handler_t callback, void *userdata, const char *types, ...);
278 int sd_bus_get_property(sd_bus *bus, const char *destination, const char *path, const char *interface, const char *member, sd_bus_error *reterr_error, sd_bus_message **ret_reply, const char *type);
279 int sd_bus_get_property_trivial(sd_bus *bus, const char *destination, const char *path, const char *interface, const char *member, sd_bus_error *reterr_error, char type, void *ret);
280 int sd_bus_get_property_string(sd_bus *bus, const char *destination, const char *path, const char *interface, const char *member, sd_bus_error *reterr_error, char **ret); /* free the result! */
281 int sd_bus_get_property_strv(sd_bus *bus, const char *destination, const char *path, const char *interface, const char *member, sd_bus_error *reterr_error, char ***ret); /* free the result! */
282 int sd_bus_set_propertyv(sd_bus *bus, const char *destination, const char *path, const char *interface, const char *member, sd_bus_error *reterr_error, const char *type, va_list ap);
283 int sd_bus_set_property(sd_bus *bus, const char *destination, const char *path, const char *interface, const char *member, sd_bus_error *reterr_error, const char *type, ...);
284
285 int sd_bus_reply_method_returnv(sd_bus_message *call, const char *types, va_list ap);
286 int sd_bus_reply_method_return(sd_bus_message *call, const char *types, ...);
287 int sd_bus_reply_method_error(sd_bus_message *call, const sd_bus_error *e);
288 int sd_bus_reply_method_errorfv(sd_bus_message *call, const char *name, const char *format, va_list ap) _sd_printf_(3, 0);
289 int sd_bus_reply_method_errorf(sd_bus_message *call, const char *name, const char *format, ...) _sd_printf_(3, 4);
290 int sd_bus_reply_method_errno(sd_bus_message *call, int error, const sd_bus_error *e);
291 int sd_bus_reply_method_errnofv(sd_bus_message *call, int error, const char *format, va_list ap) _sd_printf_(3, 0);
292 int sd_bus_reply_method_errnof(sd_bus_message *call, int error, const char *format, ...) _sd_printf_(3, 4);
293
294 int sd_bus_emit_signalv(sd_bus *bus, const char *path, const char *interface, const char *member, const char *types, va_list ap);
295 int sd_bus_emit_signal(sd_bus *bus, const char *path, const char *interface, const char *member, const char *types, ...);
296 int sd_bus_emit_signal_tov(sd_bus *bus, const char *destination, const char *path, const char *interface, const char *member, const char *types, va_list ap);
297 int sd_bus_emit_signal_to(sd_bus *bus, const char *destination, const char *path, const char *interface, const char *member, const char *types, ...);
298
299 int sd_bus_emit_properties_changed_strv(sd_bus *bus, const char *path, const char *interface, char **names);
300 int sd_bus_emit_properties_changed(sd_bus *bus, const char *path, const char *interface, const char *name, ...) _sd_sentinel_;
301
302 int sd_bus_emit_object_added(sd_bus *bus, const char *path);
303 int sd_bus_emit_object_removed(sd_bus *bus, const char *path);
304 int sd_bus_emit_interfaces_added_strv(sd_bus *bus, const char *path, char **interfaces);
305 int sd_bus_emit_interfaces_added(sd_bus *bus, const char *path, const char *interface, ...) _sd_sentinel_;
306 int sd_bus_emit_interfaces_removed_strv(sd_bus *bus, const char *path, char **interfaces);
307 int sd_bus_emit_interfaces_removed(sd_bus *bus, const char *path, const char *interface, ...) _sd_sentinel_;
308
309 int sd_bus_query_sender_creds(sd_bus_message *m, uint64_t mask, sd_bus_creds **ret);
310 int sd_bus_query_sender_privilege(sd_bus_message *m, int capability);
311
312 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);
313 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 install_callback, void *userdata);
314
315 /* Credential handling */
316
317 int sd_bus_creds_new_from_pid(sd_bus_creds **ret, pid_t pid, uint64_t creds_mask);
318 int sd_bus_creds_new_from_pidfd(sd_bus_creds **ret, int pidfd, uint64_t creds_mask);
319 sd_bus_creds* sd_bus_creds_ref(sd_bus_creds *c);
320 sd_bus_creds* sd_bus_creds_unref(sd_bus_creds *c);
321 uint64_t sd_bus_creds_get_mask(const sd_bus_creds *c);
322 uint64_t sd_bus_creds_get_augmented_mask(const sd_bus_creds *c);
323
324 int sd_bus_creds_get_pid(sd_bus_creds *c, pid_t *ret);
325 int sd_bus_creds_get_pidfd_dup(sd_bus_creds *c, int *ret);
326 int sd_bus_creds_get_ppid(sd_bus_creds *c, pid_t *ret);
327 int sd_bus_creds_get_tid(sd_bus_creds *c, pid_t *ret);
328 int sd_bus_creds_get_uid(sd_bus_creds *c, uid_t *ret);
329 int sd_bus_creds_get_euid(sd_bus_creds *c, uid_t *ret);
330 int sd_bus_creds_get_suid(sd_bus_creds *c, uid_t *ret);
331 int sd_bus_creds_get_fsuid(sd_bus_creds *c, uid_t *ret);
332 int sd_bus_creds_get_gid(sd_bus_creds *c, gid_t *ret);
333 int sd_bus_creds_get_egid(sd_bus_creds *c, gid_t *ret);
334 int sd_bus_creds_get_sgid(sd_bus_creds *c, gid_t *ret);
335 int sd_bus_creds_get_fsgid(sd_bus_creds *c, gid_t *ret);
336 int sd_bus_creds_get_supplementary_gids(sd_bus_creds *c, const gid_t **ret);
337 int sd_bus_creds_get_comm(sd_bus_creds *c, const char **ret);
338 int sd_bus_creds_get_tid_comm(sd_bus_creds *c, const char **ret);
339 int sd_bus_creds_get_exe(sd_bus_creds *c, const char **ret);
340 int sd_bus_creds_get_cmdline(sd_bus_creds *c, char ***ret);
341 int sd_bus_creds_get_cgroup(sd_bus_creds *c, const char **ret);
342 int sd_bus_creds_get_unit(sd_bus_creds *c, const char **ret);
343 int sd_bus_creds_get_slice(sd_bus_creds *c, const char **ret);
344 int sd_bus_creds_get_user_unit(sd_bus_creds *c, const char **ret);
345 int sd_bus_creds_get_user_slice(sd_bus_creds *c, const char **ret);
346 int sd_bus_creds_get_session(sd_bus_creds *c, const char **ret);
347 int sd_bus_creds_get_owner_uid(sd_bus_creds *c, uid_t *ret);
348 int sd_bus_creds_has_effective_cap(sd_bus_creds *c, int capability);
349 int sd_bus_creds_has_permitted_cap(sd_bus_creds *c, int capability);
350 int sd_bus_creds_has_inheritable_cap(sd_bus_creds *c, int capability);
351 int sd_bus_creds_has_bounding_cap(sd_bus_creds *c, int capability);
352 int sd_bus_creds_get_selinux_context(sd_bus_creds *c, const char **ret);
353 int sd_bus_creds_get_audit_session_id(sd_bus_creds *c, uint32_t *ret);
354 int sd_bus_creds_get_audit_login_uid(sd_bus_creds *c, uid_t *ret);
355 int sd_bus_creds_get_tty(sd_bus_creds *c, const char **ret);
356 int sd_bus_creds_get_unique_name(sd_bus_creds *c, const char **ret);
357 int sd_bus_creds_get_well_known_names(sd_bus_creds *c, char ***ret);
358 int sd_bus_creds_get_description(sd_bus_creds *c, const char **ret);
359
360 /* Error structures */
361
362 #define SD_BUS_ERROR_MAKE_CONST(name, message) ((const sd_bus_error) {(name), (message), 0})
363 #define SD_BUS_ERROR_NULL SD_BUS_ERROR_MAKE_CONST(NULL, NULL)
364
365 void sd_bus_error_free(sd_bus_error *e);
366 int sd_bus_error_set(sd_bus_error *e, const char *name, const char *message);
367 int sd_bus_error_setf(sd_bus_error *e, const char *name, const char *format, ...) _sd_printf_(3, 4);
368 int sd_bus_error_setfv(sd_bus_error *e, const char *name, const char *format, va_list ap) _sd_printf_(3,0);
369
370 int sd_bus_error_set_const(sd_bus_error *e, const char *name, const char *message);
371 int sd_bus_error_set_errno(sd_bus_error *e, int error);
372 int sd_bus_error_set_errnof(sd_bus_error *e, int error, const char *format, ...) _sd_printf_(3, 4);
373 int sd_bus_error_set_errnofv(sd_bus_error *e, int error, const char *format, va_list ap) _sd_printf_(3,0);
374 int sd_bus_error_get_errno(const sd_bus_error *e);
375 int sd_bus_error_copy(sd_bus_error *dest, const sd_bus_error *e);
376 int sd_bus_error_move(sd_bus_error *dest, sd_bus_error *e);
377 _sd_pure_ int sd_bus_error_is_set(const sd_bus_error *e);
378 _sd_pure_ int sd_bus_error_has_name(const sd_bus_error *e, const char *name);
379 int sd_bus_error_has_names_sentinel(const sd_bus_error *e, ...) _sd_sentinel_;
380 #define sd_bus_error_has_names(e, ...) sd_bus_error_has_names_sentinel(e, __VA_ARGS__, NULL)
381
382 #define SD_BUS_ERROR_MAP(_name, _code) \
383 { \
384 .name = _name, \
385 .code = _code, \
386 }
387 #define SD_BUS_ERROR_MAP_END \
388 { \
389 .name = NULL, \
390 .code = - 'x', \
391 }
392
393 int sd_bus_error_add_map(const sd_bus_error_map *map);
394
395 /* Auxiliary macros */
396
397 #define SD_BUS_MESSAGE_APPEND_ID128(x) 16, \
398 (x).bytes[0], (x).bytes[1], (x).bytes[2], (x).bytes[3], \
399 (x).bytes[4], (x).bytes[5], (x).bytes[6], (x).bytes[7], \
400 (x).bytes[8], (x).bytes[9], (x).bytes[10], (x).bytes[11], \
401 (x).bytes[12], (x).bytes[13], (x).bytes[14], (x).bytes[15]
402
403 #define SD_BUS_MESSAGE_READ_ID128(x) 16, \
404 &(x).bytes[0], &(x).bytes[1], &(x).bytes[2], &(x).bytes[3], \
405 &(x).bytes[4], &(x).bytes[5], &(x).bytes[6], &(x).bytes[7], \
406 &(x).bytes[8], &(x).bytes[9], &(x).bytes[10], &(x).bytes[11], \
407 &(x).bytes[12], &(x).bytes[13], &(x).bytes[14], &(x).bytes[15]
408
409 /* Label escaping */
410
411 int sd_bus_path_encode(const char *prefix, const char *external_id, char **ret);
412 int sd_bus_path_encode_many(char **ret, const char *path_template, ...);
413 int sd_bus_path_decode(const char *path, const char *prefix, char **ret);
414 int sd_bus_path_decode_many(const char *path, const char *path_template, ...);
415
416 /* Tracking peers */
417
418 int sd_bus_track_new(sd_bus *bus, sd_bus_track **ret, sd_bus_track_handler_t handler, void *userdata);
419 sd_bus_track* sd_bus_track_ref(sd_bus_track *track);
420 sd_bus_track* sd_bus_track_unref(sd_bus_track *track);
421
422 sd_bus* sd_bus_track_get_bus(sd_bus_track *track);
423 void* sd_bus_track_get_userdata(sd_bus_track *track);
424 void* sd_bus_track_set_userdata(sd_bus_track *track, void *userdata);
425
426 int sd_bus_track_add_sender(sd_bus_track *track, sd_bus_message *m);
427 int sd_bus_track_remove_sender(sd_bus_track *track, sd_bus_message *m);
428 int sd_bus_track_add_name(sd_bus_track *track, const char *name);
429 int sd_bus_track_remove_name(sd_bus_track *track, const char *name);
430
431 int sd_bus_track_set_recursive(sd_bus_track *track, int b);
432 int sd_bus_track_get_recursive(sd_bus_track *track);
433
434 unsigned sd_bus_track_count(sd_bus_track *track);
435 int sd_bus_track_count_sender(sd_bus_track *track, sd_bus_message *m);
436 int sd_bus_track_count_name(sd_bus_track *track, const char *name);
437
438 const char* sd_bus_track_contains(sd_bus_track *track, const char *name);
439 const char* sd_bus_track_first(sd_bus_track *track);
440 const char* sd_bus_track_next(sd_bus_track *track);
441
442 int sd_bus_track_set_destroy_callback(sd_bus_track *s, sd_bus_destroy_t callback);
443 int sd_bus_track_get_destroy_callback(sd_bus_track *s, sd_bus_destroy_t *ret);
444
445 /* Define helpers so that __attribute__((cleanup(sd_bus_unrefp))) and similar may be used. */
446 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus, sd_bus_unref);
447 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus, sd_bus_close_unref);
448 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus, sd_bus_flush_close_unref);
449 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus_slot, sd_bus_slot_unref);
450 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus_message, sd_bus_message_unref);
451 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus_creds, sd_bus_creds_unref);
452 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus_track, sd_bus_track_unref);
453
454 _SD_END_DECLARATIONS;
455
456 #endif