PayloadParser.h

Go to the documentation of this file.

/****
 * Sming Framework Project - Open Source framework for high efficiency native ESP8266 development.
 * Created 2015 by Skurydin Alexey
 * http://github.com/SmingHub/Sming
 * All files of the Sming Core are provided under the LGPL v3 license.
 *
 * PayloadParser.h
 *
 *  Created: 2021 - Slavey Karadzhov <slav@attachix.com>
 *
 ****/

#pragma once

#include <Platform/System.h>
#include <Data/Stream/ReadWriteStream.h>
#include <Network/Mqtt/MqttPayloadParser.h>

namespace OtaUpgrade
{
namespace Mqtt
{
constexpr int8_t VERSION_NOT_READY{-1};

constexpr int8_t ERROR_INVALID_MQTT_MESSAGE{-1};
constexpr int8_t ERROR_INVALID_PATCH_VERSION{-2};
constexpr int8_t ERROR_UNKNOWN_REASON{-10};

class PayloadParser
{
public:
    struct UpdateState {
        ReadWriteStream* stream{nullptr};
        bool started{false};
        size_t version{0};

        ~UpdateState()
        {
            delete stream;
        }
    };

    PayloadParser(size_t currentPatchVersion, size_t allowedVersionBytes = 24)
        : currentPatchVersion(currentPatchVersion), allowedVersionBytes(allowedVersionBytes)
    {
    }

    virtual ~PayloadParser()
    {
    }

    virtual bool switchRom(const UpdateState& updateState) = 0;

    virtual ReadWriteStream* getStorageStream(size_t storageSize) = 0;

    int parse(MqttPayloadParserState& state, mqtt_message_t* message, const char* buffer, int length);

private:
    int getPatchVersion(const char* buffer, int length, size_t& offset, size_t versionStart = 0);

    size_t currentPatchVersion;
    size_t allowedVersionBytes;
};

} // namespace Mqtt
} // namespace OtaUpgrade