sd-bus(3) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | NOTES | SEE ALSO | COLOPHON

SD-BUS(3)                          sd-bus                          SD-BUS(3)

NAME         top

       sd-bus - A lightweight D-Bus IPC client library

SYNOPSIS         top

       #include <systemd/sd-bus.h>

       pkg-config --cflags --libs libsystemd

DESCRIPTION         top

       sd-bus.h provides an implementation of a D-Bus IPC client. See
       https://www.freedesktop.org/software/dbus/ for more information about
       D-Bus IPC.

       See

           sd_bus_add_match(3),
           sd_bus_add_object(3),
           sd_bus_add_object_manager(3),
           sd_bus_add_object_vtable(3),
           sd_bus_add_fallback(3),
           sd_bus_add_fallback_vtable(3),
           sd_bus_add_filter(3),
           sd_bus_add_node_enumerator(3),
           sd_bus_attach_event(3),
           sd_bus_call(3),
           sd_bus_call_async(3),
           sd_bus_call_method(3),
           sd_bus_call_method_async(3),
           sd_bus_can_send(3),
           sd_bus_creds_get_pid(3),
           sd_bus_creds_new_from_pid(3),
           sd_bus_close(3),
           sd_bus_default(3),
           sd_bus_emit_interfaces_added(3),
           sd_bus_emit_interfaces_added_strv(3),
           sd_bus_emit_interfaces_removed(3),
           sd_bus_emit_interfaces_removed_strv(3),
           sd_bus_emit_object_added(3),
           sd_bus_emit_object_removed(3),
           sd_bus_emit_properties_changed(3),
           sd_bus_emit_properties_changed_strv(3),
           sd_bus_emit_signal(3),
           sd_bus_emit_signalv(3),
           sd-bus-errors(3),
           sd_bus_error(3),
           sd_bus_error_add_map(3),
           sd_bus_get_address(3),
           sd_bus_get_allow_interactive_authorization(3),
           sd_bus_get_bus_id(3),
           sd_bus_get_creds_mask(3),
           sd_bus_get_current_handler(3),
           sd_bus_get_current_message(3),
           sd_bus_get_current_slot(3),
           sd_bus_get_current_userdata(3),
           sd_bus_get_exit_on_disconnect(3),
           sd_bus_get_fd(3),
           sd_bus_get_method_call_timeout(3),
           sd_bus_get_n_queued_read(3),
           sd_bus_get_name_machine_id(3),
           sd_bus_get_name_creds(3),
           sd_bus_get_owner_creds(3),
           sd_bus_get_property(3),
           sd_bus_get_property_trivial(3),
           sd_bus_get_property_string(3),
           sd_bus_get_property_strv(3),
           sd_bus_get_scope(3),
           sd_bus_get_tid(3),
           sd_bus_get_unique_name(3),
           sd_bus_interface_name_is_valid(3),
           sd_bus_is_monitor(3),
           sd_bus_is_bus_client(3),
           sd_bus_is_server(3),
           sd_bus_list_names(3),
           sd_bus_message_append(3),
           sd_bus_message_append_array(3),
           sd_bus_message_append_basic(3),
           sd_bus_message_append_string_memfd(3),
           sd_bus_message_append_strv(3),
           sd_bus_message_at_end(3),
           sd_bus_message_close_container(3),
           sd_bus_message_copy(3),
           sd_bus_message_dump(3),
           sd_bus_message_enter_container(3),
           sd_bus_message_exit_container(3),
           sd_bus_message_get_allow_interactive_authorization(3),
           sd_bus_message_get_cookie(3),
           sd_bus_message_get_creds(3),
           sd_bus_message_get_errno(3),
           sd_bus_message_get_error(3),
           sd_bus_message_get_monotonic_usec(3),
           sd_bus_message_get_sender(3),
           sd_bus_message_get_signature(3),
           sd_bus_message_get_type(3),
           sd_bus_message_new(3),
           sd_bus_message_new_method_call(3),
           sd_bus_message_new_method_error(3),
           sd_bus_message_new_signal(3),
           sd_bus_message_open_container(3),
           sd_bus_message_peek_type(3),
           sd_bus_message_read(3),
           sd_bus_message_read_array(3),
           sd_bus_message_read_basic(3),
           sd_bus_message_read_strv(3),
           sd_bus_message_rewind(3),
           sd_bus_message_seal(3),
           sd_bus_message_set_allow_interactive_authorization(3),
           sd_bus_message_set_destination(3),
           sd_bus_message_set_sender(3),
           sd_bus_message_set_expect_reply(3),
           sd_bus_message_skip(3),
           sd_bus_message_verify_type(3),
           sd_bus_negotiate_fds(3),
           sd_bus_new(3),
           sd_bus_path_encode(3),
           sd_bus_process(3),
           sd_bus_query_sender_creds(3),
           sd_bus_query_sender_privilege(3),
           sd_bus_reply_method_return(3),
           sd_bus_reply_method_error(3),
           sd_bus_request_name(3),
           sd_bus_send(3),
           sd_bus_send_to(3),
           sd_bus_set_address(3),
           sd_bus_set_allow_interactive_authorization(3),
           sd_bus_set_bus_client(3),
           sd_bus_set_close_on_exit(3),
           sd_bus_set_connected_signal(3),
           sd_bus_set_description(3),
           sd_bus_set_exit_on_disconnect(3),
           sd_bus_set_method_call_timeout(3),
           sd_bus_set_monitor(3),
           sd_bus_set_property(3),
           sd_bus_set_propertyv(3),
           sd_bus_set_sender(3),
           sd_bus_set_server(3),
           sd_bus_set_watch_bind(3)
           sd_bus_slot_get_current_handler(3),
           sd_bus_slot_get_current_message(3),
           sd_bus_slot_get_current_userdata(3),
           sd_bus_slot_set_description(3),
           sd_bus_slot_set_destroy_callback(3),
           sd_bus_slot_set_floating(3),
           sd_bus_slot_set_userdata(3),
           sd_bus_start(3),
           sd_bus_track_add_name(3),
           sd_bus_track_new(3)

       for more information about the functions available.

NOTES         top

       These APIs are implemented as a shared library, which can be compiled
       and linked to with the libsystemd pkg-config(1) file.

SEE ALSO         top

       systemd(1), sd-event(3), busctl(1), dbus-daemon(1), dbus-send(1)

COLOPHON         top

       This page is part of the systemd (systemd system and service manager)
       project.  Information about the project can be found at 
       ⟨http://www.freedesktop.org/wiki/Software/systemd⟩.  If you have a bug
       report for this manual page, see
       ⟨http://www.freedesktop.org/wiki/Software/systemd/#bugreports⟩.  This
       page was obtained from the project's upstream Git repository
       ⟨https://github.com/systemd/systemd.git⟩ on 2020-08-13.  (At that
       time, the date of the most recent commit that was found in the repos‐
       itory was 2020-08-11.)  If you discover any rendering problems in
       this HTML version of the page, or you believe there is a better or
       more up-to-date source for the page, or you have corrections or
       improvements to the information in this COLOPHON (which is not part
       of the original manual page), send a mail to man-pages@man7.org

systemd 246                                                        SD-BUS(3)

Pages that refer to this page: busctl(1)sd_bus_add_fallback(3)sd_bus_add_fallback_vtable(3)sd_bus_add_filter(3)sd_bus_add_match(3)sd_bus_add_match_async(3)sd_bus_add_node_enumerator(3)sd_bus_add_object(3)sd_bus_add_object_manager(3)sd_bus_add_object_vtable(3)sd_bus_attach_event(3)sd_bus_call(3)sd_bus_call_async(3)sd_bus_call_method(3)sd_bus_call_method_async(3)sd_bus_call_method_asyncv(3)sd_bus_call_methodv(3)sd_bus_can_send(3)sd_bus_close(3)sd_bus_close_unref(3)sd_bus_close_unrefp(3)sd_bus_creds_get_audit_login_uid(3)sd_bus_creds_get_audit_session_id(3)sd_bus_creds_get_augmented_mask(3)sd_bus_creds_get_cgroup(3)sd_bus_creds_get_cmdline(3)sd_bus_creds_get_comm(3)sd_bus_creds_get_description(3)sd_bus_creds_get_egid(3)sd_bus_creds_get_euid(3)sd_bus_creds_get_exe(3)sd_bus_creds_get_fsgid(3)sd_bus_creds_get_fsuid(3)sd_bus_creds_get_gid(3)sd_bus_creds_get_mask(3)sd_bus_creds_get_owner_uid(3)sd_bus_creds_get_pid(3)sd_bus_creds_get_ppid(3)sd_bus_creds_get_selinux_context(3)sd_bus_creds_get_session(3)sd_bus_creds_get_sgid(3)sd_bus_creds_get_slice(3)sd_bus_creds_get_suid(3)sd_bus_creds_get_supplementary_gids(3)sd_bus_creds_get_tid(3)sd_bus_creds_get_tid_comm(3)sd_bus_creds_get_tty(3)sd_bus_creds_get_uid(3)sd_bus_creds_get_unique_name(3)sd_bus_creds_get_unit(3)sd_bus_creds_get_user_slice(3)sd_bus_creds_get_user_unit(3)sd_bus_creds_get_well_known_names(3)sd_bus_creds_has_bounding_cap(3)sd_bus_creds_has_effective_cap(3)sd_bus_creds_has_inheritable_cap(3)sd_bus_creds_has_permitted_cap(3)sd_bus_creds_new_from_pid(3)sd_bus_creds_ref(3)sd_bus_creds_unref(3)sd_bus_creds_unrefp(3)sd_bus_default(3)sd_bus_default_flush_close(3)sd_bus_default_system(3)sd_bus_default_user(3)sd_bus_destroy_t(3)sd_bus_detach_event(3)sd_bus_emit_interfaces_added(3)sd_bus_emit_interfaces_added_strv(3)sd_bus_emit_interfaces_removed(3)sd_bus_emit_interfaces_removed_strv(3)sd_bus_emit_object_added(3)sd_bus_emit_object_removed(3)sd_bus_emit_properties_changed(3)sd_bus_emit_properties_changed_strv(3)sd_bus_emit_signal(3)sd_bus_emit_signalv(3)sd_bus_enqueue_for_read(3)sd_bus_error(3)sd_bus_error_access_denied(3)SD_BUS_ERROR_ACCESS_DENIED(3)sd_bus_error_add_map(3)sd_bus_error_address_in_use(3)SD_BUS_ERROR_ADDRESS_IN_USE(3)sd_bus_error_auth_failed(3)SD_BUS_ERROR_AUTH_FAILED(3)sd_bus_error_bad_address(3)SD_BUS_ERROR_BAD_ADDRESS(3)sd_bus_error_copy(3)sd_bus_error_disconnected(3)SD_BUS_ERROR_DISCONNECTED(3)sd_bus_error_end(3)SD_BUS_ERROR_END(3)sd_bus_error_failed(3)SD_BUS_ERROR_FAILED(3)sd_bus_error_file_exists(3)SD_BUS_ERROR_FILE_EXISTS(3)sd_bus_error_file_not_found(3)SD_BUS_ERROR_FILE_NOT_FOUND(3)sd_bus_error_free(3)sd_bus_error_get_errno(3)sd_bus_error_has_name(3)sd_bus_error_inconsistent_message(3)SD_BUS_ERROR_INCONSISTENT_MESSAGE(3)sd_bus_error_interactive_authorization_required(3)SD_BUS_ERROR_INTERACTIVE_AUTHORIZATION_REQUIRED(3)sd_bus_error_invalid_args(3)SD_BUS_ERROR_INVALID_ARGS(3)sd_bus_error_invalid_signature(3)SD_BUS_ERROR_INVALID_SIGNATURE(3)sd_bus_error_io_error(3)SD_BUS_ERROR_IO_ERROR(3)sd_bus_error_is_set(3)sd_bus_error_limits_exceeded(3)SD_BUS_ERROR_LIMITS_EXCEEDED(3)sd_bus_error_make_const(3)SD_BUS_ERROR_MAKE_CONST(3)sd_bus_error_map(3)SD_BUS_ERROR_MAP(3)sd_bus_error_match_rule_invalid(3)SD_BUS_ERROR_MATCH_RULE_INVALID(3)sd_bus_error_match_rule_not_found(3)SD_BUS_ERROR_MATCH_RULE_NOT_FOUND(3)sd_bus_error_move(3)sd_bus_error_name_has_no_owner(3)SD_BUS_ERROR_NAME_HAS_NO_OWNER(3)sd_bus_error_no_memory(3)SD_BUS_ERROR_NO_MEMORY(3)sd_bus_error_no_network(3)SD_BUS_ERROR_NO_NETWORK(3)sd_bus_error_no_reply(3)SD_BUS_ERROR_NO_REPLY(3)sd_bus_error_no_server(3)SD_BUS_ERROR_NO_SERVER(3)sd_bus_error_not_supported(3)SD_BUS_ERROR_NOT_SUPPORTED(3)sd_bus_error_null(3)SD_BUS_ERROR_NULL(3)sd_bus_error_property_read_only(3)SD_BUS_ERROR_PROPERTY_READ_ONLY(3)sd-bus-errors(3)sd_bus_error_service_unknown(3)SD_BUS_ERROR_SERVICE_UNKNOWN(3)sd_bus_error_set(3)sd_bus_error_set_const(3)sd_bus_error_set_errno(3)sd_bus_error_set_errnof(3)sd_bus_error_set_errnofv(3)sd_bus_error_setf(3)sd_bus_error_timeout(3)SD_BUS_ERROR_TIMEOUT(3)sd_bus_error_unix_process_id_unknown(3)SD_BUS_ERROR_UNIX_PROCESS_ID_UNKNOWN(3)sd_bus_error_unknown_interface(3)SD_BUS_ERROR_UNKNOWN_INTERFACE(3)sd_bus_error_unknown_method(3)SD_BUS_ERROR_UNKNOWN_METHOD(3)sd_bus_error_unknown_object(3)SD_BUS_ERROR_UNKNOWN_OBJECT(3)sd_bus_error_unknown_property(3)SD_BUS_ERROR_UNKNOWN_PROPERTY(3)sd_bus_flush(3)sd_bus_flush_close_unref(3)sd_bus_flush_close_unrefp(3)sd_bus_get_address(3)sd_bus_get_allow_interactive_authorization(3)sd_bus_get_bus_id(3)sd_bus_get_close_on_exit(3)sd_bus_get_connected_signal(3)sd_bus_get_creds_mask(3)sd_bus_get_current_handler(3)sd_bus_get_current_message(3)sd_bus_get_current_slot(3)sd_bus_get_current_userdata(3)sd_bus_get_description(3)sd_bus_get_event(3)sd_bus_get_events(3)sd_bus_get_exit_on_disconnect(3)sd_bus_get_fd(3)sd_bus_get_method_call_timeout(3)sd_bus_get_name_creds(3)sd_bus_get_name_machine_id(3)sd_bus_get_n_queued_read(3)sd_bus_get_n_queued_write(3)sd_bus_get_owner_creds(3)sd_bus_get_property(3)sd_bus_get_property_string(3)sd_bus_get_property_strv(3)sd_bus_get_property_trivial(3)sd_bus_get_scope(3)sd_bus_get_sender(3)sd_bus_get_tid(3)sd_bus_get_timeout(3)sd_bus_get_unique_name(3)sd_bus_get_watch_bind(3)sd_bus_interface_name_is_valid(3)sd_bus_is_anonymous(3)sd_bus_is_bus_client(3)sd_bus_is_monitor(3)sd_bus_is_open(3)sd_bus_is_ready(3)sd_bus_is_server(3)sd_bus_is_trusted(3)sd_bus_list_names(3)sd_bus_match_signal(3)sd_bus_match_signal_async(3)sd_bus_member_name_is_valid(3)sd_bus_message_append(3)sd_bus_message_append_array(3)sd_bus_message_append_array_iovec(3)sd_bus_message_append_array_memfd(3)sd_bus_message_append_array_space(3)sd_bus_message_append_basic(3)sd_bus_message_append_string_iovec(3)sd_bus_message_append_string_memfd(3)sd_bus_message_append_string_space(3)sd_bus_message_append_strv(3)sd_bus_message_appendv(3)sd_bus_message_at_end(3)sd_bus_message_close_container(3)sd_bus_message_copy(3)sd_bus_message_dump(3)sd_bus_message_enter_container(3)sd_bus_message_exit_container(3)sd_bus_message_get_allow_interactive_authorization(3)sd_bus_message_get_auto_start(3)sd_bus_message_get_bus(3)sd_bus_message_get_cookie(3)sd_bus_message_get_creds(3)sd_bus_message_get_destination(3)sd_bus_message_get_errno(3)sd_bus_message_get_error(3)sd_bus_message_get_expect_reply(3)sd_bus_message_get_interface(3)sd_bus_message_get_member(3)sd_bus_message_get_monotonic_usec(3)sd_bus_message_get_path(3)sd_bus_message_get_realtime_usec(3)sd_bus_message_get_reply_cookie(3)sd_bus_message_get_sender(3)sd_bus_message_get_seqnum(3)sd_bus_message_get_signature(3)sd_bus_message_get_type(3)sd_bus_message_has_signature(3)sd_bus_message_is_empty(3)sd_bus_message_is_method_call(3)sd_bus_message_is_method_error(3)sd_bus_message_is_signal(3)sd_bus_message_method_call(3)SD_BUS_MESSAGE_METHOD_CALL(3)sd_bus_message_method_error(3)SD_BUS_MESSAGE_METHOD_ERROR(3)sd_bus_message_method_return(3)SD_BUS_MESSAGE_METHOD_RETURN(3)sd_bus_message_new(3)sd_bus_message_new_method_call(3)sd_bus_message_new_method_errno(3)sd_bus_message_new_method_errnof(3)sd_bus_message_new_method_error(3)sd_bus_message_new_method_errorf(3)sd_bus_message_new_method_return(3)sd_bus_message_new_signal(3)sd_bus_message_open_container(3)sd_bus_message_peek_type(3)sd_bus_message_read(3)sd_bus_message_read_array(3)sd_bus_message_read_basic(3)sd_bus_message_read_strv(3)sd_bus_message_readv(3)sd_bus_message_ref(3)sd_bus_message_rewind(3)sd_bus_message_seal(3)sd_bus_message_sensitive(3)sd_bus_message_set_allow_interactive_authorization(3)sd_bus_message_set_auto_start(3)sd_bus_message_set_destination(3)sd_bus_message_set_expect_reply(3)sd_bus_message_set_sender(3)sd_bus_message_signal(3)SD_BUS_MESSAGE_SIGNAL(3)sd_bus_message_skip(3)sd_bus_message_unref(3)sd_bus_message_unrefp(3)sd_bus_message_verify_type(3)sd_bus_method(3)SD_BUS_METHOD(3)sd_bus_method_with_names(3)SD_BUS_METHOD_WITH_NAMES(3)sd_bus_method_with_names_offset(3)SD_BUS_METHOD_WITH_NAMES_OFFSET(3)sd_bus_method_with_offset(3)SD_BUS_METHOD_WITH_OFFSET(3)sd_bus_negotiate_creds(3)sd_bus_negotiate_fds(3)sd_bus_negotiate_timestamp(3)sd_bus_new(3)sd_bus_object_path_is_valid(3)sd_bus_open(3)sd_bus_open_system(3)sd_bus_open_system_machine(3)sd_bus_open_system_remote(3)sd_bus_open_system_with_description(3)sd_bus_open_user(3)sd_bus_open_user_with_description(3)sd_bus_open_with_description(3)sd_bus_param(3)SD_BUS_PARAM(3)sd_bus_path_decode(3)sd_bus_path_decode_many(3)sd_bus_path_encode(3)sd_bus_path_encode_many(3)sd_bus_process(3)sd_bus_property(3)SD_BUS_PROPERTY(3)sd_bus_query_sender_creds(3)sd_bus_query_sender_privilege(3)sd_bus_ref(3)sd_bus_release_name(3)sd_bus_release_name_async(3)sd_bus_reply_method_errno(3)sd_bus_reply_method_errnof(3)sd_bus_reply_method_errnofv(3)sd_bus_reply_method_error(3)sd_bus_reply_method_errorf(3)sd_bus_reply_method_errorfv(3)sd_bus_reply_method_return(3)sd_bus_reply_method_returnv(3)sd_bus_request_name(3)sd_bus_request_name_async(3)sd_bus_send(3)sd_bus_send_to(3)sd_bus_service_name_is_valid(3)sd_bus_set_address(3)sd_bus_set_allow_interactive_authorization(3)sd_bus_set_anonymous(3)sd_bus_set_bus_client(3)sd_bus_set_close_on_exit(3)sd_bus_set_connected_signal(3)sd_bus_set_description(3)sd_bus_set_exec(3)sd_bus_set_exit_on_disconnect(3)sd_bus_set_fd(3)sd_bus_set_method_call_timeout(3)sd_bus_set_monitor(3)sd_bus_set_property(3)sd_bus_set_propertyv(3)sd_bus_set_sender(3)sd_bus_set_server(3)sd_bus_set_trusted(3)sd_bus_set_watch_bind(3)sd_bus_signal(3)SD_BUS_SIGNAL(3)sd_bus_signal_with_names(3)SD_BUS_SIGNAL_WITH_NAMES(3)sd_bus_slot_get_bus(3)sd_bus_slot_get_current_handler(3)sd_bus_slot_get_current_message(3)sd_bus_slot_get_current_userdata(3)sd_bus_slot_get_description(3)sd_bus_slot_get_destroy_callback(3)sd_bus_slot_get_floating(3)sd_bus_slot_get_userdata(3)sd_bus_slot_ref(3)sd_bus_slot_set_description(3)sd_bus_slot_set_destroy_callback(3)sd_bus_slot_set_floating(3)sd_bus_slot_set_userdata(3)sd_bus_slot_unref(3)sd_bus_slot_unrefp(3)sd_bus_start(3)sd_bus_track_add_name(3)sd_bus_track_add_sender(3)sd_bus_track_contains(3)sd_bus_track_count(3)sd_bus_track_count_name(3)sd_bus_track_count_sender(3)sd_bus_track_first(3)sd_bus_track_get_bus(3)sd_bus_track_get_destroy_callback(3)sd_bus_track_get_recursive(3)sd_bus_track_get_userdata(3)sd_bus_track_new(3)sd_bus_track_next(3)sd_bus_track_ref(3)sd_bus_track_remove_name(3)sd_bus_track_remove_sender(3)sd_bus_track_set_destroy_callback(3)sd_bus_track_set_recursive(3)sd_bus_track_set_userdata(3)sd_bus_track_unref(3)sd_bus_track_unrefp(3)sd_bus_unref(3)sd_bus_unrefp(3)sd_bus_vtable_end(3)SD_BUS_VTABLE_END(3)sd_bus_vtable_start(3)SD_BUS_VTABLE_START(3)sd_bus_wait(3)sd_bus_writable_property(3)SD_BUS_WRITABLE_PROPERTY(3)30-systemd-environment-d-generator(7)systemd.directives(7)systemd.index(7)systemd-machined(8)systemd-machined.service(8)