Make NTRIP_SERVER_DATA ntripServerArray[] volatile - prevents unneeded disconnects "due to lack of RTCM data"

Author: PaulZC

Firmware/RTK_Everywhere/NtripServer.ino

@@ -173,7 +173,7 @@ const RtkMode_t ntripServerMode = RTK_MODE_BASE_FIXED;
 //----------------------------------------
 
 // NTRIP Servers
-static NTRIP_SERVER_DATA ntripServerArray[NTRIP_SERVER_MAX];
+volatile static NTRIP_SERVER_DATA ntripServerArray[NTRIP_SERVER_MAX];
 
 //----------------------------------------
 // NTRIP Server Routines
@@ -184,7 +184,7 @@ static NTRIP_SERVER_DATA ntripServerArray[NTRIP_SERVER_MAX];
 //----------------------------------------
 bool ntripServerConnectCaster(int serverIndex)
 {
-    NTRIP_SERVER_DATA *ntripServer = &ntripServerArray[serverIndex];
+    volatile NTRIP_SERVER_DATA *ntripServer = &ntripServerArray[serverIndex];
     const int SERVER_BUFFER_SIZE = 512;
     char serverBuffer[SERVER_BUFFER_SIZE];
 
@@ -239,7 +239,7 @@ bool ntripServerConnectLimitReached(int serverIndex)
 {
     bool limitReached;
     int minutes;
-    NTRIP_SERVER_DATA *ntripServer = &ntripServerArray[serverIndex];
+    volatile NTRIP_SERVER_DATA *ntripServer = &ntripServerArray[serverIndex];
     int seconds;
 
     // Retry the connection a few times
@@ -249,8 +249,8 @@ bool ntripServerConnectLimitReached(int serverIndex)
     // Shutdown the NTRIP server
     ntripServerStop(serverIndex, limitReached || (!ntripServerEnabled(serverIndex, nullptr)));
 
-    ntripServer->connectionAttempts++;
-    ntripServer->connectionAttemptsTotal++;
+    ntripServer->connectionAttempts = ntripServer->connectionAttempts + 1;
+    ntripServer->connectionAttemptsTotal = ntripServer->connectionAttemptsTotal + 1;
     if (settings.debugNtripServerState)
         ntripServerPrintStatus(serverIndex);
 
@@ -334,7 +334,7 @@ bool ntripServerEnabled(int serverIndex, const char ** line)
 //----------------------------------------
 void ntripServerPrintStateSummary(int serverIndex)
 {
-    NTRIP_SERVER_DATA *ntripServer = &ntripServerArray[serverIndex];
+    volatile NTRIP_SERVER_DATA *ntripServer = &ntripServerArray[serverIndex];
 
     switch (ntripServer->state)
     {
@@ -362,7 +362,7 @@ void ntripServerPrintStateSummary(int serverIndex)
 //----------------------------------------
 void ntripServerPrintStatus(int serverIndex)
 {
-    NTRIP_SERVER_DATA *ntripServer = &ntripServerArray[serverIndex];
+    volatile NTRIP_SERVER_DATA *ntripServer = &ntripServerArray[serverIndex];
     uint64_t milliseconds;
     uint32_t days;
     byte hours;
@@ -410,7 +410,7 @@ void ntripServerPrintStatus(int serverIndex)
 //----------------------------------------
 void ntripServerProcessRTCM(int serverIndex, uint8_t incoming)
 {
-    NTRIP_SERVER_DATA *ntripServer = &ntripServerArray[serverIndex];
+    volatile NTRIP_SERVER_DATA *ntripServer = &ntripServerArray[serverIndex];
 
     if (ntripServer->state == NTRIP_SERVER_CASTING)
     {
@@ -445,8 +445,8 @@ void ntripServerProcessRTCM(int serverIndex, uint8_t incoming)
         if (ntripServer->networkClient && ntripServer->networkClient->connected())
         {
             ntripServer->networkClient->write(incoming); // Send this byte to socket
-            ntripServer->bytesSent++;
-            ntripServer->rtcmBytesSent++;
+            ntripServer->bytesSent = ntripServer->bytesSent + 1;
+            ntripServer->rtcmBytesSent = ntripServer->rtcmBytesSent + 1;
             ntripServer->timer = millis();
             netOutgoingRTCM = true;
         }
@@ -464,7 +464,7 @@ void ntripServerProcessRTCM(int serverIndex, uint8_t incoming)
 //----------------------------------------
 void ntripServerResponse(int serverIndex, char *response, size_t maxLength)
 {
-    NTRIP_SERVER_DATA *ntripServer = &ntripServerArray[serverIndex];
+    volatile NTRIP_SERVER_DATA *ntripServer = &ntripServerArray[serverIndex];
     char *responseEnd;
 
     // Make sure that we can zero terminate the response
@@ -483,7 +483,7 @@ void ntripServerResponse(int serverIndex, char *response, size_t maxLength)
 //----------------------------------------
 void ntripServerRestart(int serverIndex)
 {
-    NTRIP_SERVER_DATA *ntripServer = &ntripServerArray[serverIndex];
+    volatile NTRIP_SERVER_DATA *ntripServer = &ntripServerArray[serverIndex];
 
     // Save the previous uptime value
     if (ntripServer->state == NTRIP_SERVER_CASTING)
@@ -496,7 +496,7 @@ void ntripServerRestart(int serverIndex)
 //----------------------------------------
 void ntripServerSetState(int serverIndex, uint8_t newState)
 {
-    NTRIP_SERVER_DATA * ntripServer;
+    volatile NTRIP_SERVER_DATA * ntripServer;
 
     ntripServer = &ntripServerArray[serverIndex];
     if (settings.debugNtripServerState)
@@ -548,7 +548,7 @@ void ntripServerStop(int serverIndex, bool shutdown)
 {
     bool enabled;
     int index;
-    NTRIP_SERVER_DATA *ntripServer = &ntripServerArray[serverIndex];
+    volatile NTRIP_SERVER_DATA *ntripServer = &ntripServerArray[serverIndex];
 
     if (ntripServer->networkClient)
     {
@@ -612,7 +612,7 @@ void ntripServerUpdate(int serverIndex)
     const char * line = "";
 
     // Get the NTRIP data structure
-    NTRIP_SERVER_DATA *ntripServer = &ntripServerArray[serverIndex];
+    volatile NTRIP_SERVER_DATA *ntripServer = &ntripServerArray[serverIndex];
 
     // Shutdown the NTRIP server when the mode or setting changes
     DMW_if

Firmware/RTK_Everywhere/settings.h

@@ -358,12 +358,12 @@ enum PeriodDisplayValues
 
 #ifdef  COMPILE_NETWORK
 
-// NTRIP Server data
-typedef struct _NTRIP_SERVER_DATA
+// NTRIP Server data - the array is declared volatile in NtripServer.ino
+typedef struct
 {
     // Network connection used to push RTCM to NTRIP caster
     NetworkClient *networkClient;
-    volatile uint8_t state;
+    uint8_t state;
 
     // Count of bytes sent by the NTRIP server to the NTRIP caster
     uint32_t bytesSent;