Allow propagation of CBOR library function return value to determine if a out-of-memory error occurs. If that's the case the CBOR encoding is completed until that property and the CBOR message is still sent with the next properties encoded on the next run of CBOREncoder::encode

Author: aentinger

src/cbor/CBOREncoder.cpp

@@ -40,7 +40,8 @@ int CBOREncoder::encode(PropertyContainer & property_container, uint8_t * data,
    * time interval may be elapsed or property may be changed
    * and if that's the case encode the property into the CBOR.
    */
-  if (appendChangedProperties(property_container, &arrayEncoder, lightPayload) < 1)
+  CborError err = appendChangedProperties(property_container, &arrayEncoder, lightPayload);
+  if ((err != CborNoError) && (err != CborErrorOutOfMemory))
     return -1;
 
   if (cbor_encoder_close_container(&encoder, &arrayEncoder) != CborNoError)

src/property/Property.cpp

@@ -142,78 +142,92 @@ void Property::execCallbackOnSync() {
   }
 }
 
-void Property::append(CborEncoder *encoder, bool lightPayload) {
+CborError Property::append(CborEncoder *encoder, bool lightPayload) {
   _lightPayload = lightPayload;
   _attributeIdentifier = 0;
-  appendAttributesToCloudReal(encoder);
+  CHECK_CBOR(appendAttributesToCloudReal(encoder));
   fromLocalToCloud();
   _has_been_updated_once = true;
   _update_requested = false;
   _last_updated_millis = millis();
+  return CborNoError;
 }
 
-void Property::appendAttributeReal(bool value, String attributeName, CborEncoder *encoder) {
-  appendAttributeName(attributeName, [value](CborEncoder & mapEncoder) {
-    cbor_encode_int(&mapEncoder, static_cast<int>(CborIntegerMapKey::BooleanValue));
-    cbor_encode_boolean(&mapEncoder, value);
+CborError Property::appendAttributeReal(bool value, String attributeName, CborEncoder *encoder) {
+  return appendAttributeName(attributeName, [value](CborEncoder & mapEncoder)
+  {
+    CHECK_CBOR(cbor_encode_int(&mapEncoder, static_cast<int>(CborIntegerMapKey::BooleanValue)));
+    CHECK_CBOR(cbor_encode_boolean(&mapEncoder, value));
+    return CborNoError;
   }, encoder);
 }
 
-void Property::appendAttributeReal(int value, String attributeName, CborEncoder *encoder) {
-  appendAttributeName(attributeName, [value](CborEncoder & mapEncoder) {
-    cbor_encode_int(&mapEncoder, static_cast<int>(CborIntegerMapKey::Value));
-    cbor_encode_int(&mapEncoder, value);
+CborError Property::appendAttributeReal(int value, String attributeName, CborEncoder *encoder) {
+  return appendAttributeName(attributeName, [value](CborEncoder & mapEncoder)
+  {
+    CHECK_CBOR(cbor_encode_int(&mapEncoder, static_cast<int>(CborIntegerMapKey::Value)));
+    CHECK_CBOR(cbor_encode_int(&mapEncoder, value));
+    return CborNoError;
   }, encoder);
 }
 
-void Property::appendAttributeReal(float value, String attributeName, CborEncoder *encoder) {
-  appendAttributeName(attributeName, [value](CborEncoder & mapEncoder) {
-    cbor_encode_int(&mapEncoder, static_cast<int>(CborIntegerMapKey::Value));
-    cbor_encode_float(&mapEncoder, value);
+CborError Property::appendAttributeReal(float value, String attributeName, CborEncoder *encoder) {
+  return appendAttributeName(attributeName, [value](CborEncoder & mapEncoder)
+  {
+    CHECK_CBOR(cbor_encode_int(&mapEncoder, static_cast<int>(CborIntegerMapKey::Value)));
+    CHECK_CBOR(cbor_encode_float(&mapEncoder, value));
+    return CborNoError;
   }, encoder);
 }
 
-void Property::appendAttributeReal(String value, String attributeName, CborEncoder *encoder) {
-  appendAttributeName(attributeName, [value](CborEncoder & mapEncoder) {
-    cbor_encode_int(&mapEncoder, static_cast<int>(CborIntegerMapKey::StringValue));
-    cbor_encode_text_stringz(&mapEncoder, value.c_str());
+CborError Property::appendAttributeReal(String value, String attributeName, CborEncoder *encoder) {
+  return appendAttributeName(attributeName, [value](CborEncoder & mapEncoder)
+  {
+    CHECK_CBOR(cbor_encode_int(&mapEncoder, static_cast<int>(CborIntegerMapKey::StringValue)));
+    CHECK_CBOR(cbor_encode_text_stringz(&mapEncoder, value.c_str()));
+    return CborNoError;
   }, encoder);
 }
 
-void Property::appendAttributeName(String attributeName, std::function<void (CborEncoder& mapEncoder)>appendValue, CborEncoder *encoder) {
+CborError Property::appendAttributeName(String attributeName, std::function<CborError (CborEncoder& mapEncoder)>appendValue, CborEncoder *encoder) {
   if (attributeName != "") {
     // when the attribute name string is not empty, the attribute identifier is incremented in order to be encoded in the message if the _lightPayload flag is set
     _attributeIdentifier++;
   }
   CborEncoder mapEncoder;
   unsigned int num_map_properties = _encode_timestamp ? 3 : 2;
-  cbor_encoder_create_map(encoder, &mapEncoder, num_map_properties);
-  cbor_encode_int(&mapEncoder, static_cast<int>(CborIntegerMapKey::Name));
+  CHECK_CBOR(cbor_encoder_create_map(encoder, &mapEncoder, num_map_properties));
+  CHECK_CBOR(cbor_encode_int(&mapEncoder, static_cast<int>(CborIntegerMapKey::Name)));
 
   // if _lightPayload is true, the property and attribute identifiers will be encoded instead of the property name
-  if (_lightPayload) {
+  if (_lightPayload)
+  {
     // the most significant byte of the identifier to be encoded represent the property identifier
     int completeIdentifier = _attributeIdentifier * 256;
     // the least significant byte of the identifier to be encoded represent the attribute identifier
     completeIdentifier += _identifier;
-    cbor_encode_int(&mapEncoder, completeIdentifier);
-  } else {
+    CHECK_CBOR(cbor_encode_int(&mapEncoder, completeIdentifier));
+  }
+  else
+  {
     String completeName = _name;
     if (attributeName != "") {
       completeName += ":" + attributeName;
     }
-    cbor_encode_text_stringz(&mapEncoder, completeName.c_str());
+    CHECK_CBOR(cbor_encode_text_stringz(&mapEncoder, completeName.c_str()));
   }
   /* Encode the value */
-  appendValue(mapEncoder);
+  CHECK_CBOR(appendValue(mapEncoder));
+
   /* Encode the timestamp if that has been required. */
   if(_encode_timestamp)
   {
-    cbor_encode_int (&mapEncoder, static_cast<int>(CborIntegerMapKey::Time));
-    cbor_encode_uint(&mapEncoder, _timestamp);
+    CHECK_CBOR(cbor_encode_int (&mapEncoder, static_cast<int>(CborIntegerMapKey::Time)));
+    CHECK_CBOR(cbor_encode_uint(&mapEncoder, _timestamp));
   }
   /* Close the container */
-  cbor_encoder_close_container(encoder, &mapEncoder);
+  CHECK_CBOR(cbor_encoder_close_container(encoder, &mapEncoder));
+  return CborNoError;
 }
 
 void Property::setAttributesFromCloud(std::list<CborMapData> * map_data_list) {

src/property/Property.h

@@ -36,6 +36,18 @@
 
 #include "../cbor/lib/tinycbor/cbor-lib.h"
 
+/******************************************************************************
+   DEFINE
+ ******************************************************************************/
+
+#define CHECK_CBOR(expr)           \
+  do {                             \
+    CborError error = CborNoError; \
+    error = (expr);                \
+    if (CborNoError != error)      \
+      return error;                \
+  } while(0);
+
 #define appendAttributesToCloud() appendAttributesToCloudReal(CborEncoder *encoder)
 #define appendAttribute(x) appendAttributeReal(x, getAttributeName(#x, '.'), encoder)
 #define setAttribute(x) setAttributeReal(x, getAttributeName(#x, '.'))
@@ -168,12 +180,12 @@ class Property
     void setIdentifier(int identifier);
 
     void updateLocalTimestamp();
-    void append(CborEncoder * encoder, bool lightPayload);
-    void appendAttributeReal(bool value, String attributeName = "", CborEncoder *encoder = nullptr);
-    void appendAttributeReal(int value, String attributeName = "", CborEncoder *encoder = nullptr);
-    void appendAttributeReal(float value, String attributeName = "", CborEncoder *encoder = nullptr);
-    void appendAttributeReal(String value, String attributeName = "", CborEncoder *encoder = nullptr);
-    void appendAttributeName(String attributeName, std::function<void (CborEncoder& mapEncoder)>f, CborEncoder *encoder);
+    CborError append(CborEncoder * encoder, bool lightPayload);
+    CborError appendAttributeReal(bool value, String attributeName = "", CborEncoder *encoder = nullptr);
+    CborError appendAttributeReal(int value, String attributeName = "", CborEncoder *encoder = nullptr);
+    CborError appendAttributeReal(float value, String attributeName = "", CborEncoder *encoder = nullptr);
+    CborError appendAttributeReal(String value, String attributeName = "", CborEncoder *encoder = nullptr);
+    CborError appendAttributeName(String attributeName, std::function<CborError (CborEncoder& mapEncoder)>f, CborEncoder *encoder);
     void setAttributesFromCloud(std::list<CborMapData> * map_data_list);
     void setAttributeReal(bool& value, String attributeName = "");
     void setAttributeReal(int& value, String attributeName = "");
@@ -185,7 +197,7 @@ class Property
     virtual bool isDifferentFromCloud() = 0;
     virtual void fromCloudToLocal() = 0;
     virtual void fromLocalToCloud() = 0;
-    virtual void appendAttributesToCloudReal(CborEncoder *encoder) = 0;
+    virtual CborError appendAttributesToCloudReal(CborEncoder *encoder) = 0;
     virtual void setAttributesFromCloud() = 0;
     virtual bool isPrimitive() {
       return false;

src/property/PropertyContainer.cpp

@@ -83,20 +83,21 @@ Property * getProperty(PropertyContainer & prop_cont, int const identifier)
     return (*iter);
 }
 
-int appendChangedProperties(PropertyContainer & prop_cont, CborEncoder * arrayEncoder, bool lightPayload)
+CborError appendChangedProperties(PropertyContainer & prop_cont, CborEncoder * arrayEncoder, bool lightPayload)
 {
-  int appendedProperties = 0;
+  CborError err = CborNoError;
   std::for_each(prop_cont.begin(),
                 prop_cont.end(),
-                [arrayEncoder, lightPayload, &appendedProperties](Property * p)
+                [arrayEncoder, lightPayload, &err](Property * p)
                 {
                   if (p->shouldBeUpdated() && p->isReadableByCloud())
                   {
-                    p->append(arrayEncoder, lightPayload);
-                    appendedProperties++;
+                    err = p->append(arrayEncoder, lightPayload);
+                    if(err != CborNoError)
+                      return;
                   }
                 });
-  return appendedProperties;
+  return err;
 }
 
 void requestUpdateForAllProperties(PropertyContainer & prop_cont)

src/property/PropertyContainer.h

@@ -78,7 +78,7 @@ Property * getProperty(PropertyContainer & prop_cont, String const & name);
 Property * getProperty(PropertyContainer & prop_cont, int const identifier);
 
 
-int appendChangedProperties(PropertyContainer & prop_cont, CborEncoder * arrayEncoder, bool lightPayload);
+CborError appendChangedProperties(PropertyContainer & prop_cont, CborEncoder * arrayEncoder, bool lightPayload);
 void updateTimestampOnLocallyChangedProperties(PropertyContainer & prop_cont);
 void requestUpdateForAllProperties(PropertyContainer & prop_cont);
 void updateProperty(PropertyContainer & prop_cont, String propertyName, unsigned long cloudChangeEventTime, bool const is_sync_message, std::list<CborMapData> * map_data_list);

src/property/types/CloudBool.h

@@ -52,8 +52,8 @@ class CloudBool : public Property {
     virtual void fromLocalToCloud() {
       _cloud_value = _value;
     }
-    virtual void appendAttributesToCloud() {
-      appendAttribute(_value);
+    virtual CborError appendAttributesToCloud() {
+      return appendAttribute(_value);
     }
     virtual void setAttributesFromCloud() {
       setAttribute(_cloud_value);

src/property/types/CloudColor.h

@@ -188,10 +188,11 @@ class CloudColor : public Property {
     virtual void fromLocalToCloud() {
       _cloud_value = _value;
     }
-    virtual void appendAttributesToCloud() {
-      appendAttribute(_value.hue);
-      appendAttribute(_value.sat);
-      appendAttribute(_value.bri);
+    virtual CborError appendAttributesToCloud() {
+      CHECK_CBOR(appendAttribute(_value.hue));
+      CHECK_CBOR(appendAttribute(_value.sat));
+      CHECK_CBOR(appendAttribute(_value.bri));
+      return CborNoError;
     }
     virtual void setAttributesFromCloud() {
       setAttribute(_cloud_value.hue);

src/property/types/CloudFloat.h

@@ -54,8 +54,8 @@ class CloudFloat : public Property {
     virtual void fromLocalToCloud() {
       _cloud_value = _value;
     }
-    virtual void appendAttributesToCloud() {
-      appendAttribute(_value);
+    virtual CborError appendAttributesToCloud() {
+      return appendAttribute(_value);
     }
     virtual void setAttributesFromCloud() {
       setAttribute(_cloud_value);

src/property/types/CloudInt.h

@@ -52,8 +52,8 @@ class CloudInt : public Property {
     virtual void fromLocalToCloud() {
       _cloud_value = _value;
     }
-    virtual void appendAttributesToCloud() {
-      appendAttribute(_value);
+    virtual CborError appendAttributesToCloud() {
+      return appendAttribute(_value);
     }
     virtual void setAttributesFromCloud() {
       setAttribute(_cloud_value);

src/property/types/CloudLocation.h

@@ -89,9 +89,10 @@ class CloudLocation : public Property {
     virtual void fromLocalToCloud() {
       _cloud_value = _value;
     }
-    virtual void appendAttributesToCloud() {
-      appendAttribute(_value.lat);
-      appendAttribute(_value.lon);
+    virtual CborError appendAttributesToCloud() {
+      CHECK_CBOR(appendAttribute(_value.lat));
+      CHECK_CBOR(appendAttribute(_value.lon));
+      return CborNoError;
     }
     virtual void setAttributesFromCloud() {
       setAttribute(_cloud_value.lat);