openbmc/sdbusplus/README.md

5 1. A C++ library (libsdbusplus) for interacting with D-Bus, built on top of the
6    sd-bus library from systemd.
8    D-Bus-based applications.
12 The sdbusplus library requires sd-bus, which is contained in libsystemd.
30 `-Dtests=disabled` and `-Dexamples=disabled` respectively to `meson`.
42 The sdbusplus library builds on top of the [sd-bus] library to create a modern
43 C++ API for D-Bus. The library attempts to be as lightweight as possible,
44 usually compiling to exactly the sd-bus API calls that would have been
45 necessary, while also providing compile-time type-safety and memory leak
65 In a few, relatively succinct, C++ lines this snippet will create a D-Bus
72 In general, the library attempts to mimic the naming conventions of the sd-bus
76 This allows a relatively straight-forward translation back to the sd-bus
79 [sd-bus]: http://0pointer.net/blog/the-new-sd-bus-api-of-systemd.html
81 …thub.com/systemd/systemd/blob/d60c527009133a1ed3d69c14b8c837c790e78d10/src/login/logind-dbus.c#L496
86 bindings generator is to reduce the boilerplate associated with creating D-Bus
88 creating sd-bus vtables and writing C-style functions to handle each vtable
89 callback, you can create a small YAML file to define your D-Bus interface and
90 the `sdbus++` tool will create a C++ class that implements your D-Bus interface.
96 D-Bus interfaces. Errors are used to define C++ exceptions which can be thrown
97 and will automatically turn into D-Bus error responses.
99 [[D-Bus client bindings are not yet implemented.  See openbmc/openbmc#851.]]
112 sdbus++ interface server-header org.freedesktop.Example > \
114 sdbus++ interface server-cpp org.freedesktop.Example > \
116 sdbus++ error exception-header org.freedesktop.Example > \
118 sdbus++ error exception-cpp org.freedesktop.Example > \
122 Markdown-based documentation can also be generated from the interface and
144 sudo apt install git meson libtool pkg-config g++ libsystemd-dev \
145     python3 python3-pip python3-yaml python3-mako python3-inflection
151 sudo dnf install git meson libtool gcc-c++ pkgconfig systemd-devel \
152     python3 python3-pip python3-yaml python3-mako