sd_bus_start(3) — Linux manual page


SD_BUS_START(3)                 sd_bus_start                 SD_BUS_START(3)

NAME         top

       sd_bus_start - Initiate a bus connection to the D-bus broker daemon

SYNOPSIS         top

       #include <systemd/sd-bus.h>

       int sd_bus_start(sd_bus *bus);

DESCRIPTION         top

       sd_bus_start() connects an existing bus connection object to the
       D-Bus broker daemon, usually dbus-daemon(1) or dbus-broker(1). The
       mechanism to use for the connection must be configured before the
       call to sd_bus_start(), using one of sd_bus_set_address(3),
       sd_bus_set_fd(3), or sd_bus_set_exec(3).  sd_bus_start() will open
       the connection socket or spawn the executable as needed, and
       asynchronously start a org.freedesktop.DBus.Hello() call. The answer
       to the Hello call will be processed later from sd_bus_process(3). If
       opening of the connection or queuing of the asynchronous call fail,
       the connection will be closed with sd_bus_close(3).

       In most cases, it is better to use sd_bus_default_user(3),
       sd_bus_default_system(3) or related calls instead of the more
       low-level sd_bus_new() and sd_bus_start(). The higher-level functions
       not only allocate a bus object but also start the connection to a
       well-known bus in a single function call.

RETURN VALUE         top

       On success, this function returns a non-negative integer. On failure,
       it returns a negative errno-style error code.

           The input parameter bus is NULL.

           Bus object bus could not be resolved.

           The input parameter bus is in a wrong state (sd_bus_start() may
           only be called once on a newly-created bus object).

           The bus object bus was created in a different process.

       In addition, other connection-related errors may be returned. See

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-bus(3), sd_bus_default(3), sd_bus_call_async(3)

COLOPHON         top

       This page is part of the systemd (systemd system and service manager)
       project.  Information about the project can be found at 
       ⟨⟩.  If you have a bug
       report for this manual page, see
       ⟨⟩.  This
       page was obtained from the project's upstream Git repository
       ⟨⟩ on 2020-09-18.  (At that
       time, the date of the most recent commit that was found in the repos‐
       itory was 2020-09-18.)  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

systemd 246                                                  SD_BUS_START(3)

Pages that refer to this page: sd-bus(3)sd_bus_close_unref(3)sd_bus_close_unrefp(3)sd_bus_default(3)sd_bus_default_system(3)sd_bus_default_user(3)sd_bus_flush_close_unref(3)sd_bus_flush_close_unrefp(3)sd_bus_get_address(3)sd_bus_get_bus_id(3)sd_bus_get_creds_mask(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_negotiate_creds(3)sd_bus_negotiate_fds(3)sd_bus_negotiate_timestamp(3)sd_bus_new(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_ref(3)sd_bus_set_address(3)sd_bus_set_bus_client(3)sd_bus_set_exec(3)sd_bus_set_monitor(3)sd_bus_set_server(3)sd_bus_unref(3)sd_bus_unrefp(3)30-systemd-environment-d-generator(7)systemd.directives(7)systemd.index(7)