2 <!DOCTYPE refentry PUBLIC
"-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
4 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
6 <refentry id=
"sd-bus" xmlns:
xi=
"http://www.w3.org/2001/XInclude">
10 <productname>systemd
</productname>
14 <refentrytitle>sd-bus
</refentrytitle>
15 <manvolnum>3</manvolnum>
19 <refname>sd-bus
</refname>
20 <refpurpose>A lightweight D-Bus IPC client library
</refpurpose>
25 <funcsynopsisinfo>#include
<systemd/sd-bus.h
></funcsynopsisinfo>
29 <command>pkg-config --cflags --libs libsystemd
</command>
35 <title>Description
</title>
37 <para><filename>sd-bus.h
</filename> is part of
38 <citerefentry><refentrytitle>libsystemd
</refentrytitle><manvolnum>3</manvolnum></citerefentry> and
39 provides an implementation of a D-Bus IPC client. See
40 <ulink url=
"https://www.freedesktop.org/software/dbus/" />
41 for more information about D-Bus IPC.
</para>
45 <member><citerefentry><refentrytitle>sd_bus_add_match
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
46 <member><citerefentry><refentrytitle>sd_bus_add_object
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
47 <member><citerefentry><refentrytitle>sd_bus_add_object_manager
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
48 <member><citerefentry><refentrytitle>sd_bus_add_object_vtable
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
49 <member><citerefentry><refentrytitle>sd_bus_add_fallback
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
50 <member><citerefentry><refentrytitle>sd_bus_add_fallback_vtable
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
51 <member><citerefentry><refentrytitle>sd_bus_add_filter
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
52 <member><citerefentry><refentrytitle>sd_bus_add_node_enumerator
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
53 <member><citerefentry><refentrytitle>sd_bus_attach_event
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
54 <member><citerefentry><refentrytitle>sd_bus_call
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
55 <member><citerefentry><refentrytitle>sd_bus_call_async
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
56 <member><citerefentry><refentrytitle>sd_bus_call_method
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
57 <member><citerefentry><refentrytitle>sd_bus_call_method_async
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
58 <member><citerefentry><refentrytitle>sd_bus_can_send
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
59 <member><citerefentry><refentrytitle>sd_bus_close
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
60 <member><citerefentry><refentrytitle>sd_bus_creds_get_pid
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
61 <member><citerefentry><refentrytitle>sd_bus_creds_new_from_pid
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
62 <member><citerefentry><refentrytitle>sd_bus_default
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
63 <member><citerefentry><refentrytitle>sd_bus_emit_interfaces_added
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
64 <member><citerefentry><refentrytitle>sd_bus_emit_interfaces_added_strv
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
65 <member><citerefentry><refentrytitle>sd_bus_emit_interfaces_removed
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
66 <member><citerefentry><refentrytitle>sd_bus_emit_interfaces_removed_strv
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
67 <member><citerefentry><refentrytitle>sd_bus_emit_object_added
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
68 <member><citerefentry><refentrytitle>sd_bus_emit_object_removed
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
69 <member><citerefentry><refentrytitle>sd_bus_emit_properties_changed
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
70 <member><citerefentry><refentrytitle>sd_bus_emit_properties_changed_strv
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
71 <member><citerefentry><refentrytitle>sd_bus_emit_signal
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
72 <member><citerefentry><refentrytitle>sd_bus_emit_signalv
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
73 <member><citerefentry><refentrytitle>sd_bus_emit_signal_to
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
74 <member><citerefentry><refentrytitle>sd_bus_emit_signal_tov
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
75 <member><citerefentry><refentrytitle>sd-bus-errors
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
76 <member><citerefentry><refentrytitle>sd_bus_error
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
77 <member><citerefentry><refentrytitle>sd_bus_error_add_map
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
78 <member><citerefentry><refentrytitle>sd_bus_get_address
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
79 <member><citerefentry><refentrytitle>sd_bus_get_allow_interactive_authorization
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
80 <member><citerefentry><refentrytitle>sd_bus_get_bus_id
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
81 <member><citerefentry><refentrytitle>sd_bus_get_creds_mask
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
82 <member><citerefentry><refentrytitle>sd_bus_get_current_handler
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
83 <member><citerefentry><refentrytitle>sd_bus_get_current_message
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
84 <member><citerefentry><refentrytitle>sd_bus_get_current_slot
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
85 <member><citerefentry><refentrytitle>sd_bus_get_current_userdata
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
86 <member><citerefentry><refentrytitle>sd_bus_get_exit_on_disconnect
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
87 <member><citerefentry><refentrytitle>sd_bus_get_fd
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
88 <member><citerefentry><refentrytitle>sd_bus_get_method_call_timeout
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
89 <member><citerefentry><refentrytitle>sd_bus_get_n_queued_read
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
90 <member><citerefentry><refentrytitle>sd_bus_get_name_creds
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
91 <member><citerefentry><refentrytitle>sd_bus_get_name_machine_id
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
92 <member><citerefentry><refentrytitle>sd_bus_get_owner_creds
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
93 <member><citerefentry><refentrytitle>sd_bus_get_property
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
94 <member><citerefentry><refentrytitle>sd_bus_get_property_string
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
95 <member><citerefentry><refentrytitle>sd_bus_get_property_strv
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
96 <member><citerefentry><refentrytitle>sd_bus_get_property_trivial
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
97 <member><citerefentry><refentrytitle>sd_bus_get_scope
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
98 <member><citerefentry><refentrytitle>sd_bus_get_tid
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
99 <member><citerefentry><refentrytitle>sd_bus_get_unique_name
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
100 <member><citerefentry><refentrytitle>sd_bus_interface_name_is_valid
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
101 <member><citerefentry><refentrytitle>sd_bus_is_bus_client
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
102 <member><citerefentry><refentrytitle>sd_bus_is_monitor
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
103 <member><citerefentry><refentrytitle>sd_bus_is_server
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
104 <member><citerefentry><refentrytitle>sd_bus_list_names
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
105 <member><citerefentry><refentrytitle>sd_bus_message_append
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
106 <member><citerefentry><refentrytitle>sd_bus_message_append_array
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
107 <member><citerefentry><refentrytitle>sd_bus_message_append_basic
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
108 <member><citerefentry><refentrytitle>sd_bus_message_append_string_memfd
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
109 <member><citerefentry><refentrytitle>sd_bus_message_append_strv
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
110 <member><citerefentry><refentrytitle>sd_bus_message_at_end
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
111 <member><citerefentry><refentrytitle>sd_bus_message_close_container
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
112 <member><citerefentry><refentrytitle>sd_bus_message_copy
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
113 <member><citerefentry><refentrytitle>sd_bus_message_dump
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
114 <member><citerefentry><refentrytitle>sd_bus_message_enter_container
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
115 <member><citerefentry><refentrytitle>sd_bus_message_exit_container
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
116 <member><citerefentry><refentrytitle>sd_bus_message_get_allow_interactive_authorization
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
117 <member><citerefentry><refentrytitle>sd_bus_message_get_cookie
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
118 <member><citerefentry><refentrytitle>sd_bus_message_get_creds
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
119 <member><citerefentry><refentrytitle>sd_bus_message_get_errno
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
120 <member><citerefentry><refentrytitle>sd_bus_message_get_error
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
121 <member><citerefentry><refentrytitle>sd_bus_message_get_monotonic_usec
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
122 <member><citerefentry><refentrytitle>sd_bus_message_get_sender
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
123 <member><citerefentry><refentrytitle>sd_bus_message_get_signature
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
124 <member><citerefentry><refentrytitle>sd_bus_message_get_type
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
125 <member><citerefentry><refentrytitle>sd_bus_message_new
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
126 <member><citerefentry><refentrytitle>sd_bus_message_new_method_call
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
127 <member><citerefentry><refentrytitle>sd_bus_message_new_method_error
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
128 <member><citerefentry><refentrytitle>sd_bus_message_new_signal
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
129 <member><citerefentry><refentrytitle>sd_bus_message_new_signal_to
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
130 <member><citerefentry><refentrytitle>sd_bus_message_open_container
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
131 <member><citerefentry><refentrytitle>sd_bus_message_peek_type
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
132 <member><citerefentry><refentrytitle>sd_bus_message_read
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
133 <member><citerefentry><refentrytitle>sd_bus_message_read_array
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
134 <member><citerefentry><refentrytitle>sd_bus_message_read_basic
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
135 <member><citerefentry><refentrytitle>sd_bus_message_read_strv
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
136 <member><citerefentry><refentrytitle>sd_bus_message_rewind
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
137 <member><citerefentry><refentrytitle>sd_bus_message_seal
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
138 <member><citerefentry><refentrytitle>sd_bus_message_send
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
139 <member><citerefentry><refentrytitle>sd_bus_message_set_allow_interactive_authorization
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
140 <member><citerefentry><refentrytitle>sd_bus_message_set_destination
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
141 <member><citerefentry><refentrytitle>sd_bus_message_set_expect_reply
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
142 <member><citerefentry><refentrytitle>sd_bus_message_set_sender
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
143 <member><citerefentry><refentrytitle>sd_bus_message_skip
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
144 <member><citerefentry><refentrytitle>sd_bus_message_verify_type
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
145 <member><citerefentry><refentrytitle>sd_bus_negotiate_fds
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
146 <member><citerefentry><refentrytitle>sd_bus_new
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
147 <member><citerefentry><refentrytitle>sd_bus_path_encode
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
148 <member><citerefentry><refentrytitle>sd_bus_process
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
149 <member><citerefentry><refentrytitle>sd_bus_query_sender_creds
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
150 <member><citerefentry><refentrytitle>sd_bus_query_sender_privilege
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
151 <member><citerefentry><refentrytitle>sd_bus_reply_method_error
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
152 <member><citerefentry><refentrytitle>sd_bus_reply_method_return
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
153 <member><citerefentry><refentrytitle>sd_bus_request_name
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
154 <member><citerefentry><refentrytitle>sd_bus_send
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
155 <member><citerefentry><refentrytitle>sd_bus_send_to
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
156 <member><citerefentry><refentrytitle>sd_bus_set_address
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
157 <member><citerefentry><refentrytitle>sd_bus_set_allow_interactive_authorization
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
158 <member><citerefentry><refentrytitle>sd_bus_set_bus_client
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
159 <member><citerefentry><refentrytitle>sd_bus_set_close_on_exit
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
160 <member><citerefentry><refentrytitle>sd_bus_set_connected_signal
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
161 <member><citerefentry><refentrytitle>sd_bus_set_description
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
162 <member><citerefentry><refentrytitle>sd_bus_set_exit_on_disconnect
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
163 <member><citerefentry><refentrytitle>sd_bus_set_method_call_timeout
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
164 <member><citerefentry><refentrytitle>sd_bus_set_monitor
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
165 <member><citerefentry><refentrytitle>sd_bus_set_property
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
166 <member><citerefentry><refentrytitle>sd_bus_set_propertyv
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
167 <member><citerefentry><refentrytitle>sd_bus_set_sender
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
168 <member><citerefentry><refentrytitle>sd_bus_set_server
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
169 <member><citerefentry><refentrytitle>sd_bus_set_watch_bind
</refentrytitle><manvolnum>3</manvolnum></citerefentry></member>
170 <member><citerefentry><refentrytitle>sd_bus_slot_get_current_handler
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
171 <member><citerefentry><refentrytitle>sd_bus_slot_get_current_message
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
172 <member><citerefentry><refentrytitle>sd_bus_slot_get_current_userdata
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
173 <member><citerefentry><refentrytitle>sd_bus_slot_set_description
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
174 <member><citerefentry><refentrytitle>sd_bus_slot_set_destroy_callback
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
175 <member><citerefentry><refentrytitle>sd_bus_slot_set_floating
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
176 <member><citerefentry><refentrytitle>sd_bus_slot_set_userdata
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
177 <member><citerefentry><refentrytitle>sd_bus_start
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
178 <member><citerefentry><refentrytitle>sd_bus_track_add_name
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
</member>
179 <member><citerefentry><refentrytitle>sd_bus_track_new
</refentrytitle><manvolnum>3</manvolnum></citerefentry></member>
181 for more information about the functions available.
</para>
184 <xi:include href=
"libsystemd-pkgconfig.xml" />
187 <title>See Also
</title>
188 <para><simplelist type=
"inline">
189 <member><citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
190 <member><citerefentry><refentrytitle>sd-event
</refentrytitle><manvolnum>3</manvolnum></citerefentry></member>
191 <member><citerefentry><refentrytitle>busctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
192 <member><citerefentry project='man-pages'
><refentrytitle>dbus-daemon
</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
193 <member><citerefentry project='man-pages'
><refentrytitle>dbus-send
</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>