OtaUpgrade::Mqtt::AdvancedPayloadParser Class Reference
#include <AdvancedPayloadParser.h>
Inheritance diagram for OtaUpgrade::Mqtt::AdvancedPayloadParser:
Collaboration diagram for OtaUpgrade::Mqtt::AdvancedPayloadParser:
Public Member Functions | |
| bool | switchRom (const UpdateState &updateState) override |
| This method is responsible for switching the rom. This method is NOT restarting the system. It will happen lated in the parse method. More... | |
| ReadWriteStream * | getStorageStream (size_t storageSize) override |
| Creates new stream to store the firmware update. More... | |
| PayloadParser (size_t currentPatchVersion, size_t allowedVersionBytes=24) | |
 Public Member Functions inherited from OtaUpgrade::Mqtt::PayloadParser | |
| PayloadParser (size_t currentPatchVersion, size_t allowedVersionBytes=24) | |
| virtual | ~PayloadParser () |
| int | parse (MqttPayloadParserState &state, mqtt_message_t *message, const char *buffer, int length) |
| This method takes care to read the incoming MQTT message and pass it to the stream that is responsoble for storing the data. More... | |
Detailed Description
This parser allows the processing of firmware data that can be encrypted or have signature
Member Function Documentation
◆ getStorageStream()
|
overridevirtual |
Creates new stream to store the firmware update.
- Parameters
-
size_t storageSize the requested storage size
- Return values
-
ReadWriteStream*
Implements OtaUpgrade::Mqtt::PayloadParser.
◆ PayloadParser()
|
inline |
- Parameters
-
currentPatchVersion allowedVersionBytes - maximum allowed bytes to be used for describing a patch version
◆ switchRom()
|
overridevirtual |
This method is responsible for switching the rom. This method is NOT restarting the system. It will happen lated in the parse method.
- Return values
-
true if the switch was successful
Implements OtaUpgrade::Mqtt::PayloadParser.
The documentation for this class was generated from the following file:
