Add UpdatePolicy::OnDemand which allows to transmit properties only when the tranmission is explicitly requested

Author: aentinger

src/property/Property.cpp

@@ -44,7 +44,8 @@ Property::Property()
       _last_cloud_change_timestamp(0),
       _identifier(0),
       _attributeIdentifier(0),
-      _lightPayload(false) {
+      _lightPayload(false),
+      _update_requested(false) {
 }
 
 /******************************************************************************
@@ -79,6 +80,11 @@ Property & Property::publishEvery(unsigned long const seconds) {
   return (*this);
 }
 
+Property & Property::publishOnDemand() {
+  _update_policy = UpdatePolicy::OnDemand;
+  return (*this);
+}
+
 bool Property::shouldBeUpdated() {
   if (!_has_been_updated_once) {
     return true;
@@ -93,11 +99,18 @@ bool Property::shouldBeUpdated() {
     return (isDifferentFromCloud() && ((millis() - _last_updated_millis) >= (_min_time_between_updates_millis)));
   } else if (_update_policy == UpdatePolicy::TimeInterval) {
     return ((millis() - _last_updated_millis) >= _update_interval_millis);
+  } else if (_update_policy == UpdatePolicy::OnDemand) {
+    return _update_requested;
   } else {
     return false;
   }
 }
 
+void Property::requestUpdate()
+{
+  _update_requested = true;
+}
+
 void Property::execCallbackOnChange() {
   if (_update_callback_func != NULL) {
     _update_callback_func();
@@ -119,6 +132,7 @@ void Property::append(CborEncoder *encoder, bool lightPayload) {
   appendAttributesToCloudReal(encoder);
   fromLocalToCloud();
   _has_been_updated_once = true;
+  _update_requested = false;
   _last_updated_millis = millis();
 }
 

src/property/Property.h

@@ -117,7 +117,7 @@ enum class Type {
 };
 
 enum class UpdatePolicy {
-  OnChange, TimeInterval
+  OnChange, TimeInterval, OnDemand
 };
 
 typedef void(*UpdateCallbackFunc)(void);
@@ -138,6 +138,7 @@ class Property {
     Property & onSync(SyncCallbackFunc func);
     Property & publishOnChange(float const min_delta_property, unsigned long const min_time_between_updates_millis = 0);
     Property & publishEvery(unsigned long const seconds);
+    Property & publishOnDemand();
 
     inline String name() const {
       return _name;
@@ -153,6 +154,7 @@ class Property {
     }
 
     bool shouldBeUpdated();
+    void requestUpdate();
     void execCallbackOnChange();
     void execCallbackOnSync();
     void setLastCloudChangeTimestamp(unsigned long cloudChangeTime);
@@ -211,6 +213,8 @@ class Property {
     int                _attributeIdentifier;
     /* Indicates if the property shall be encoded using the identifier instead of the name */
     bool               _lightPayload;
+    /* Indicates whether a property update has been requested in case of the OnDemand update policy. */
+    bool               _update_requested;
 };
 
 /******************************************************************************

src/property/PropertyContainer.cpp

@@ -112,6 +112,16 @@ int PropertyContainer::appendChangedProperties(CborEncoder * arrayEncoder, bool
   return appendedProperties;
 }
 
+void PropertyContainer::requestUpdateForAllProperties()
+{
+  std::for_each(_property_list.begin(),
+                _property_list.end(),
+                [](Property * p)
+                {
+                  p->requestUpdate();
+                });
+}
+
 void PropertyContainer::updateTimestampOnLocallyChangedProperties()
 {
   /* This function updates the timestamps on the primitive properties 

src/property/PropertyContainer.h

@@ -52,6 +52,7 @@ class PropertyContainer
 
   int appendChangedProperties(CborEncoder * arrayEncoder, bool lightPayload);
   void updateTimestampOnLocallyChangedProperties();
+  void requestUpdateForAllProperties();