execute MQTT client synchronously in main loop() (#350)

processing a published valued on a subscribed topic is currently running
in a task that is not the task executing the main loop(). that's because
the espMqttClient(Secure) was constructed without arguments, which
selects the constructor with two arguments priority and core, both of
which have default values. that constructor selects
espMqttClientTypes::UseInternalTask::YES, causing a task to be created
in which context the MQTT client loop is executed.

MQTT subscribers assume they are running in the same context as the main
loop(). most code assumes exactly that. as the scheduler is preemptive
and very little (none at all?) code is interlocked, we have to make sure
to meet the programmer's expectations.

this changeset calls the MQTT client loop in the context of the main
loop() and enforces the use of espMqttClientTypes::UseInternalTask::NO.
This commit is contained in:
Bernhard Kirchen 2023-08-01 09:20:04 +02:00 committed by GitHub
parent 587b2dc553
commit 81864b3420
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 11 additions and 2 deletions

View File

@ -10,6 +10,7 @@ class MqttSettingsClass {
public: public:
MqttSettingsClass(); MqttSettingsClass();
void init(); void init();
void loop();
void performReconnect(); void performReconnect();
bool getConnected(); bool getConnected();
void publish(const String& subtopic, const String& payload); void publish(const String& subtopic, const String& payload);

View File

@ -182,15 +182,21 @@ void MqttSettingsClass::init()
createMqttClientObject(); createMqttClientObject();
} }
void MqttSettingsClass::loop()
{
if (nullptr == mqttClient) { return; }
mqttClient->loop();
}
void MqttSettingsClass::createMqttClientObject() void MqttSettingsClass::createMqttClientObject()
{ {
if (mqttClient != nullptr) if (mqttClient != nullptr)
delete mqttClient; delete mqttClient;
const CONFIG_T& config = Configuration.get(); const CONFIG_T& config = Configuration.get();
if (config.Mqtt_Tls) { if (config.Mqtt_Tls) {
mqttClient = static_cast<MqttClient*>(new espMqttClientSecure); mqttClient = new espMqttClientSecure(espMqttClientTypes::UseInternalTask::NO);
} else { } else {
mqttClient = static_cast<MqttClient*>(new espMqttClient); mqttClient = new espMqttClient(espMqttClientTypes::UseInternalTask::NO);
} }
} }

View File

@ -215,6 +215,8 @@ void loop()
VeDirect.loop(); VeDirect.loop();
yield(); yield();
} }
MqttSettings.loop();
yield();
MqttHandleDtu.loop(); MqttHandleDtu.loop();
yield(); yield();
MqttHandleInverter.loop(); MqttHandleInverter.loop();