]> git.ipfire.org Git - thirdparty/systemd.git/blame - src/systemd/sd-bus.h
Merge pull request #9764 from yuwata/hash_ops-cleanups
[thirdparty/systemd.git] / src / systemd / sd-bus.h
CommitLineData
53e1b683 1/* SPDX-License-Identifier: LGPL-2.1+ */
de1c301e
LP
2#ifndef foosdbushfoo
3#define foosdbushfoo
4
5/***
de1c301e
LP
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>
07a0d22f 21#include <stdarg.h>
de1c301e 22#include <sys/types.h>
938bcbab 23#include <sys/uio.h>
de1c301e 24
40ca29a1 25#include "sd-event.h"
71d35b6b
TA
26#include "sd-id128.h"
27
aacf3b48 28#include "_sd-common.h"
de1c301e 29
0095c454 30_SD_BEGIN_DECLARATIONS;
b29b8bc2 31
45b1f410
NM
32#define SD_BUS_DEFAULT ((sd_bus *) 1)
33#define SD_BUS_DEFAULT_USER ((sd_bus *) 2)
34#define SD_BUS_DEFAULT_SYSTEM ((sd_bus *) 3)
35
29ddb38f
LP
36/* Types */
37
de1c301e
LP
38typedef struct sd_bus sd_bus;
39typedef struct sd_bus_message sd_bus_message;
19befb2d 40typedef struct sd_bus_slot sd_bus_slot;
5b12334d 41typedef struct sd_bus_creds sd_bus_creds;
8f8f05a9 42typedef struct sd_bus_track sd_bus_track;
de1c301e
LP
43
44typedef struct {
45 const char *name;
46 const char *message;
79f8d3d2 47 int _need_free;
de1c301e
LP
48} sd_bus_error;
49
5f86c1f4
LP
50typedef struct {
51 const char* name;
52 int code;
53} sd_bus_error_map;
54
5b12334d
LP
55/* Flags */
56
57enum {
02581590 58 SD_BUS_CREDS_PID = 1ULL << 0,
32802361 59 SD_BUS_CREDS_TID = 1ULL << 1,
1386e47d
LP
60 SD_BUS_CREDS_PPID = 1ULL << 2,
61 SD_BUS_CREDS_UID = 1ULL << 3,
62 SD_BUS_CREDS_EUID = 1ULL << 4,
63 SD_BUS_CREDS_SUID = 1ULL << 5,
64 SD_BUS_CREDS_FSUID = 1ULL << 6,
65 SD_BUS_CREDS_GID = 1ULL << 7,
66 SD_BUS_CREDS_EGID = 1ULL << 8,
67 SD_BUS_CREDS_SGID = 1ULL << 9,
68 SD_BUS_CREDS_FSGID = 1ULL << 10,
69 SD_BUS_CREDS_SUPPLEMENTARY_GIDS = 1ULL << 11,
70 SD_BUS_CREDS_COMM = 1ULL << 12,
71 SD_BUS_CREDS_TID_COMM = 1ULL << 13,
72 SD_BUS_CREDS_EXE = 1ULL << 14,
73 SD_BUS_CREDS_CMDLINE = 1ULL << 15,
74 SD_BUS_CREDS_CGROUP = 1ULL << 16,
75 SD_BUS_CREDS_UNIT = 1ULL << 17,
329ac4bc
LP
76 SD_BUS_CREDS_SLICE = 1ULL << 18,
77 SD_BUS_CREDS_USER_UNIT = 1ULL << 19,
78 SD_BUS_CREDS_USER_SLICE = 1ULL << 20,
79 SD_BUS_CREDS_SESSION = 1ULL << 21,
80 SD_BUS_CREDS_OWNER_UID = 1ULL << 22,
81 SD_BUS_CREDS_EFFECTIVE_CAPS = 1ULL << 23,
82 SD_BUS_CREDS_PERMITTED_CAPS = 1ULL << 24,
83 SD_BUS_CREDS_INHERITABLE_CAPS = 1ULL << 25,
84 SD_BUS_CREDS_BOUNDING_CAPS = 1ULL << 26,
85 SD_BUS_CREDS_SELINUX_CONTEXT = 1ULL << 27,
86 SD_BUS_CREDS_AUDIT_SESSION_ID = 1ULL << 28,
87 SD_BUS_CREDS_AUDIT_LOGIN_UID = 1ULL << 29,
88 SD_BUS_CREDS_TTY = 1ULL << 30,
89 SD_BUS_CREDS_UNIQUE_NAME = 1ULL << 31,
90 SD_BUS_CREDS_WELL_KNOWN_NAMES = 1ULL << 32,
91 SD_BUS_CREDS_DESCRIPTION = 1ULL << 33,
02581590 92 SD_BUS_CREDS_AUGMENT = 1ULL << 63, /* special flag, if on sd-bus will augment creds struct, in a potentially race-full way. */
e0c0b07d 93 _SD_BUS_CREDS_ALL = (1ULL << 34) -1
5b12334d
LP
94};
95
29a07cdb
LP
96enum {
97 SD_BUS_NAME_REPLACE_EXISTING = 1ULL << 0,
98 SD_BUS_NAME_ALLOW_REPLACEMENT = 1ULL << 1,
e0c0b07d 99 SD_BUS_NAME_QUEUE = 1ULL << 2
29a07cdb
LP
100};
101
29ddb38f
LP
102/* Callbacks */
103
19070062 104typedef int (*sd_bus_message_handler_t)(sd_bus_message *m, void *userdata, sd_bus_error *ret_error);
ebcf1f97
LP
105typedef 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);
106typedef 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);
f00c3121 107typedef 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);
19070062 108typedef int (*sd_bus_node_enumerator_t) (sd_bus *bus, const char *prefix, void *userdata, char ***ret_nodes, sd_bus_error *ret_error);
8f8f05a9 109typedef int (*sd_bus_track_handler_t) (sd_bus_track *track, void *userdata);
fa17b4e8 110typedef void (*sd_bus_destroy_t)(void *userdata);
29ddb38f
LP
111
112#include "sd-bus-protocol.h"
113#include "sd-bus-vtable.h"
29ddb38f 114
de1c301e
LP
115/* Connections */
116
69727e6d 117int sd_bus_default(sd_bus **ret);
76b54375
LP
118int sd_bus_default_user(sd_bus **ret);
119int sd_bus_default_system(sd_bus **ret);
120
af08d2f9 121int sd_bus_open(sd_bus **ret);
56fbd718 122int sd_bus_open_with_description(sd_bus **ret, const char *description);
de1c301e 123int sd_bus_open_user(sd_bus **ret);
56fbd718 124int sd_bus_open_user_with_description(sd_bus **ret, const char *description);
0f8bd8de 125int sd_bus_open_system(sd_bus **ret);
56fbd718 126int sd_bus_open_system_with_description(sd_bus **ret, const char *description);
3db729cb 127int sd_bus_open_system_remote(sd_bus **ret, const char *host);
de33fc62 128int sd_bus_open_system_machine(sd_bus **ret, const char *machine);
021a1e78
LP
129
130int sd_bus_new(sd_bus **ret);
224b3787 131
021a1e78 132int sd_bus_set_address(sd_bus *bus, const char *address);
15d5af81 133int sd_bus_set_fd(sd_bus *bus, int input_fd, int output_fd);
2fd9ae2e 134int sd_bus_set_exec(sd_bus *bus, const char *path, char *const argv[]);
224b3787 135int sd_bus_get_address(sd_bus *bus, const char **address);
94bbf1ba 136int sd_bus_set_bus_client(sd_bus *bus, int b);
224b3787 137int sd_bus_is_bus_client(sd_bus *bus);
5b820358 138int sd_bus_set_server(sd_bus *bus, int b, sd_id128_t bus_id);
224b3787 139int sd_bus_is_server(sd_bus *bus);
2181a7f5 140int sd_bus_set_anonymous(sd_bus *bus, int b);
224b3787 141int sd_bus_is_anonymous(sd_bus *bus);
adacb957 142int sd_bus_set_trusted(sd_bus *bus, int b);
224b3787 143int sd_bus_is_trusted(sd_bus *bus);
09365592 144int sd_bus_set_monitor(sd_bus *bus, int b);
224b3787
LP
145int sd_bus_is_monitor(sd_bus *bus);
146int sd_bus_set_description(sd_bus *bus, const char *description);
147int sd_bus_get_description(sd_bus *bus, const char **description);
882897af
LP
148int sd_bus_negotiate_creds(sd_bus *bus, int b, uint64_t creds_mask);
149int sd_bus_negotiate_timestamp(sd_bus *bus, int b);
264ad849 150int sd_bus_negotiate_fds(sd_bus *bus, int b);
224b3787 151int sd_bus_can_send(sd_bus *bus, char type);
224b3787 152int sd_bus_get_creds_mask(sd_bus *bus, uint64_t *creds_mask);
c0765ddb
LP
153int sd_bus_set_allow_interactive_authorization(sd_bus *bus, int b);
154int sd_bus_get_allow_interactive_authorization(sd_bus *bus);
fbb4603d
LP
155int sd_bus_set_exit_on_disconnect(sd_bus *bus, int b);
156int sd_bus_get_exit_on_disconnect(sd_bus *bus);
8a5cd31e
LP
157int sd_bus_set_watch_bind(sd_bus *bus, int b);
158int sd_bus_get_watch_bind(sd_bus *bus);
d7afd945
LP
159int sd_bus_set_connected_signal(sd_bus *bus, int b);
160int sd_bus_get_connected_signal(sd_bus *bus);
48ef41a3
LP
161int sd_bus_set_sender(sd_bus *bus, const char *sender);
162int sd_bus_get_sender(sd_bus *bus, const char **ret);
224b3787 163
8a5cd31e 164int sd_bus_start(sd_bus *bus);
021a1e78 165
ae095f86 166int sd_bus_try_close(sd_bus *bus);
de1c301e
LP
167void sd_bus_close(sd_bus *bus);
168
169sd_bus *sd_bus_ref(sd_bus *bus);
170sd_bus *sd_bus_unref(sd_bus *bus);
03976f7b 171sd_bus *sd_bus_flush_close_unref(sd_bus *bus);
de1c301e 172
fa2f8973
LP
173void sd_bus_default_flush_close(void);
174
e3017af9 175int sd_bus_is_open(sd_bus *bus);
bdbc8669 176int sd_bus_is_ready(sd_bus *bus);
224b3787 177
5c302692 178int sd_bus_get_bus_id(sd_bus *bus, sd_id128_t *id);
3acc1daf 179int sd_bus_get_scope(sd_bus *bus, const char **scope);
69727e6d 180int sd_bus_get_tid(sd_bus *bus, pid_t *tid);
224b3787 181int sd_bus_get_owner_creds(sd_bus *bus, uint64_t creds_mask, sd_bus_creds **ret);
de1c301e 182
693eb9a2
LP
183int sd_bus_send(sd_bus *bus, sd_bus_message *m, uint64_t *cookie);
184int sd_bus_send_to(sd_bus *bus, sd_bus_message *m, const char *destination, uint64_t *cookie);
ebcf1f97 185int sd_bus_call(sd_bus *bus, sd_bus_message *m, uint64_t usec, sd_bus_error *ret_error, sd_bus_message **reply);
19befb2d 186int 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);
de1c301e
LP
187
188int sd_bus_get_fd(sd_bus *bus);
189int sd_bus_get_events(sd_bus *bus);
e3017af9 190int sd_bus_get_timeout(sd_bus *bus, uint64_t *timeout_usec);
de1c301e 191int sd_bus_process(sd_bus *bus, sd_bus_message **r);
766c5809 192int sd_bus_process_priority(sd_bus *bus, int64_t max_priority, sd_bus_message **r);
de1c301e
LP
193int sd_bus_wait(sd_bus *bus, uint64_t timeout_usec);
194int sd_bus_flush(sd_bus *bus);
f7fce345 195
19befb2d 196sd_bus_slot* sd_bus_get_current_slot(sd_bus *bus);
caa82984
LP
197sd_bus_message* sd_bus_get_current_message(sd_bus *bus);
198sd_bus_message_handler_t sd_bus_get_current_handler(sd_bus *bus);
199void* sd_bus_get_current_userdata(sd_bus *bus);
affff0b6 200
40ca29a1
LP
201int sd_bus_attach_event(sd_bus *bus, sd_event *e, int priority);
202int sd_bus_detach_event(sd_bus *bus);
2be44176 203sd_event *sd_bus_get_event(sd_bus *bus);
40ca29a1 204
e0a08581
LP
205int sd_bus_get_n_queued_read(sd_bus *bus, uint64_t *ret);
206int sd_bus_get_n_queued_write(sd_bus *bus, uint64_t *ret);
207
385b2eb2
YW
208int sd_bus_set_method_call_timeout(sd_bus *bus, uint64_t usec);
209int sd_bus_get_method_call_timeout(sd_bus *bus, uint64_t *ret);
210
19befb2d
LP
211int sd_bus_add_filter(sd_bus *bus, sd_bus_slot **slot, sd_bus_message_handler_t callback, void *userdata);
212int sd_bus_add_match(sd_bus *bus, sd_bus_slot **slot, const char *match, sd_bus_message_handler_t callback, void *userdata);
7593c7a4 213int 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);
19befb2d
LP
214int sd_bus_add_object(sd_bus *bus, sd_bus_slot **slot, const char *path, sd_bus_message_handler_t callback, void *userdata);
215int sd_bus_add_fallback(sd_bus *bus, sd_bus_slot **slot, const char *prefix, sd_bus_message_handler_t callback, void *userdata);
216int 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);
217int 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);
218int sd_bus_add_node_enumerator(sd_bus *bus, sd_bus_slot **slot, const char *path, sd_bus_node_enumerator_t callback, void *userdata);
219int sd_bus_add_object_manager(sd_bus *bus, sd_bus_slot **slot, const char *path);
de1c301e 220
19befb2d 221/* Slot object */
29ddb38f 222
19befb2d
LP
223sd_bus_slot* sd_bus_slot_ref(sd_bus_slot *slot);
224sd_bus_slot* sd_bus_slot_unref(sd_bus_slot *slot);
a652755d 225
19befb2d 226sd_bus* sd_bus_slot_get_bus(sd_bus_slot *slot);
19befb2d
LP
227void *sd_bus_slot_get_userdata(sd_bus_slot *slot);
228void *sd_bus_slot_set_userdata(sd_bus_slot *slot, void *userdata);
9cbfc66c 229int sd_bus_slot_set_description(sd_bus_slot *slot, const char *description);
839b6dbb 230int sd_bus_slot_get_description(sd_bus_slot *slot, const char **description);
303acb7f
LP
231int sd_bus_slot_get_floating(sd_bus_slot *slot);
232int sd_bus_slot_set_floating(sd_bus_slot *slot, int b);
fa17b4e8
ZJS
233int sd_bus_slot_set_destroy_callback(sd_bus_slot *s, sd_bus_destroy_t callback);
234int sd_bus_slot_get_destroy_callback(sd_bus_slot *s, sd_bus_destroy_t *callback);
9cbfc66c 235
19befb2d 236sd_bus_message* sd_bus_slot_get_current_message(sd_bus_slot *slot);
caa82984
LP
237sd_bus_message_handler_t sd_bus_slot_get_current_handler(sd_bus_slot *bus);
238void *sd_bus_slot_get_current_userdata(sd_bus_slot *slot);
29ddb38f
LP
239
240/* Message object */
a4297f08 241
75bcbcf2 242int sd_bus_message_new(sd_bus *bus, sd_bus_message **m, uint8_t type);
151b9b96
LP
243int sd_bus_message_new_signal(sd_bus *bus, sd_bus_message **m, const char *path, const char *interface, const char *member);
244int 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);
df2d202e 245int sd_bus_message_new_method_return(sd_bus_message *call, sd_bus_message **m);
151b9b96 246int sd_bus_message_new_method_error(sd_bus_message *call, sd_bus_message **m, const sd_bus_error *e);
62ae7570 247int sd_bus_message_new_method_errorf(sd_bus_message *call, sd_bus_message **m, const char *name, const char *format, ...) _sd_printf_(4, 5);
151b9b96 248int sd_bus_message_new_method_errno(sd_bus_message *call, sd_bus_message **m, int error, const sd_bus_error *e);
62ae7570 249int sd_bus_message_new_method_errnof(sd_bus_message *call, sd_bus_message **m, int error, const char *format, ...) _sd_printf_(4, 5);
de1c301e
LP
250
251sd_bus_message* sd_bus_message_ref(sd_bus_message *m);
252sd_bus_message* sd_bus_message_unref(sd_bus_message *m);
253
75bcbcf2
SA
254int sd_bus_message_seal(sd_bus_message *m, uint64_t cookie, uint64_t timeout_usec);
255
de1c301e 256int sd_bus_message_get_type(sd_bus_message *m, uint8_t *type);
693eb9a2
LP
257int sd_bus_message_get_cookie(sd_bus_message *m, uint64_t *cookie);
258int sd_bus_message_get_reply_cookie(sd_bus_message *m, uint64_t *cookie);
53a83f4b
LP
259int sd_bus_message_get_priority(sd_bus_message *m, int64_t *priority);
260
eee9ec0e
LP
261int sd_bus_message_get_expect_reply(sd_bus_message *m);
262int sd_bus_message_get_auto_start(sd_bus_message *m);
53a83f4b 263int sd_bus_message_get_allow_interactive_authorization(sd_bus_message *m);
de1c301e 264
40ca29a1 265const char *sd_bus_message_get_signature(sd_bus_message *m, int complete);
de1c301e
LP
266const char *sd_bus_message_get_path(sd_bus_message *m);
267const char *sd_bus_message_get_interface(sd_bus_message *m);
268const char *sd_bus_message_get_member(sd_bus_message *m);
269const char *sd_bus_message_get_destination(sd_bus_message *m);
270const char *sd_bus_message_get_sender(sd_bus_message *m);
271const sd_bus_error *sd_bus_message_get_error(sd_bus_message *m);
40ca29a1 272int sd_bus_message_get_errno(sd_bus_message *m);
de1c301e 273
1fedcf59
LP
274int sd_bus_message_get_monotonic_usec(sd_bus_message *m, uint64_t *usec);
275int sd_bus_message_get_realtime_usec(sd_bus_message *m, uint64_t *usec);
6a0e376c
LP
276int sd_bus_message_get_seqnum(sd_bus_message *m, uint64_t* seqnum);
277
69727e6d 278sd_bus* sd_bus_message_get_bus(sd_bus_message *m);
5b12334d 279sd_bus_creds *sd_bus_message_get_creds(sd_bus_message *m); /* do not unref the result */
de1c301e
LP
280
281int sd_bus_message_is_signal(sd_bus_message *m, const char *interface, const char *member);
282int sd_bus_message_is_method_call(sd_bus_message *m, const char *interface, const char *member);
283int sd_bus_message_is_method_error(sd_bus_message *m, const char *name);
8022212b 284int sd_bus_message_is_empty(sd_bus_message *m);
64e96a19 285int sd_bus_message_has_signature(sd_bus_message *m, const char *signature);
de1c301e 286
eee9ec0e
LP
287int sd_bus_message_set_expect_reply(sd_bus_message *m, int b);
288int sd_bus_message_set_auto_start(sd_bus_message *m, int b);
53a83f4b
LP
289int sd_bus_message_set_allow_interactive_authorization(sd_bus_message *m, int b);
290
de1c301e 291int sd_bus_message_set_destination(sd_bus_message *m, const char *destination);
48ef41a3 292int sd_bus_message_set_sender(sd_bus_message *m, const char *sender);
ca7b42c8 293int sd_bus_message_set_priority(sd_bus_message *m, int64_t priority);
de1c301e
LP
294
295int sd_bus_message_append(sd_bus_message *m, const char *types, ...);
19fe49f6 296int sd_bus_message_appendv(sd_bus_message *m, const char *types, va_list ap);
de1c301e 297int sd_bus_message_append_basic(sd_bus_message *m, char type, const void *p);
f8e013f8
LP
298int sd_bus_message_append_array(sd_bus_message *m, char type, const void *ptr, size_t size);
299int sd_bus_message_append_array_space(sd_bus_message *m, char type, size_t size, void **ptr);
938bcbab 300int sd_bus_message_append_array_iovec(sd_bus_message *m, char type, const struct iovec *iov, unsigned n);
7dcd79c2 301int sd_bus_message_append_array_memfd(sd_bus_message *m, char type, int memfd, uint64_t offset, uint64_t size);
f8e013f8 302int sd_bus_message_append_string_space(sd_bus_message *m, size_t size, char **s);
938bcbab 303int sd_bus_message_append_string_iovec(sd_bus_message *m, const struct iovec *iov, unsigned n);
7dcd79c2 304int sd_bus_message_append_string_memfd(sd_bus_message *m, int memfd, uint64_t offset, uint64_t size);
55736ed0 305int sd_bus_message_append_strv(sd_bus_message *m, char **l);
de1c301e
LP
306int sd_bus_message_open_container(sd_bus_message *m, char type, const char *contents);
307int sd_bus_message_close_container(sd_bus_message *m);
c430fee6 308int sd_bus_message_copy(sd_bus_message *m, sd_bus_message *source, int all);
de1c301e 309
de1c301e 310int sd_bus_message_read(sd_bus_message *m, const char *types, ...);
11ce0db2 311int sd_bus_message_readv(sd_bus_message *m, const char *types, va_list ap);
9a17484d 312int sd_bus_message_read_basic(sd_bus_message *m, char type, void *p);
f8e013f8 313int sd_bus_message_read_array(sd_bus_message *m, char type, const void **ptr, size_t *size);
63be1989 314int sd_bus_message_read_strv(sd_bus_message *m, char ***l); /* free the result! */
9b07511d 315int sd_bus_message_skip(sd_bus_message *m, const char *types);
9a17484d
LP
316int sd_bus_message_enter_container(sd_bus_message *m, char type, const char *contents);
317int sd_bus_message_exit_container(sd_bus_message *m);
318int sd_bus_message_peek_type(sd_bus_message *m, char *type, const char **contents);
c430fee6 319int sd_bus_message_verify_type(sd_bus_message *m, char type, const char *contents);
7b058942 320int sd_bus_message_at_end(sd_bus_message *m, int complete);
89ffcd2a 321int sd_bus_message_rewind(sd_bus_message *m, int complete);
de1c301e 322
5b12334d
LP
323/* Bus management */
324
325int sd_bus_get_unique_name(sd_bus *bus, const char **unique);
29a07cdb 326int sd_bus_request_name(sd_bus *bus, const char *name, uint64_t flags);
98c5bbc8 327int 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);
5b12334d 328int sd_bus_release_name(sd_bus *bus, const char *name);
98c5bbc8 329int sd_bus_release_name_async(sd_bus *bus, sd_bus_slot **ret_slot, const char *name, sd_bus_message_handler_t callback, void *userdata);
71f2ab46 330int sd_bus_list_names(sd_bus *bus, char ***acquired, char ***activatable); /* free the results */
056f95d0
DM
331int sd_bus_get_name_creds(sd_bus *bus, const char *name, uint64_t mask, sd_bus_creds **creds); /* unref the result! */
332int sd_bus_get_name_machine_id(sd_bus *bus, const char *name, sd_id128_t *machine);
5b12334d 333
917b5dc7
LP
334/* Convenience calls */
335
ebcf1f97 336int 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, ...);
5d941c92 337int 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, ...);
ebcf1f97
LP
338int 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);
339int 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);
340int 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! */
341int 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! */
882897af 342int 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, ...);
911121a7 343
df2d202e
LP
344int sd_bus_reply_method_return(sd_bus_message *call, const char *types, ...);
345int sd_bus_reply_method_error(sd_bus_message *call, const sd_bus_error *e);
62ae7570 346int sd_bus_reply_method_errorf(sd_bus_message *call, const char *name, const char *format, ...) _sd_printf_(3, 4);
df2d202e 347int sd_bus_reply_method_errno(sd_bus_message *call, int error, const sd_bus_error *e);
62ae7570 348int sd_bus_reply_method_errnof(sd_bus_message *call, int error, const char *format, ...) _sd_printf_(3, 4);
29ddb38f
LP
349
350int sd_bus_emit_signal(sd_bus *bus, const char *path, const char *interface, const char *member, const char *types, ...);
351
352int sd_bus_emit_properties_changed_strv(sd_bus *bus, const char *path, const char *interface, char **names);
aacf3b48 353int sd_bus_emit_properties_changed(sd_bus *bus, const char *path, const char *interface, const char *name, ...) _sd_sentinel_;
29ddb38f 354
d95eb43e
DH
355int sd_bus_emit_object_added(sd_bus *bus, const char *path);
356int sd_bus_emit_object_removed(sd_bus *bus, const char *path);
4be39163 357int sd_bus_emit_interfaces_added_strv(sd_bus *bus, const char *path, char **interfaces);
aacf3b48 358int sd_bus_emit_interfaces_added(sd_bus *bus, const char *path, const char *interface, ...) _sd_sentinel_;
4be39163 359int sd_bus_emit_interfaces_removed_strv(sd_bus *bus, const char *path, char **interfaces);
aacf3b48 360int sd_bus_emit_interfaces_removed(sd_bus *bus, const char *path, const char *interface, ...) _sd_sentinel_;
917b5dc7 361
5b12334d 362int sd_bus_query_sender_creds(sd_bus_message *call, uint64_t mask, sd_bus_creds **creds);
def9a7aa 363int sd_bus_query_sender_privilege(sd_bus_message *call, int capability);
5b12334d 364
b423e4fb
LP
365int 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);
366int 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);
367
5b12334d
LP
368/* Credential handling */
369
151b9b96 370int sd_bus_creds_new_from_pid(sd_bus_creds **ret, pid_t pid, uint64_t creds_mask);
5b12334d
LP
371sd_bus_creds *sd_bus_creds_ref(sd_bus_creds *c);
372sd_bus_creds *sd_bus_creds_unref(sd_bus_creds *c);
4cf8496d 373uint64_t sd_bus_creds_get_mask(const sd_bus_creds *c);
0f514420 374uint64_t sd_bus_creds_get_augmented_mask(const sd_bus_creds *c);
5b12334d 375
5b12334d 376int sd_bus_creds_get_pid(sd_bus_creds *c, pid_t *pid);
1386e47d 377int sd_bus_creds_get_ppid(sd_bus_creds *c, pid_t *ppid);
5b12334d 378int sd_bus_creds_get_tid(sd_bus_creds *c, pid_t *tid);
49b832c5 379int sd_bus_creds_get_uid(sd_bus_creds *c, uid_t *uid);
705a415f
LP
380int sd_bus_creds_get_euid(sd_bus_creds *c, uid_t *euid);
381int sd_bus_creds_get_suid(sd_bus_creds *c, uid_t *suid);
382int sd_bus_creds_get_fsuid(sd_bus_creds *c, uid_t *fsuid);
49b832c5 383int sd_bus_creds_get_gid(sd_bus_creds *c, gid_t *gid);
705a415f
LP
384int sd_bus_creds_get_egid(sd_bus_creds *c, gid_t *egid);
385int sd_bus_creds_get_sgid(sd_bus_creds *c, gid_t *sgid);
386int sd_bus_creds_get_fsgid(sd_bus_creds *c, gid_t *fsgid);
02581590 387int sd_bus_creds_get_supplementary_gids(sd_bus_creds *c, const gid_t **gids);
cd6d5e1c
ZJS
388int sd_bus_creds_get_comm(sd_bus_creds *c, const char **comm);
389int sd_bus_creds_get_tid_comm(sd_bus_creds *c, const char **comm);
390int sd_bus_creds_get_exe(sd_bus_creds *c, const char **exe);
5b12334d 391int sd_bus_creds_get_cmdline(sd_bus_creds *c, char ***cmdline);
cd6d5e1c 392int sd_bus_creds_get_cgroup(sd_bus_creds *c, const char **cgroup);
5b12334d 393int sd_bus_creds_get_unit(sd_bus_creds *c, const char **unit);
5b12334d 394int sd_bus_creds_get_slice(sd_bus_creds *c, const char **slice);
329ac4bc
LP
395int sd_bus_creds_get_user_unit(sd_bus_creds *c, const char **unit);
396int sd_bus_creds_get_user_slice(sd_bus_creds *c, const char **slice);
5b12334d
LP
397int sd_bus_creds_get_session(sd_bus_creds *c, const char **session);
398int sd_bus_creds_get_owner_uid(sd_bus_creds *c, uid_t *uid);
399int sd_bus_creds_has_effective_cap(sd_bus_creds *c, int capability);
400int sd_bus_creds_has_permitted_cap(sd_bus_creds *c, int capability);
401int sd_bus_creds_has_inheritable_cap(sd_bus_creds *c, int capability);
402int sd_bus_creds_has_bounding_cap(sd_bus_creds *c, int capability);
cd6d5e1c 403int sd_bus_creds_get_selinux_context(sd_bus_creds *c, const char **context);
5b12334d
LP
404int sd_bus_creds_get_audit_session_id(sd_bus_creds *c, uint32_t *sessionid);
405int sd_bus_creds_get_audit_login_uid(sd_bus_creds *c, uid_t *loginuid);
4761e880 406int sd_bus_creds_get_tty(sd_bus_creds *c, const char **tty);
49b832c5
LP
407int sd_bus_creds_get_unique_name(sd_bus_creds *c, const char **name);
408int sd_bus_creds_get_well_known_names(sd_bus_creds *c, char ***names);
455971c1 409int sd_bus_creds_get_description(sd_bus_creds *c, const char **name);
de1c301e 410
fbfa72b0 411/* Error structures */
de1c301e 412
442e2def 413#define SD_BUS_ERROR_MAKE_CONST(name, message) ((const sd_bus_error) {(name), (message), 0})
14c24659 414#define SD_BUS_ERROR_NULL SD_BUS_ERROR_MAKE_CONST(NULL, NULL)
fedfcdee 415
de1c301e 416void sd_bus_error_free(sd_bus_error *e);
29ddb38f 417int sd_bus_error_set(sd_bus_error *e, const char *name, const char *message);
62ae7570 418int sd_bus_error_setf(sd_bus_error *e, const char *name, const char *format, ...) _sd_printf_(3, 4);
40ca29a1
LP
419int sd_bus_error_set_const(sd_bus_error *e, const char *name, const char *message);
420int sd_bus_error_set_errno(sd_bus_error *e, int error);
62ae7570 421int sd_bus_error_set_errnof(sd_bus_error *e, int error, const char *format, ...) _sd_printf_(3, 4);
83e44331 422int sd_bus_error_set_errnofv(sd_bus_error *e, int error, const char *format, va_list ap) _sd_printf_(3,0);
40ca29a1 423int sd_bus_error_get_errno(const sd_bus_error *e);
de1c301e
LP
424int sd_bus_error_copy(sd_bus_error *dest, const sd_bus_error *e);
425int sd_bus_error_is_set(const sd_bus_error *e);
426int sd_bus_error_has_name(const sd_bus_error *e, const char *name);
427
5f86c1f4
LP
428#define SD_BUS_ERROR_MAP(_name, _code) \
429 { \
430 .name = _name, \
431 .code = _code, \
432 }
433#define SD_BUS_ERROR_MAP_END \
434 { \
435 .name = NULL, \
436 .code = - 'x', \
437 }
438
439int sd_bus_error_add_map(const sd_bus_error_map *map);
440
5b12334d
LP
441/* Auxiliary macros */
442
40ca29a1
LP
443#define SD_BUS_MESSAGE_APPEND_ID128(x) 16, \
444 (x).bytes[0], (x).bytes[1], (x).bytes[2], (x).bytes[3], \
445 (x).bytes[4], (x).bytes[5], (x).bytes[6], (x).bytes[7], \
9444b1f2
LP
446 (x).bytes[8], (x).bytes[9], (x).bytes[10], (x).bytes[11], \
447 (x).bytes[12], (x).bytes[13], (x).bytes[14], (x).bytes[15]
448
29f8d1f2
LP
449#define SD_BUS_MESSAGE_READ_ID128(x) 16, \
450 &(x).bytes[0], &(x).bytes[1], &(x).bytes[2], &(x).bytes[3], \
451 &(x).bytes[4], &(x).bytes[5], &(x).bytes[6], &(x).bytes[7], \
452 &(x).bytes[8], &(x).bytes[9], &(x).bytes[10], &(x).bytes[11], \
453 &(x).bytes[12], &(x).bytes[13], &(x).bytes[14], &(x).bytes[15]
454
5b12334d
LP
455/* Label escaping */
456
a6278b88 457int sd_bus_path_encode(const char *prefix, const char *external_id, char **ret_path);
dfb815c3 458int sd_bus_path_encode_many(char **out, const char *path_template, ...);
a6278b88 459int sd_bus_path_decode(const char *path, const char *prefix, char **ret_external_id);
dfb815c3 460int sd_bus_path_decode_many(const char *path, const char *path_template, ...);
28383ba1 461
8f8f05a9
LP
462/* Tracking peers */
463
464int sd_bus_track_new(sd_bus *bus, sd_bus_track **track, sd_bus_track_handler_t handler, void *userdata);
465sd_bus_track* sd_bus_track_ref(sd_bus_track *track);
466sd_bus_track* sd_bus_track_unref(sd_bus_track *track);
04552566 467
8f8f05a9 468sd_bus* sd_bus_track_get_bus(sd_bus_track *track);
04552566
LP
469void *sd_bus_track_get_userdata(sd_bus_track *track);
470void *sd_bus_track_set_userdata(sd_bus_track *track, void *userdata);
8f8f05a9
LP
471
472int sd_bus_track_add_sender(sd_bus_track *track, sd_bus_message *m);
473int sd_bus_track_remove_sender(sd_bus_track *track, sd_bus_message *m);
474int sd_bus_track_add_name(sd_bus_track *track, const char *name);
475int sd_bus_track_remove_name(sd_bus_track *track, const char *name);
476
ae1a2efa
LP
477int sd_bus_track_set_recursive(sd_bus_track *track, int b);
478int sd_bus_track_get_recursive(sd_bus_track *track);
479
8f8f05a9 480unsigned sd_bus_track_count(sd_bus_track *track);
ae1a2efa
LP
481int sd_bus_track_count_sender(sd_bus_track *track, sd_bus_message *m);
482int sd_bus_track_count_name(sd_bus_track *track, const char *name);
483
484const char* sd_bus_track_contains(sd_bus_track *track, const char *name);
8f8f05a9
LP
485const char* sd_bus_track_first(sd_bus_track *track);
486const char* sd_bus_track_next(sd_bus_track *track);
487
66223497
LP
488int sd_bus_track_set_destroy_callback(sd_bus_track *s, sd_bus_destroy_t callback);
489int sd_bus_track_get_destroy_callback(sd_bus_track *s, sd_bus_destroy_t *ret);
490
4afd3348
LP
491/* Define helpers so that __attribute__((cleanup(sd_bus_unrefp))) and similar may be used. */
492_SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus, sd_bus_unref);
493_SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus, sd_bus_flush_close_unref);
494_SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus_slot, sd_bus_slot_unref);
495_SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus_message, sd_bus_message_unref);
496_SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus_creds, sd_bus_creds_unref);
497_SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus_track, sd_bus_track_unref);
498
0095c454 499_SD_END_DECLARATIONS;
b29b8bc2 500
de1c301e 501#endif