commit ae47928b21e1aece18962a5b9254837dc5d692d6
author Jonathan Doman <jonathan.doman@intel.com> Fri Jun 03 13:29:50 2022 -0700
committer Jonathan Doman <jonathan.doman@intel.com> Wed Nov 23 15:56:32 2022 -0800
tree c3dbb3b1701290911820ed6c42f6c113e4a5c2bc
parent 5d81ca2b8f3238b0ac44fc00f40229f24b4d1029

Clean up ASIO set-property callback code

This reverts commit ce62764d6c0a72ec88eb433e1afd05b751225971, which
introduced inconsistent semantics for the underlying ASIO set handler
functions. The "external" `call` case expected the handler to return an
integer error code, while the "internal" `set` case expected the handler
to return a boolean status.

This also does a small refactor on the two similar `call` and `set`
functions to deduplicate, and adds ASIO.md to document the expected
semantics of the ASIO handlers.

The vast majority of user code in OpenBMC is still returning integers
from the callbacks (0/1/-1), but in most cases 0 was used to mean
failure, and 1 was used to mean success, so formalizing that the
callback should return a boolean value will not break things.

Tested: With accompanying dbus-sensors change
I05c41318954d5d1549752c5ef2c227f3f22a45d3, using steps in that commit
msg.

Signed-off-by: Jonathan Doman <jonathan.doman@intel.com>
Change-Id: Ic3a36027fa95a77469439b296a1497634cfe030f

example/asio-example.cpp

diff --git a/example/asio-example.cpp b/example/asio-example.cpp
index f113dd3..a83ffea 100644
--- a/example/asio-example.cpp
+++ b/example/asio-example.cpp
@@ -219,17 +219,17 @@
                              [](const int& req, int& propertyValue) {
                                  if (req >= 50)
                                  {
-                                     return -EINVAL;
+                                     return false;
                                  }
                                  propertyValue = req;
-                                 return 1; // success
+                                 return true;
                              });
     iface->register_property(
         "TrailTime", std::string("foo"),
         // custom set
         [](const std::string& req, std::string& propertyValue) {
             propertyValue = req;
-            return 1; // success
+            return true;
         },
         // custom get
         [](const std::string& property) {

example/get-all-properties.cpp

diff --git a/example/get-all-properties.cpp b/example/get-all-properties.cpp
index 8b01258..2f1e908 100644
--- a/example/get-all-properties.cpp
+++ b/example/get-all-properties.cpp
@@ -33,7 +33,7 @@
             propertyGoodbyesName, sdbusplus::vtable::property_::emits_change,
             [this](const auto& newPropertyValue, const auto&) {
                 goodbyes_ = newPropertyValue;
-                return 1;
+                return true;
             },
             [this](const auto&) { return goodbyes_; });
 

example/register-property.cpp

diff --git a/example/register-property.cpp b/example/register-property.cpp
index 339c0ce..2c3e362 100644
--- a/example/register-property.cpp
+++ b/example/register-property.cpp
@@ -32,7 +32,7 @@
                     sdbusplus::vtable::property_::emits_change,
                     [this](const auto& newPropertyValue, const auto&) {
                         goodbyes_ = newPropertyValue;
-                        return 1;
+                        return true;
                     },
                     [this](const auto&) { return goodbyes_; });
             });