chiark / gitweb /
f5fd37a6628bea7487ca5c710410c6360a1ea3b5
[elogind.git] / src / systemd / sd-bus.h
1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
2
3 #ifndef foosdbushfoo
4 #define foosdbushfoo
5
6 /***
7   This file is part of systemd.
8
9   Copyright 2013 Lennart Poettering
10
11   systemd is free software; you can redistribute it and/or modify it
12   under the terms of the GNU Lesser General Public License as published by
13   the Free Software Foundation; either version 2.1 of the License, or
14   (at your option) any later version.
15
16   systemd is distributed in the hope that it will be useful, but
17   WITHOUT ANY WARRANTY; without even the implied warranty of
18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19   Lesser General Public License for more details.
20
21   You should have received a copy of the GNU Lesser General Public License
22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
23 ***/
24
25 #include <inttypes.h>
26 #include <sys/types.h>
27 #include <sys/uio.h>
28
29 #include "sd-id128.h"
30 #include "sd-event.h"
31 #include "_sd-common.h"
32
33 _SD_BEGIN_DECLARATIONS;
34
35 /* Types */
36
37 typedef struct sd_bus sd_bus;
38 typedef struct sd_bus_message sd_bus_message;
39 typedef struct sd_bus_slot sd_bus_slot;
40 typedef struct sd_bus_creds sd_bus_creds;
41 typedef struct sd_bus_track sd_bus_track;
42
43 typedef struct {
44         const char *name;
45         const char *message;
46         int _need_free;
47 } sd_bus_error;
48
49 typedef struct {
50         const char* name;
51         int code;
52 } sd_bus_error_map;
53
54 /* Flags */
55
56 enum {
57         SD_BUS_CREDS_PID                = 1ULL << 0,
58         SD_BUS_CREDS_PID_STARTTIME      = 1ULL << 1,
59         SD_BUS_CREDS_TID                = 1ULL << 2,
60         SD_BUS_CREDS_UID                = 1ULL << 3,
61         SD_BUS_CREDS_EUID               = 1ULL << 4,
62         SD_BUS_CREDS_SUID               = 1ULL << 5,
63         SD_BUS_CREDS_FSUID              = 1ULL << 6,
64         SD_BUS_CREDS_GID                = 1ULL << 7,
65         SD_BUS_CREDS_EGID               = 1ULL << 8,
66         SD_BUS_CREDS_SGID               = 1ULL << 9,
67         SD_BUS_CREDS_FSGID              = 1ULL << 10,
68         SD_BUS_CREDS_SUPPLEMENTARY_GIDS = 1ULL << 11,
69         SD_BUS_CREDS_COMM               = 1ULL << 12,
70         SD_BUS_CREDS_TID_COMM           = 1ULL << 13,
71         SD_BUS_CREDS_EXE                = 1ULL << 14,
72         SD_BUS_CREDS_CMDLINE            = 1ULL << 15,
73         SD_BUS_CREDS_CGROUP             = 1ULL << 16,
74         SD_BUS_CREDS_UNIT               = 1ULL << 17,
75         SD_BUS_CREDS_USER_UNIT          = 1ULL << 18,
76         SD_BUS_CREDS_SLICE              = 1ULL << 19,
77         SD_BUS_CREDS_SESSION            = 1ULL << 20,
78         SD_BUS_CREDS_OWNER_UID          = 1ULL << 21,
79         SD_BUS_CREDS_EFFECTIVE_CAPS     = 1ULL << 22,
80         SD_BUS_CREDS_PERMITTED_CAPS     = 1ULL << 23,
81         SD_BUS_CREDS_INHERITABLE_CAPS   = 1ULL << 24,
82         SD_BUS_CREDS_BOUNDING_CAPS      = 1ULL << 25,
83         SD_BUS_CREDS_SELINUX_CONTEXT    = 1ULL << 26,
84         SD_BUS_CREDS_AUDIT_SESSION_ID   = 1ULL << 27,
85         SD_BUS_CREDS_AUDIT_LOGIN_UID    = 1ULL << 28,
86         SD_BUS_CREDS_UNIQUE_NAME        = 1ULL << 29,
87         SD_BUS_CREDS_WELL_KNOWN_NAMES   = 1ULL << 30,
88         SD_BUS_CREDS_DESCRIPTION        = 1ULL << 31,
89         SD_BUS_CREDS_AUGMENT            = 1ULL << 63, /* special flag, if on sd-bus will augment creds struct, in a potentially race-full way. */
90         _SD_BUS_CREDS_ALL               = (1ULL << 32) -1,
91 };
92
93 enum {
94         SD_BUS_NAME_REPLACE_EXISTING  = 1ULL << 0,
95         SD_BUS_NAME_ALLOW_REPLACEMENT = 1ULL << 1,
96         SD_BUS_NAME_QUEUE             = 1ULL << 2,
97 };
98
99 /* Callbacks */
100
101 typedef int (*sd_bus_message_handler_t)(sd_bus *bus, sd_bus_message *m, void *userdata, sd_bus_error *ret_error);
102 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);
103 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);
104 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);
105 typedef int (*sd_bus_node_enumerator_t) (sd_bus *bus, const char *path, void *userdata, char ***ret_nodes, sd_bus_error *ret_error);
106 typedef int (*sd_bus_track_handler_t) (sd_bus_track *track, void *userdata);
107
108 #include "sd-bus-protocol.h"
109 #include "sd-bus-vtable.h"
110
111 /* Connections */
112
113 int sd_bus_default(sd_bus **ret);
114 int sd_bus_default_user(sd_bus **ret);
115 int sd_bus_default_system(sd_bus **ret);
116
117 int sd_bus_open(sd_bus **ret);
118 int sd_bus_open_user(sd_bus **ret);
119 int sd_bus_open_system(sd_bus **ret);
120 int sd_bus_open_system_remote(sd_bus **ret, const char *host);
121 int sd_bus_open_system_container(sd_bus **ret, const char *machine);
122
123 int sd_bus_new(sd_bus **ret);
124
125 int sd_bus_set_address(sd_bus *bus, const char *address);
126 int sd_bus_set_fd(sd_bus *bus, int input_fd, int output_fd);
127 int sd_bus_set_exec(sd_bus *bus, const char *path, char *const argv[]);
128 int sd_bus_get_address(sd_bus *bus, const char **address);
129 int sd_bus_set_bus_client(sd_bus *bus, int b);
130 int sd_bus_is_bus_client(sd_bus *bus);
131 int sd_bus_set_server(sd_bus *bus, int b, sd_id128_t bus_id);
132 int sd_bus_is_server(sd_bus *bus);
133 int sd_bus_set_anonymous(sd_bus *bus, int b);
134 int sd_bus_is_anonymous(sd_bus *bus);
135 int sd_bus_set_trusted(sd_bus *bus, int b);
136 int sd_bus_is_trusted(sd_bus *bus);
137 int sd_bus_set_monitor(sd_bus *bus, int b);
138 int sd_bus_is_monitor(sd_bus *bus);
139 int sd_bus_set_description(sd_bus *bus, const char *description);
140 int sd_bus_get_description(sd_bus *bus, const char **description);
141 int sd_bus_negotiate_fds(sd_bus *bus, int b);
142 int sd_bus_can_send(sd_bus *bus, char type);
143 int sd_bus_negotiate_timestamp(sd_bus *bus, int b);
144 int sd_bus_negotiate_creds(sd_bus *bus, int b, uint64_t creds_mask);
145 int sd_bus_get_creds_mask(sd_bus *bus, uint64_t *creds_mask);
146
147 int sd_bus_start(sd_bus *ret);
148
149 int sd_bus_try_close(sd_bus *bus);
150 void sd_bus_close(sd_bus *bus);
151
152 sd_bus *sd_bus_ref(sd_bus *bus);
153 sd_bus *sd_bus_unref(sd_bus *bus);
154
155 int sd_bus_is_open(sd_bus *bus);
156
157 int sd_bus_get_bus_id(sd_bus *bus, sd_id128_t *id);
158 int sd_bus_get_scope(sd_bus *bus, const char **scope);
159 int sd_bus_get_tid(sd_bus *bus, pid_t *tid);
160 int sd_bus_get_owner_creds(sd_bus *bus, uint64_t creds_mask, sd_bus_creds **ret);
161
162 int sd_bus_send(sd_bus *bus, sd_bus_message *m, uint64_t *cookie);
163 int sd_bus_send_to(sd_bus *bus, sd_bus_message *m, const char *destination, uint64_t *cookie);
164 int sd_bus_call(sd_bus *bus, sd_bus_message *m, uint64_t usec, sd_bus_error *ret_error, sd_bus_message **reply);
165 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);
166
167 int sd_bus_get_fd(sd_bus *bus);
168 int sd_bus_get_events(sd_bus *bus);
169 int sd_bus_get_timeout(sd_bus *bus, uint64_t *timeout_usec);
170 int sd_bus_process(sd_bus *bus, sd_bus_message **r);
171 int sd_bus_process_priority(sd_bus *bus, int64_t max_priority, sd_bus_message **r);
172 int sd_bus_wait(sd_bus *bus, uint64_t timeout_usec);
173 int sd_bus_flush(sd_bus *bus);
174
175 sd_bus_slot* sd_bus_get_current_slot(sd_bus *bus);
176 sd_bus_message* sd_bus_get_current_message(sd_bus *bus);
177 sd_bus_message_handler_t sd_bus_get_current_handler(sd_bus *bus);
178 void* sd_bus_get_current_userdata(sd_bus *bus);
179
180 int sd_bus_attach_event(sd_bus *bus, sd_event *e, int priority);
181 int sd_bus_detach_event(sd_bus *bus);
182 sd_event *sd_bus_get_event(sd_bus *bus);
183
184 int sd_bus_add_filter(sd_bus *bus, sd_bus_slot **slot, sd_bus_message_handler_t callback, void *userdata);
185 int sd_bus_add_match(sd_bus *bus, sd_bus_slot **slot, const char *match, sd_bus_message_handler_t callback, void *userdata);
186 int sd_bus_add_object(sd_bus *bus, sd_bus_slot **slot, const char *path, sd_bus_message_handler_t callback, void *userdata);
187 int sd_bus_add_fallback(sd_bus *bus, sd_bus_slot **slot, const char *prefix, sd_bus_message_handler_t callback, void *userdata);
188 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);
189 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);
190 int sd_bus_add_node_enumerator(sd_bus *bus, sd_bus_slot **slot, const char *path, sd_bus_node_enumerator_t callback, void *userdata);
191 int sd_bus_add_object_manager(sd_bus *bus, sd_bus_slot **slot, const char *path);
192
193 /* Slot object */
194
195 sd_bus_slot* sd_bus_slot_ref(sd_bus_slot *slot);
196 sd_bus_slot* sd_bus_slot_unref(sd_bus_slot *slot);
197
198 sd_bus* sd_bus_slot_get_bus(sd_bus_slot *slot);
199 void *sd_bus_slot_get_userdata(sd_bus_slot *slot);
200 void *sd_bus_slot_set_userdata(sd_bus_slot *slot, void *userdata);
201 int sd_bus_slot_set_description(sd_bus_slot *slot, const char *description);
202 int sd_bus_slot_get_description(sd_bus_slot *slot, char **description);
203
204 sd_bus_message* sd_bus_slot_get_current_message(sd_bus_slot *slot);
205 sd_bus_message_handler_t sd_bus_slot_get_current_handler(sd_bus_slot *bus);
206 void *sd_bus_slot_get_current_userdata(sd_bus_slot *slot);
207
208 /* Message object */
209
210 int sd_bus_message_new_signal(sd_bus *bus, sd_bus_message **m, const char *path, const char *interface, const char *member);
211 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);
212 int sd_bus_message_new_method_return(sd_bus_message *call, sd_bus_message **m);
213 int sd_bus_message_new_method_error(sd_bus_message *call, sd_bus_message **m, const sd_bus_error *e);
214 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);
215 int sd_bus_message_new_method_errno(sd_bus_message *call, sd_bus_message **m, int error, const sd_bus_error *e);
216 int sd_bus_message_new_method_errnof(sd_bus_message *call, sd_bus_message **m, int error, const char *format, ...) _sd_printf_(4, 5);
217
218 sd_bus_message* sd_bus_message_ref(sd_bus_message *m);
219 sd_bus_message* sd_bus_message_unref(sd_bus_message *m);
220
221 int sd_bus_message_get_type(sd_bus_message *m, uint8_t *type);
222 int sd_bus_message_get_cookie(sd_bus_message *m, uint64_t *cookie);
223 int sd_bus_message_get_reply_cookie(sd_bus_message *m, uint64_t *cookie);
224 int sd_bus_message_get_priority(sd_bus_message *m, int64_t *priority);
225
226 int sd_bus_message_get_expect_reply(sd_bus_message *m);
227 int sd_bus_message_get_auto_start(sd_bus_message *m);
228 int sd_bus_message_get_allow_interactive_authorization(sd_bus_message *m);
229
230 const char *sd_bus_message_get_signature(sd_bus_message *m, int complete);
231 const char *sd_bus_message_get_path(sd_bus_message *m);
232 const char *sd_bus_message_get_interface(sd_bus_message *m);
233 const char *sd_bus_message_get_member(sd_bus_message *m);
234 const char *sd_bus_message_get_destination(sd_bus_message *m);
235 const char *sd_bus_message_get_sender(sd_bus_message *m);
236 const sd_bus_error *sd_bus_message_get_error(sd_bus_message *m);
237 int sd_bus_message_get_errno(sd_bus_message *m);
238
239 int sd_bus_message_get_monotonic_usec(sd_bus_message *m, uint64_t *usec);
240 int sd_bus_message_get_realtime_usec(sd_bus_message *m, uint64_t *usec);
241 int sd_bus_message_get_seqnum(sd_bus_message *m, uint64_t* seqnum);
242
243 sd_bus* sd_bus_message_get_bus(sd_bus_message *m);
244 sd_bus_creds *sd_bus_message_get_creds(sd_bus_message *m); /* do not unref the result */
245
246 int sd_bus_message_is_signal(sd_bus_message *m, const char *interface, const char *member);
247 int sd_bus_message_is_method_call(sd_bus_message *m, const char *interface, const char *member);
248 int sd_bus_message_is_method_error(sd_bus_message *m, const char *name);
249 int sd_bus_message_is_empty(sd_bus_message *m);
250 int sd_bus_message_has_signature(sd_bus_message *m, const char *signature);
251
252 int sd_bus_message_set_expect_reply(sd_bus_message *m, int b);
253 int sd_bus_message_set_auto_start(sd_bus_message *m, int b);
254 int sd_bus_message_set_allow_interactive_authorization(sd_bus_message *m, int b);
255
256 int sd_bus_message_set_destination(sd_bus_message *m, const char *destination);
257 int sd_bus_message_set_priority(sd_bus_message *m, int64_t priority);
258
259 int sd_bus_message_append(sd_bus_message *m, const char *types, ...);
260 int sd_bus_message_append_basic(sd_bus_message *m, char type, const void *p);
261 int sd_bus_message_append_array(sd_bus_message *m, char type, const void *ptr, size_t size);
262 int sd_bus_message_append_array_space(sd_bus_message *m, char type, size_t size, void **ptr);
263 int sd_bus_message_append_array_iovec(sd_bus_message *m, char type, const struct iovec *iov, unsigned n);
264 int sd_bus_message_append_array_memfd(sd_bus_message *m, char type, int memfd);
265 int sd_bus_message_append_string_space(sd_bus_message *m, size_t size, char **s);
266 int sd_bus_message_append_string_iovec(sd_bus_message *m, const struct iovec *iov, unsigned n);
267 int sd_bus_message_append_string_memfd(sd_bus_message *m, int memfd);
268 int sd_bus_message_append_strv(sd_bus_message *m, char **l);
269 int sd_bus_message_open_container(sd_bus_message *m, char type, const char *contents);
270 int sd_bus_message_close_container(sd_bus_message *m);
271 int sd_bus_message_copy(sd_bus_message *m, sd_bus_message *source, int all);
272
273 int sd_bus_message_read(sd_bus_message *m, const char *types, ...);
274 int sd_bus_message_read_basic(sd_bus_message *m, char type, void *p);
275 int sd_bus_message_read_array(sd_bus_message *m, char type, const void **ptr, size_t *size);
276 int sd_bus_message_read_strv(sd_bus_message *m, char ***l); /* free the result! */
277 int sd_bus_message_skip(sd_bus_message *m, const char *types);
278 int sd_bus_message_enter_container(sd_bus_message *m, char type, const char *contents);
279 int sd_bus_message_exit_container(sd_bus_message *m);
280 int sd_bus_message_peek_type(sd_bus_message *m, char *type, const char **contents);
281 int sd_bus_message_verify_type(sd_bus_message *m, char type, const char *contents);
282 int sd_bus_message_at_end(sd_bus_message *m, int complete);
283 int sd_bus_message_rewind(sd_bus_message *m, int complete);
284
285 /* Bus management */
286
287 int sd_bus_get_unique_name(sd_bus *bus, const char **unique);
288 int sd_bus_request_name(sd_bus *bus, const char *name, uint64_t flags);
289 int sd_bus_release_name(sd_bus *bus, const char *name);
290 int sd_bus_list_names(sd_bus *bus, char ***acquired, char ***activatable); /* free the results */
291 int sd_bus_get_name_creds(sd_bus *bus, const char *name, uint64_t mask, sd_bus_creds **creds); /* unref the result! */
292 int sd_bus_get_name_machine_id(sd_bus *bus, const char *name, sd_id128_t *machine);
293
294 /* Convenience calls */
295
296 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, ...);
297 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);
298 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);
299 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! */
300 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! */
301 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 *ret_type, ...);
302
303 int sd_bus_reply_method_return(sd_bus_message *call, const char *types, ...);
304 int sd_bus_reply_method_error(sd_bus_message *call, const sd_bus_error *e);
305 int sd_bus_reply_method_errorf(sd_bus_message *call, const char *name, const char *format, ...) _sd_printf_(3, 4);
306 int sd_bus_reply_method_errno(sd_bus_message *call, int error, const sd_bus_error *e);
307 int sd_bus_reply_method_errnof(sd_bus_message *call, int error, const char *format, ...) _sd_printf_(3, 4);
308
309 int sd_bus_emit_signal(sd_bus *bus, const char *path, const char *interface, const char *member, const char *types, ...);
310
311 int sd_bus_emit_properties_changed_strv(sd_bus *bus, const char *path, const char *interface, char **names);
312 int sd_bus_emit_properties_changed(sd_bus *bus, const char *path, const char *interface, const char *name, ...) _sd_sentinel_;
313
314 int sd_bus_emit_interfaces_added_strv(sd_bus *bus, const char *path, char **interfaces);
315 int sd_bus_emit_interfaces_added(sd_bus *bus, const char *path, const char *interface, ...) _sd_sentinel_;
316 int sd_bus_emit_interfaces_removed_strv(sd_bus *bus, const char *path, char **interfaces);
317 int sd_bus_emit_interfaces_removed(sd_bus *bus, const char *path, const char *interface, ...) _sd_sentinel_;
318
319 int sd_bus_query_sender_creds(sd_bus_message *call, uint64_t mask, sd_bus_creds **creds);
320 int sd_bus_query_sender_privilege(sd_bus_message *call, int capability);
321
322 /* Credential handling */
323
324 int sd_bus_creds_new_from_pid(sd_bus_creds **ret, pid_t pid, uint64_t creds_mask);
325 sd_bus_creds *sd_bus_creds_ref(sd_bus_creds *c);
326 sd_bus_creds *sd_bus_creds_unref(sd_bus_creds *c);
327 uint64_t sd_bus_creds_get_mask(const sd_bus_creds *c);
328
329 int sd_bus_creds_get_pid(sd_bus_creds *c, pid_t *pid);
330 int sd_bus_creds_get_pid_starttime(sd_bus_creds *c, uint64_t *usec);
331 int sd_bus_creds_get_tid(sd_bus_creds *c, pid_t *tid);
332 int sd_bus_creds_get_uid(sd_bus_creds *c, uid_t *uid);
333 int sd_bus_creds_get_euid(sd_bus_creds *c, uid_t *euid);
334 int sd_bus_creds_get_suid(sd_bus_creds *c, uid_t *suid);
335 int sd_bus_creds_get_fsuid(sd_bus_creds *c, uid_t *fsuid);
336 int sd_bus_creds_get_gid(sd_bus_creds *c, gid_t *gid);
337 int sd_bus_creds_get_egid(sd_bus_creds *c, gid_t *egid);
338 int sd_bus_creds_get_sgid(sd_bus_creds *c, gid_t *sgid);
339 int sd_bus_creds_get_fsgid(sd_bus_creds *c, gid_t *fsgid);
340 int sd_bus_creds_get_supplementary_gids(sd_bus_creds *c, const gid_t **gids);
341 int sd_bus_creds_get_comm(sd_bus_creds *c, const char **comm);
342 int sd_bus_creds_get_tid_comm(sd_bus_creds *c, const char **comm);
343 int sd_bus_creds_get_exe(sd_bus_creds *c, const char **exe);
344 int sd_bus_creds_get_cmdline(sd_bus_creds *c, char ***cmdline);
345 int sd_bus_creds_get_cgroup(sd_bus_creds *c, const char **cgroup);
346 int sd_bus_creds_get_unit(sd_bus_creds *c, const char **unit);
347 int sd_bus_creds_get_user_unit(sd_bus_creds *c, const char **unit);
348 int sd_bus_creds_get_slice(sd_bus_creds *c, const char **slice);
349 int sd_bus_creds_get_session(sd_bus_creds *c, const char **session);
350 int sd_bus_creds_get_owner_uid(sd_bus_creds *c, uid_t *uid);
351 int sd_bus_creds_has_effective_cap(sd_bus_creds *c, int capability);
352 int sd_bus_creds_has_permitted_cap(sd_bus_creds *c, int capability);
353 int sd_bus_creds_has_inheritable_cap(sd_bus_creds *c, int capability);
354 int sd_bus_creds_has_bounding_cap(sd_bus_creds *c, int capability);
355 int sd_bus_creds_get_selinux_context(sd_bus_creds *c, const char **context);
356 int sd_bus_creds_get_audit_session_id(sd_bus_creds *c, uint32_t *sessionid);
357 int sd_bus_creds_get_audit_login_uid(sd_bus_creds *c, uid_t *loginuid);
358 int sd_bus_creds_get_unique_name(sd_bus_creds *c, const char **name);
359 int sd_bus_creds_get_well_known_names(sd_bus_creds *c, char ***names);
360 int sd_bus_creds_get_description(sd_bus_creds *c, const char **name);
361
362 /* Error structures */
363
364 #define SD_BUS_ERROR_MAKE_CONST(name, message) ((const sd_bus_error) {(name), (message), 0})
365 #define SD_BUS_ERROR_NULL SD_BUS_ERROR_MAKE_CONST(NULL, NULL)
366
367 void sd_bus_error_free(sd_bus_error *e);
368 int sd_bus_error_set(sd_bus_error *e, const char *name, const char *message);
369 int sd_bus_error_setf(sd_bus_error *e, const char *name, const char *format, ...)  _sd_printf_(3, 4);
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_get_errno(const sd_bus_error *e);
374 int sd_bus_error_copy(sd_bus_error *dest, const sd_bus_error *e);
375 int sd_bus_error_is_set(const sd_bus_error *e);
376 int sd_bus_error_has_name(const sd_bus_error *e, const char *name);
377
378 #define SD_BUS_ERROR_MAP(_name, _code)          \
379         {                                       \
380                 .name = _name,                  \
381                 .code = _code,                  \
382         }
383 #define SD_BUS_ERROR_MAP_END                    \
384         {                                       \
385                 .name = NULL,                   \
386                 .code = - 'x',                  \
387         }
388
389 int sd_bus_error_add_map(const sd_bus_error_map *map);
390
391 /* Auxiliary macros */
392
393 #define SD_BUS_MESSAGE_APPEND_ID128(x) 16,                              \
394                 (x).bytes[0],  (x).bytes[1],  (x).bytes[2],  (x).bytes[3], \
395                 (x).bytes[4],  (x).bytes[5],  (x).bytes[6],  (x).bytes[7], \
396                 (x).bytes[8],  (x).bytes[9],  (x).bytes[10], (x).bytes[11], \
397                 (x).bytes[12], (x).bytes[13], (x).bytes[14], (x).bytes[15]
398
399 #define SD_BUS_MESSAGE_READ_ID128(x) 16,                                \
400                 &(x).bytes[0],  &(x).bytes[1],  &(x).bytes[2],  &(x).bytes[3], \
401                 &(x).bytes[4],  &(x).bytes[5],  &(x).bytes[6],  &(x).bytes[7], \
402                 &(x).bytes[8],  &(x).bytes[9],  &(x).bytes[10], &(x).bytes[11], \
403                 &(x).bytes[12], &(x).bytes[13], &(x).bytes[14], &(x).bytes[15]
404
405 /* Label escaping */
406
407 int sd_bus_path_encode(const char *prefix, const char *external_id, char **ret_path);
408 int sd_bus_path_decode(const char *path, const char *prefix, char **ret_external_id);
409
410 /* Tracking peers */
411
412 int sd_bus_track_new(sd_bus *bus, sd_bus_track **track, sd_bus_track_handler_t handler, void *userdata);
413 sd_bus_track* sd_bus_track_ref(sd_bus_track *track);
414 sd_bus_track* sd_bus_track_unref(sd_bus_track *track);
415
416 sd_bus* sd_bus_track_get_bus(sd_bus_track *track);
417 void *sd_bus_track_get_userdata(sd_bus_track *track);
418 void *sd_bus_track_set_userdata(sd_bus_track *track, void *userdata);
419
420 int sd_bus_track_add_sender(sd_bus_track *track, sd_bus_message *m);
421 int sd_bus_track_remove_sender(sd_bus_track *track, sd_bus_message *m);
422 int sd_bus_track_add_name(sd_bus_track *track, const char *name);
423 int sd_bus_track_remove_name(sd_bus_track *track, const char *name);
424
425 unsigned sd_bus_track_count(sd_bus_track *track);
426 const char* sd_bus_track_contains(sd_bus_track *track, const char *names);
427 const char* sd_bus_track_first(sd_bus_track *track);
428 const char* sd_bus_track_next(sd_bus_track *track);
429
430 _SD_END_DECLARATIONS;
431
432 #endif