#StopVsRestart - correct NTRIP/MQTT/Client/Server stops

PaulZC · PaulZC · commit adf20f89af03 · 2024-06-13T16:20:25.000+01:00
diff --git a/Firmware/RTK_Everywhere/MQTT_Client.ino b/Firmware/RTK_Everywhere/MQTT_Client.ino
@@ -504,7 +504,7 @@ void mqttClientUpdate()
         if (mqttClientState > MQTT_CLIENT_OFF)
         {
             systemPrintln("MQTT Client stopping");
-            mqttClientStop(false);
+            mqttClientStop(true); // Was false - #StopVsRestart
             mqttClientConnectionAttempts = 0;
             mqttClientConnectionAttemptTimeout = 0;
             mqttClientSetState(MQTT_CLIENT_OFF);
@@ -533,7 +533,7 @@ void mqttClientUpdate()
         // Determine if the network has failed
         if (networkIsShuttingDown(NETWORK_USER_MQTT_CLIENT))
             // Failed to connect to the network, attempt to restart the network
-            mqttClientRestart();
+            mqttClientStop(true); // Was mqttClientRestart(); - #StopVsRestart
 
         // Determine if the network is connected to the media
         else if (networkUserConnected(NETWORK_USER_MQTT_CLIENT))
@@ -548,7 +548,7 @@ void mqttClientUpdate()
         if (networkIsShuttingDown(NETWORK_USER_MQTT_CLIENT))
         {
             // Failed to connect to the network, attempt to restart the network
-            mqttClientRestart();
+            mqttClientStop(true); // Was mqttClientRestart(); - #StopVsRestart
             break;
         }
 
@@ -652,7 +652,7 @@ void mqttClientUpdate()
         if (networkIsShuttingDown(NETWORK_USER_MQTT_CLIENT))
         {
             // Failed to connect to the network, attempt to restart the network
-            mqttClientRestart();
+            mqttClientStop(true); // Was mqttClientRestart(); - #StopVsRestart
             break;
         }
 
@@ -661,7 +661,7 @@ void mqttClientUpdate()
         {
             mqttClientRestart();
             systemPrintln("ERROR: Subscription to key distribution topic failed!!");
-            mqttClientRestart();
+            mqttClientRestart(); // Why twice? TODO
             break;
         }
 
@@ -678,7 +678,7 @@ void mqttClientUpdate()
         if (networkIsShuttingDown(NETWORK_USER_MQTT_CLIENT))
         {
             // Failed to connect to the network, attempt to restart the network
-            mqttClientRestart();
+            mqttClientStop(true); // Was mqttClientRestart(); - #StopVsRestart
             break;
         }
 
@@ -689,7 +689,7 @@ void mqttClientUpdate()
             {
                 mqttClientRestart();
                 systemPrintln("ERROR: Subscription to corrections topic failed!!");
-                mqttClientRestart();
+                mqttClientRestart(); // Why twice? TODO
                 break;
             }
 
@@ -711,7 +711,7 @@ void mqttClientUpdate()
         if (networkIsShuttingDown(NETWORK_USER_MQTT_CLIENT))
         {
             // Failed to connect to the network, attempt to restart the network
-            mqttClientRestart();
+            mqttClientStop(true); // Was mqttClientRestart(); - #StopVsRestart
             break;
         }
 
diff --git a/Firmware/RTK_Everywhere/Network.ino b/Firmware/RTK_Everywhere/Network.ino
@@ -897,14 +897,14 @@ void networkStop(uint8_t networkType)
                         serverIndex = user - NETWORK_USER_NTRIP_SERVER;
                         if (settings.debugNetworkLayer)
                             systemPrintln("Network layer stopping NTRIP server");
-                        ntripServerRestart(serverIndex);
+                        ntripServerStop(serverIndex, true); // Was ntripServerRestart(serverIndex); - #StopVsRestart
                     }
                     break;
 
                 case NETWORK_USER_MQTT_CLIENT:
                     if (settings.debugNetworkLayer)
                         systemPrintln("Network layer stopping MQTT client");
-                    mqttClientRestart();
+                    mqttClientStop(true); // Was mqttClientRestart(); - #StopVsRestart
                     break;
 
                 case NETWORK_USER_NTP_SERVER:
@@ -916,7 +916,7 @@ void networkStop(uint8_t networkType)
                 case NETWORK_USER_NTRIP_CLIENT:
                     if (settings.debugNetworkLayer)
                         systemPrintln("Network layer stopping NTRIP client");
-                    ntripClientRestart();
+                    ntripClientStop(true); // Was ntripClientRestart(); - #StopVsRestart
                     break;
 
                 case NETWORK_USER_OTA_AUTO_UPDATE:
diff --git a/Firmware/RTK_Everywhere/NtripClient.ino b/Firmware/RTK_Everywhere/NtripClient.ino
@@ -546,7 +546,7 @@ void ntripClientUpdate()
     {
         if (ntripClientState > NTRIP_CLIENT_OFF)
         {
-            ntripClientStop(false);
+            ntripClientStop(true); // Was false - #StopVsRestart
             ntripClientConnectionAttempts = 0;
             ntripClientConnectionAttemptTimeout = 0;
             ntripClientSetState(NTRIP_CLIENT_OFF);
@@ -573,7 +573,7 @@ void ntripClientUpdate()
         // Determine if the network has failed
         if (networkIsShuttingDown(NETWORK_USER_NTRIP_CLIENT))
             // Failed to connect to to the network, attempt to restart the network
-            ntripClientRestart();
+            ntripClientStop(true); // Was ntripClientRestart(); - #StopVsRestart
 
         // Determine if the network is connected to the media
         else if (networkUserConnected(NETWORK_USER_NTRIP_CLIENT))
@@ -600,7 +600,7 @@ void ntripClientUpdate()
         // Determine if the network has failed
         if (networkIsShuttingDown(NETWORK_USER_NTRIP_CLIENT))
             // Failed to connect to to the network, attempt to restart the network
-            ntripClientRestart();
+            ntripClientStop(true); // Was ntripClientRestart(); - #StopVsRestart
 
         // If GGA transmission is enabled, wait for GNSS lock before connecting to NTRIP Caster
         // If GGA transmission is not enabled, start connecting to NTRIP Caster
@@ -633,7 +633,7 @@ void ntripClientUpdate()
         // Determine if the network has failed
         if (networkIsShuttingDown(NETWORK_USER_NTRIP_CLIENT))
             // Failed to connect to to the network, attempt to restart the network
-            ntripClientRestart();
+            ntripClientStop(true); // Was ntripClientRestart(); - #StopVsRestart
 
         // Check for no response from the caster service
         else if (ntripClientReceiveDataAvailable() <
@@ -753,7 +753,7 @@ void ntripClientUpdate()
         // Determine if the network has failed
         if (networkIsShuttingDown(NETWORK_USER_NTRIP_CLIENT))
             // Failed to connect to to the network, attempt to restart the network
-            ntripClientRestart();
+            ntripClientStop(true); // Was ntripClientRestart(); - #StopVsRestart
 
         // Check for a broken connection
         else if (!ntripClient->connected())
diff --git a/Firmware/RTK_Everywhere/NtripServer.ino b/Firmware/RTK_Everywhere/NtripServer.ino
@@ -580,7 +580,7 @@ void ntripServerUpdate(int serverIndex)
     {
         if (ntripServer->state > NTRIP_SERVER_OFF)
         {
-            ntripServerStop(serverIndex, false);
+            ntripServerStop(serverIndex, true); // Was false - #StopVsRestart
             ntripServer->connectionAttempts = 0;
             ntripServer->connectionAttemptTimeout = 0;
             ntripServerSetState(ntripServer, NTRIP_SERVER_OFF);
@@ -610,7 +610,7 @@ void ntripServerUpdate(int serverIndex)
         // Determine if the network has failed
         if (networkIsShuttingDown(NETWORK_USER_NTRIP_SERVER + serverIndex))
             // Failed to connect to to the network, attempt to restart the network
-            ntripServerRestart(serverIndex);
+            ntripServerStop(serverIndex, true); // Was ntripServerRestart(serverIndex); - #StopVsRestart
 
         // Determine if the network is connected to the media
         else if (networkUserConnected(NETWORK_USER_NTRIP_SERVER + serverIndex))
@@ -638,7 +638,7 @@ void ntripServerUpdate(int serverIndex)
         // Determine if the network has failed
         if (networkIsShuttingDown(NETWORK_USER_NTRIP_SERVER + serverIndex))
             // Failed to connect to to the network, attempt to restart the network
-            ntripServerRestart(serverIndex);
+            ntripServerStop(serverIndex, true); // Was ntripServerRestart(serverIndex); - #StopVsRestart
 
         else if (settings.enableNtripServer &&
                  (millis() - ntripServer->lastConnectionAttempt > ntripServer->connectionAttemptTimeout))
@@ -656,7 +656,7 @@ void ntripServerUpdate(int serverIndex)
         // Determine if the network has failed
         if (networkIsShuttingDown(NETWORK_USER_NTRIP_SERVER + serverIndex))
             // Failed to connect to to the network, attempt to restart the network
-            ntripServerRestart(serverIndex);
+            ntripServerStop(serverIndex, true); // Was ntripServerRestart(serverIndex); - #StopVsRestart
 
         // State change handled in ntripServerProcessRTCM
         break;
@@ -666,7 +666,7 @@ void ntripServerUpdate(int serverIndex)
         // Determine if the network has failed
         if (networkIsShuttingDown(NETWORK_USER_NTRIP_SERVER + serverIndex))
             // Failed to connect to to the network, attempt to restart the network
-            ntripServerRestart(serverIndex);
+            ntripServerStop(serverIndex, true); // Was ntripServerRestart(serverIndex); - #StopVsRestart
 
         // Delay before opening the NTRIP server connection
         else if ((millis() - ntripServer->timer) >= ntripServer->connectionAttemptTimeout)
@@ -694,7 +694,7 @@ void ntripServerUpdate(int serverIndex)
         // Determine if the network has failed
         if (networkIsShuttingDown(NETWORK_USER_NTRIP_SERVER + serverIndex))
             // Failed to connect to to the network, attempt to restart the network
-            ntripServerRestart(serverIndex);
+            ntripServerStop(serverIndex, true); // Was ntripServerRestart(serverIndex); - #StopVsRestart
 
         // Check if caster service responded
         else if (ntripServer->networkClient->available() <
@@ -788,7 +788,7 @@ void ntripServerUpdate(int serverIndex)
         // Determine if the network has failed
         if (networkIsShuttingDown(NETWORK_USER_NTRIP_SERVER + serverIndex))
             // Failed to connect to the network, attempt to restart the network
-            ntripServerRestart(serverIndex);
+            ntripServerStop(serverIndex, true); // Was ntripServerRestart(serverIndex); - #StopVsRestart
 
         // Check for a broken connection
         else if (!ntripServer->networkClient->connected())

Original file line number	Diff line number	Diff line change
`@@ -504,7 +504,7 @@ void mqttClientUpdate()`
`504`	`504`	`if (mqttClientState > MQTT_CLIENT_OFF)`
`505`	`505`	`{`
`506`	`506`	`systemPrintln("MQTT Client stopping");`
`507`		`- mqttClientStop(false);`
	`507`	`+ mqttClientStop(true); // Was false - #StopVsRestart`
`508`	`508`	`mqttClientConnectionAttempts = 0;`
`509`	`509`	`mqttClientConnectionAttemptTimeout = 0;`
`510`	`510`	`mqttClientSetState(MQTT_CLIENT_OFF);`
`@@ -533,7 +533,7 @@ void mqttClientUpdate()`
`533`	`533`	`// Determine if the network has failed`
`534`	`534`	`if (networkIsShuttingDown(NETWORK_USER_MQTT_CLIENT))`
`535`	`535`	`// Failed to connect to the network, attempt to restart the network`
`536`		`- mqttClientRestart();`
	`536`	`+ mqttClientStop(true); // Was mqttClientRestart(); - #StopVsRestart`
`537`	`537`
`538`	`538`	`// Determine if the network is connected to the media`
`539`	`539`	`else if (networkUserConnected(NETWORK_USER_MQTT_CLIENT))`
`@@ -548,7 +548,7 @@ void mqttClientUpdate()`
`548`	`548`	`if (networkIsShuttingDown(NETWORK_USER_MQTT_CLIENT))`
`549`	`549`	`{`
`550`	`550`	`// Failed to connect to the network, attempt to restart the network`
`551`		`- mqttClientRestart();`
	`551`	`+ mqttClientStop(true); // Was mqttClientRestart(); - #StopVsRestart`
`552`	`552`	`break;`
`553`	`553`	`}`
`554`	`554`
`@@ -652,7 +652,7 @@ void mqttClientUpdate()`
`652`	`652`	`if (networkIsShuttingDown(NETWORK_USER_MQTT_CLIENT))`
`653`	`653`	`{`
`654`	`654`	`// Failed to connect to the network, attempt to restart the network`
`655`		`- mqttClientRestart();`
	`655`	`+ mqttClientStop(true); // Was mqttClientRestart(); - #StopVsRestart`
`656`	`656`	`break;`
`657`	`657`	`}`
`658`	`658`
`@@ -661,7 +661,7 @@ void mqttClientUpdate()`
`661`	`661`	`{`
`662`	`662`	`mqttClientRestart();`
`663`	`663`	`systemPrintln("ERROR: Subscription to key distribution topic failed!!");`
`664`		`- mqttClientRestart();`
	`664`	`+ mqttClientRestart(); // Why twice? TODO`
`665`	`665`	`break;`
`666`	`666`	`}`
`667`	`667`
`@@ -678,7 +678,7 @@ void mqttClientUpdate()`
`678`	`678`	`if (networkIsShuttingDown(NETWORK_USER_MQTT_CLIENT))`
`679`	`679`	`{`
`680`	`680`	`// Failed to connect to the network, attempt to restart the network`
`681`		`- mqttClientRestart();`
	`681`	`+ mqttClientStop(true); // Was mqttClientRestart(); - #StopVsRestart`
`682`	`682`	`break;`
`683`	`683`	`}`
`684`	`684`
`@@ -689,7 +689,7 @@ void mqttClientUpdate()`
`689`	`689`	`{`
`690`	`690`	`mqttClientRestart();`
`691`	`691`	`systemPrintln("ERROR: Subscription to corrections topic failed!!");`
`692`		`- mqttClientRestart();`
	`692`	`+ mqttClientRestart(); // Why twice? TODO`
`693`	`693`	`break;`
`694`	`694`	`}`
`695`	`695`
`@@ -711,7 +711,7 @@ void mqttClientUpdate()`
`711`	`711`	`if (networkIsShuttingDown(NETWORK_USER_MQTT_CLIENT))`
`712`	`712`	`{`
`713`	`713`	`// Failed to connect to the network, attempt to restart the network`
`714`		`- mqttClientRestart();`
	`714`	`+ mqttClientStop(true); // Was mqttClientRestart(); - #StopVsRestart`
`715`	`715`	`break;`
`716`	`716`	`}`
`717`	`717`