include/utility/dbus_utility.hpp

19  * @brief An API to get Map of service and interfaces for an object path.
21  * The API returns a Map of service name and interfaces for a given pair of
67  * @brief An API to get property map for an interface.
69  * This API returns a map of property and its value with respect to a particular
112  * @brief API to get object subtree from D-bus.
114  * The API returns the map of object, services and interfaces in the
162  * @brief An API to read property from Dbus.
164  * The caller of the API needs to validate the validatity and correctness of the
165  * type and value of data returned. The API will just fetch and retun the data
212  * @brief An API to write property on Dbus.
214  * The caller of this API needs to handle exception thrown by this method to
215  * identify any write failure. The API in no other way indicate write  failure
257  * @brief API to publish data on PIM
259  * The API calls notify on PIM object to publlish VPD.
295  * @brief API to check if a D-Bus service is running or not.
298  * not in a running state. Hence the API returns false in case of any exception
329  * @brief API to call "GetAttribute" method uner BIOS manager.
331  * The API reads the given attribuute from BIOS and returns a tuple of both
333  * The API return only the current attribute value if found.
334  * API returns an empty variant of type BiosAttributeCurrentValue in case of any
370  * @brief API to check if Chassis is powered on.
372  * This API queries Phosphor Chassis State Manager to know whether
404  * @brief API to check if host is in running state.
406  * This API reads the current host state from D-bus and returns true if the host
429  * @brief API to check if BMC is in ready state.
431  * This API reads the current state of BMC from D-bus and returns true if BMC is
454  * @brief An API to enable BMC reboot guard
456  * This API does a D-Bus method call to enable BMC reboot guard.
485  * @brief An API to disable BMC reboot guard
487  * This API disables BMC reboot guard. This API has an inbuilt re-try mechanism.
488  * If Disable Reboot Guard fails, this API attempts to Disable Reboot Guard for
562  * @brief API to notify FRU VPD Collection status.
564  * This API uses PIM's Notify method to update the given FRU VPD collection
592  * @brief API to read IM keyword from Dbus.
612  * @brief API to return prefix of functional firmware image.
615  * characters of the image name. The API extracts that and returns it to the
689  * @brief API to read DBus present property for the given inventory.
715  * @brief API to get list of sub tree paths for a given object path
717  * Given a DBus object path, this API returns a list of object paths under that
718  * object path in the DBus tree. This API calls DBus method GetSubTreePaths
730  * Note: The caller of this API should check for empty vector.
759  * @brief API to get Dbus service name for given connection identifier.