#ifndef StatefulService_h #define StatefulService_h #include "Arduino.h" #include #include #include enum class StateUpdateResult { CHANGED = 0, // The update changed the state and propagation should take place if required CHANGED_RESTART, // The update changed the state and the service should be restarted UNCHANGED, // The state was unchanged, propagation should not take place ERROR // There was a problem updating the state, propagation should not take place }; template using JsonStateUpdater = std::function; template using JsonStateReader = std::function; typedef size_t update_handler_id_t; typedef std::function StateUpdateCallback; typedef struct StateUpdateHandlerInfo { static update_handler_id_t currentUpdatedHandlerId; update_handler_id_t _id; StateUpdateCallback _cb; bool _allowRemove; StateUpdateHandlerInfo(StateUpdateCallback cb, bool allowRemove) : _id(++currentUpdatedHandlerId) , _cb(cb) , _allowRemove(allowRemove){}; } StateUpdateHandlerInfo_t; template class StatefulService { public: template #ifdef ESP32 StatefulService(Args &&... args) : _state(std::forward(args)...) , _accessMutex(xSemaphoreCreateRecursiveMutex()) { } #else StatefulService(Args &&... args) : _state(std::forward(args)...) { } #endif update_handler_id_t addUpdateHandler(StateUpdateCallback cb, bool allowRemove = true) { if (!cb) { return 0; } StateUpdateHandlerInfo_t updateHandler(cb, allowRemove); _updateHandlers.push_back(updateHandler); return updateHandler._id; } void removeUpdateHandler(update_handler_id_t id) { for (auto i = _updateHandlers.begin(); i != _updateHandlers.end();) { if ((*i)._allowRemove && (*i)._id == id) { i = _updateHandlers.erase(i); } else { ++i; } } } StateUpdateResult update(std::function stateUpdater) { beginTransaction(); StateUpdateResult result = stateUpdater(_state); endTransaction(); if (result == StateUpdateResult::CHANGED) { callUpdateHandlers(); } return result; } StateUpdateResult updateWithoutPropagation(std::function stateUpdater) { beginTransaction(); StateUpdateResult result = stateUpdater(_state); endTransaction(); return result; } StateUpdateResult update(JsonObject jsonObject, JsonStateUpdater stateUpdater) { beginTransaction(); StateUpdateResult result = stateUpdater(jsonObject, _state); endTransaction(); if (result == StateUpdateResult::CHANGED) { callUpdateHandlers(); } return result; } StateUpdateResult updateWithoutPropagation(JsonObject jsonObject, JsonStateUpdater stateUpdater) { beginTransaction(); StateUpdateResult result = stateUpdater(jsonObject, _state); endTransaction(); return result; } void read(std::function stateReader) { beginTransaction(); stateReader(_state); endTransaction(); } void read(JsonObject jsonObject, JsonStateReader stateReader) { beginTransaction(); stateReader(_state, jsonObject); endTransaction(); } void callUpdateHandlers() { for (const StateUpdateHandlerInfo_t & updateHandler : _updateHandlers) { updateHandler._cb(); } } protected: T _state; inline void beginTransaction() { #ifdef ESP32 xSemaphoreTakeRecursive(_accessMutex, portMAX_DELAY); #endif } inline void endTransaction() { #ifdef ESP32 xSemaphoreGiveRecursive(_accessMutex); #endif } private: #ifdef ESP32 SemaphoreHandle_t _accessMutex; #endif std::list _updateHandlers; }; #endif