openbmc/phosphor-inventory-manager/functor.hpp

24  *  @param[in] action - The action being adapted.
25  *  @returns - The adapted action.
27  *  @tparam T - The type of the action being adapted.
39  *  @param[in] filter - The filter being adapted.
40  *  @returns - The adapted filter.
42  *  @tparam T - The type of the filter being adapted.
54  *  @param[in] filter - The functor being adapted.
55  *  @returns - The adapted functor.
57  *  @tparam T - The type of the functor being adapted.
69  *  @param[in] method - The functor being adapted.
70  *  @returns - The adapted functor.
72  *  @tparam T - The return type of the function object.
73  *  @tparam U - The type of the functor being adapted.
119 /** @brief Set a property action.
124  *  @tparam T - The sdbusplus server binding interface type.
125  *  @tparam U - The type of the sdbusplus server binding member
126  *      function that sets the property.
127  *  @tparam V - The property value type.
129  *  @param[in] paths - The DBus paths on which the property should
131  *  @param[in] iface - The DBus interface hosting the property.
132  *  @param[in] member - Pointer to sdbusplus server binding member.
133  *  @param[in] value - The value the property should be set to.
135  *  @returns - A function object that sets the requested property
159 /** @brief Get a property.
164  *  @tparam T - The sdbusplus server binding interface type.
165  *  @tparam U - The type of the sdbusplus server binding member
166  *      function that sets the property.
168  *  @param[in] path - The DBus path to get the property from.
169  *  @param[in] iface - The DBus interface hosting the property.
170  *  @param[in] member - Pointer to sdbusplus server binding member.
171  *  @param[in] prop - The property name to get the value from.
173  *  @returns - A function object that gets the requested property.
185  *  @brief Match filter functor that tests a property value.
187  *  @tparam T - The type of the property being tested.
188  *  @tparam U - The type of the condition checking functor.
200     PropertyChangedCondition(const char* iface, const char* property,  in PropertyChangedCondition()
202         _iface(iface), _property(property),  in PropertyChangedCondition()
206     /** @brief Test a property value.
208      * Extract the property from the PropertiesChanged
211     bool operator()(sdbusplus::bus_t&, sdbusplus::message_t& msg,  in operator ()()
230         return _condition(std::forward<T>(std::get<T>(it->second)));  in operator ()()
240  *  @brief Match filter functor that tests a property value.
242  *  Base class for PropertyCondition - factored out code that
261      *  @param path - The path of the object containing
262      *     the property to be tested.
263      *  @param iface - The interface hosting the property
265      *  @param property - The property to be tested.
266      *  @param service - The DBus service hosting the object.
269                           const char* property, const char* service) :  in PropertyConditionBase()
270         _path(path ? path : std::string()), _iface(iface), _property(property),  in PropertyConditionBase()
275     virtual bool eval(sdbusplus::message_t&) const = 0;
278     virtual bool eval(Manager&) const = 0;
280     /** @brief Test a property value.
282      * Make a DBus call and test the value of any property.
284     bool operator()(sdbusplus::bus_t&, sdbusplus::message_t&, Manager&) const;
286     /** @brief Test a property value.
288      * Make a DBus call and test the value of any property.
290     bool operator()(const std::string&, sdbusplus::bus_t&, Manager&) const;
300  *  @brief Match filter functor that tests a property value.
302  *  @tparam T - The type of the property being tested.
303  *  @tparam U - The type of the condition checking functor.
304  *  @tparam V - The getProperty functor return type.
322      *  The getProperty function will be called to retrieve a property
323      *  value when given and the property is hosted by inventory manager.
327      *  @param path - The path of the object containing
328      *     the property to be tested.
329      *  @param iface - The interface hosting the property
331      *  @param property - The property to be tested.
332      *  @param condition - The test to run on the property.
333      *  @param service - The DBus service hosting the object.
334      *  @param getProperty - The function to get a property value
337     PropertyCondition(const char* path, const char* iface, const char* property,  in PropertyCondition()
340         PropertyConditionBase(path, iface, property, service),  in PropertyCondition()
345     /** @brief Test a property value.
347      * Make a DBus call and test the value of any property.
349     bool eval(sdbusplus::message_t& msg) const override  in eval()
356     /** @brief Retrieve a property value from inventory and test it.
358      *  Get a property from the inventory manager and test the value.
360      *  property from the inventory manager.
362     bool eval(Manager& mgr) const override  in eval()
380 auto propertyChangedTo(const char* iface, const char* property, T&& val)  in propertyChangedTo()  argument
386     return PropertyChangedCondition<T, U>(iface, property,  in propertyChangedTo()
392 auto propertyIs(const char* path, const char* iface, const char* property,  in propertyIs()  argument
400     return PropertyCondition<T, U, V>(path, iface, property,  in propertyIs()