Defined TimeoutTable for the user to customize timeouts

andreagilardoni · andreagilardoni · commit e1983a0d808d · 2025-05-12T15:15:36.000+02:00
changing the approach from defining a static array CHECK_INTERVAL_TABLE
we can allow the user to change timeout values at runtime depending on
his needs.
diff --git a/src/CatM1ConnectionHandler.cpp b/src/CatM1ConnectionHandler.cpp
@@ -95,7 +95,7 @@ NetworkConnectionState CatM1ConnectionHandler::update_handleConnecting()
   if (ping_result < 0)
   {
     Debug.print(DBG_ERROR, F("Internet check failed"));
-    Debug.print(DBG_INFO, F("Retrying in  \"%d\" milliseconds"), CHECK_INTERVAL_TABLE[static_cast<unsigned int>(NetworkConnectionState::CONNECTING)]);
+    Debug.print(DBG_INFO, F("Retrying in  \"%d\" milliseconds"), _timeoutTable.timeout.connecting);
     return NetworkConnectionState::CONNECTING;
   }
   else
diff --git a/src/CellularConnectionHandler.cpp b/src/CellularConnectionHandler.cpp
@@ -83,7 +83,7 @@ NetworkConnectionState CellularConnectionHandler::update_handleConnecting()
 
   if(getTime() == 0){
     Debug.print(DBG_ERROR, F("Internet check failed"));
-    Debug.print(DBG_INFO, F("Retrying in  \"%d\" milliseconds"), CHECK_INTERVAL_TABLE[static_cast<unsigned int>(NetworkConnectionState::CONNECTING)]);
+    Debug.print(DBG_INFO, F("Retrying in  \"%d\" milliseconds"), _timeoutTable.timeout.connecting);
     return NetworkConnectionState::CONNECTING;
   }
 
diff --git a/src/ConnectionHandlerDefinitions.h b/src/ConnectionHandlerDefinitions.h
@@ -185,21 +185,35 @@ enum class NetworkAdapter {
   NOTECARD
 };
 
+union TimeoutTable {
+  struct {
+    // Note: order of the following values must be preserved
+    // and match against NetworkConnectionState values
+    uint32_t init;
+    uint32_t connecting;
+    uint32_t connected;
+    uint32_t disconnecting;
+    uint32_t disconnected;
+    uint32_t closed;
+    uint32_t error;
+  } timeout;
+  uint32_t intervals[sizeof(timeout) / sizeof(uint32_t)];
+};
+
 /******************************************************************************
    CONSTANTS
  ******************************************************************************/
 
-static unsigned int const CHECK_INTERVAL_TABLE[] =
-{
+constexpr TimeoutTable DefaultTimeoutTable {
 #if defined(BOARD_HAS_NOTECARD) || defined(ARDUINO_ARCH_ESP8266) || defined(ARDUINO_ARCH_ESP32)
-  /* INIT    */ 4000,
+  4000,   // init
 #else
-  /* INIT          */ 500,
-#endif
-  /* CONNECTING    */ 500,
-  /* CONNECTED     */ 10000,
-  /* DISCONNECTING */ 100,
-  /* DISCONNECTED  */ 1000,
-  /* CLOSED        */ 1000,
-  /* ERROR         */ 1000
+  500,    // init
+#endif
+  500,    // connecting
+  10000,  // connected
+  100,    // disconnecting
+  1000,   // disconnected
+  1000,   // closed
+  1000,   // error
 };
diff --git a/src/ConnectionHandlerInterface.cpp b/src/ConnectionHandlerInterface.cpp
@@ -31,6 +31,7 @@ ConnectionHandler::ConnectionHandler(bool const keep_alive, NetworkAdapter inter
 , _lastConnectionTickTime{millis()}
 , _check_internet_availability{false}
 , _current_net_connection_state{NetworkConnectionState::INIT}
+, _timeoutTable(DefaultTimeoutTable)
 {
 
 }
@@ -42,7 +43,8 @@ ConnectionHandler::ConnectionHandler(bool const keep_alive, NetworkAdapter inter
 NetworkConnectionState ConnectionHandler::check()
 {
   unsigned long const now = millis();
-  unsigned int const connectionTickTimeInterval = CHECK_INTERVAL_TABLE[static_cast<unsigned int>(_current_net_connection_state)];
+  unsigned int const connectionTickTimeInterval =
+    _timeoutTable.intervals[static_cast<unsigned int>(_current_net_connection_state)];
 
   if((now - _lastConnectionTickTime) > connectionTickTimeInterval)
   {
diff --git a/src/ConnectionHandlerInterface.h b/src/ConnectionHandlerInterface.h
@@ -31,6 +31,8 @@
 #include "ConnectionHandlerDefinitions.h"
 #include "connectionHandlerModels/settings.h"
 
+#include <utility>
+
 /******************************************************************************
    TYPEDEFS
  ******************************************************************************/
@@ -103,6 +105,9 @@ class ConnectionHandler {
 
     virtual void setKeepAlive(bool keep_alive=true) { this->_keep_alive = keep_alive; }
 
+    void updateTimeoutTable(const TimeoutTable& t) { _timeoutTable = t; }
+    void updateTimeoutTable(TimeoutTable&& t)      { _timeoutTable = std::move(t); }
+
   protected:
 
     virtual NetworkConnectionState updateConnectionState();
@@ -120,6 +125,7 @@ class ConnectionHandler {
 
     models::NetworkSetting _settings;
 
+    TimeoutTable _timeoutTable;
   private:
 
     unsigned long _lastConnectionTickTime;
diff --git a/src/EthernetConnectionHandler.cpp b/src/EthernetConnectionHandler.cpp
@@ -117,7 +117,7 @@ NetworkConnectionState EthernetConnectionHandler::update_handleConnecting()
   if (ping_result < 0)
   {
     Debug.print(DBG_ERROR, F("Internet check failed"));
-    Debug.print(DBG_INFO, F("Retrying in  \"%d\" milliseconds"), CHECK_INTERVAL_TABLE[static_cast<unsigned int>(NetworkConnectionState::CONNECTING)]);
+    Debug.print(DBG_INFO, F("Retrying in  \"%d\" milliseconds"), _timeoutTable.timeout.connecting);
     return NetworkConnectionState::CONNECTING;
   }
   else
diff --git a/src/GSMConnectionHandler.cpp b/src/GSMConnectionHandler.cpp
@@ -117,7 +117,7 @@ NetworkConnectionState GSMConnectionHandler::update_handleConnecting()
   if (ping_result < 0)
   {
     Debug.print(DBG_ERROR, F("PING failed"));
-    Debug.print(DBG_INFO, F("Retrying in  \"%d\" milliseconds"), CHECK_INTERVAL_TABLE[static_cast<unsigned int>(NetworkConnectionState::CONNECTING)]);
+    Debug.print(DBG_INFO, F("Retrying in  \"%d\" milliseconds"), _timeoutTable.timeout.connecting);
     return NetworkConnectionState::CONNECTING;
   }
   else
diff --git a/src/LoRaConnectionHandler.cpp b/src/LoRaConnectionHandler.cpp
@@ -126,7 +126,7 @@ NetworkConnectionState LoRaConnectionHandler::update_handleConnecting()
   if (network_status != true)
   {
     Debug.print(DBG_ERROR, F("Connection to the network failed"));
-    Debug.print(DBG_INFO, F("Retrying in \"%d\" milliseconds"), CHECK_INTERVAL_TABLE[static_cast<unsigned int>(NetworkConnectionState::CONNECTING)]);
+    Debug.print(DBG_INFO, F("Retrying in \"%d\" milliseconds"), _timeoutTable.timeout.connecting);
     return NetworkConnectionState::INIT;
   }
   else
diff --git a/src/NotecardConnectionHandler.cpp b/src/NotecardConnectionHandler.cpp
@@ -518,7 +518,7 @@ NetworkConnectionState NotecardConnectionHandler::update_handleConnecting()
   if (!conn_status.connected_to_notehub) {
     if ((::millis() - _conn_start_ms) > NOTEHUB_CONN_TIMEOUT_MS) {
       Debug.print(DBG_ERROR, F("Timeout exceeded, connection to the network failed."));
-      Debug.print(DBG_INFO, F("Retrying in \"%d\" milliseconds"), CHECK_INTERVAL_TABLE[static_cast<unsigned int>(NetworkConnectionState::CONNECTING)]);
+      Debug.print(DBG_INFO, F("Retrying in \"%d\" milliseconds"), _timeoutTable.timeout.connecting);
       result = NetworkConnectionState::INIT;
     } else {
       // Continue awaiting the connection to Notehub
diff --git a/src/WiFiConnectionHandler.cpp b/src/WiFiConnectionHandler.cpp
@@ -114,7 +114,7 @@ NetworkConnectionState WiFiConnectionHandler::update_handleInit()
   {
 #if !defined(__AVR__)
     Debug.print(DBG_ERROR, F("Connection to \"%s\" failed"), _settings.wifi.ssid);
-    Debug.print(DBG_INFO, F("Retrying in  \"%d\" milliseconds"), CHECK_INTERVAL_TABLE[static_cast<unsigned int>(NetworkConnectionState::INIT)]);
+    Debug.print(DBG_INFO, F("Retrying in  \"%d\" milliseconds"), _timeoutTable.timeout.init);
 #endif
     return NetworkConnectionState::INIT;
   }
@@ -146,7 +146,7 @@ NetworkConnectionState WiFiConnectionHandler::update_handleConnecting()
   if (ping_result < 0)
   {
     Debug.print(DBG_ERROR, F("Internet check failed"));
-    Debug.print(DBG_INFO, F("Retrying in  \"%d\" milliseconds"), CHECK_INTERVAL_TABLE[static_cast<unsigned int>(NetworkConnectionState::CONNECTING)]);
+    Debug.print(DBG_INFO, F("Retrying in  \"%d\" milliseconds"), _timeoutTable.timeout.connecting);
     return NetworkConnectionState::CONNECTING;
   }
   #endif

Original file line number	Diff line number	Diff line change
`@@ -95,7 +95,7 @@ NetworkConnectionState CatM1ConnectionHandler::update_handleConnecting()`
`95`	`95`	`if (ping_result < 0)`
`96`	`96`	`{`
`97`	`97`	`Debug.print(DBG_ERROR, F("Internet check failed"));`
`98`		`- Debug.print(DBG_INFO, F("Retrying in \"%d\" milliseconds"), CHECK_INTERVAL_TABLE[static_cast<unsigned int>(NetworkConnectionState::CONNECTING)]);`
	`98`	`+ Debug.print(DBG_INFO, F("Retrying in \"%d\" milliseconds"), _timeoutTable.timeout.connecting);`
`99`	`99`	`return NetworkConnectionState::CONNECTING;`
`100`	`100`	`}`
`101`	`101`	`else`
Original file line number	Diff line number	Diff line change
`@@ -83,7 +83,7 @@ NetworkConnectionState CellularConnectionHandler::update_handleConnecting()`
`83`	`83`
`84`	`84`	`if(getTime() == 0){`
`85`	`85`	`Debug.print(DBG_ERROR, F("Internet check failed"));`
`86`		`- Debug.print(DBG_INFO, F("Retrying in \"%d\" milliseconds"), CHECK_INTERVAL_TABLE[static_cast<unsigned int>(NetworkConnectionState::CONNECTING)]);`
	`86`	`+ Debug.print(DBG_INFO, F("Retrying in \"%d\" milliseconds"), _timeoutTable.timeout.connecting);`
`87`	`87`	`return NetworkConnectionState::CONNECTING;`
`88`	`88`	`}`
`89`	`89`
Original file line number	Diff line number	Diff line change
`@@ -31,6 +31,7 @@ ConnectionHandler::ConnectionHandler(bool const keep_alive, NetworkAdapter inter`
`31`	`31`	`, _lastConnectionTickTime{millis()}`
`32`	`32`	`, _check_internet_availability{false}`
`33`	`33`	`, _current_net_connection_state{NetworkConnectionState::INIT}`
	`34`	`+, _timeoutTable(DefaultTimeoutTable)`
`34`	`35`	`{`
`35`	`36`
`36`	`37`	`}`
`@@ -42,7 +43,8 @@ ConnectionHandler::ConnectionHandler(bool const keep_alive, NetworkAdapter inter`
`42`	`43`	`NetworkConnectionState ConnectionHandler::check()`
`43`	`44`	`{`
`44`	`45`	`unsigned long const now = millis();`
`45`		`- unsigned int const connectionTickTimeInterval = CHECK_INTERVAL_TABLE[static_cast<unsigned int>(_current_net_connection_state)];`
	`46`	`+ unsigned int const connectionTickTimeInterval =`
	`47`	`+ _timeoutTable.intervals[static_cast<unsigned int>(_current_net_connection_state)];`
`46`	`48`
`47`	`49`	`if((now - _lastConnectionTickTime) > connectionTickTimeInterval)`
`48`	`50`	`{`
Original file line number	Diff line number	Diff line change
`@@ -117,7 +117,7 @@ NetworkConnectionState EthernetConnectionHandler::update_handleConnecting()`
`117`	`117`	`if (ping_result < 0)`
`118`	`118`	`{`
`119`	`119`	`Debug.print(DBG_ERROR, F("Internet check failed"));`
`120`		`- Debug.print(DBG_INFO, F("Retrying in \"%d\" milliseconds"), CHECK_INTERVAL_TABLE[static_cast<unsigned int>(NetworkConnectionState::CONNECTING)]);`
	`120`	`+ Debug.print(DBG_INFO, F("Retrying in \"%d\" milliseconds"), _timeoutTable.timeout.connecting);`
`121`	`121`	`return NetworkConnectionState::CONNECTING;`
`122`	`122`	`}`
`123`	`123`	`else`
Original file line number	Diff line number	Diff line change
`@@ -126,7 +126,7 @@ NetworkConnectionState LoRaConnectionHandler::update_handleConnecting()`
`126`	`126`	`if (network_status != true)`
`127`	`127`	`{`
`128`	`128`	`Debug.print(DBG_ERROR, F("Connection to the network failed"));`
`129`		`- Debug.print(DBG_INFO, F("Retrying in \"%d\" milliseconds"), CHECK_INTERVAL_TABLE[static_cast<unsigned int>(NetworkConnectionState::CONNECTING)]);`
	`129`	`+ Debug.print(DBG_INFO, F("Retrying in \"%d\" milliseconds"), _timeoutTable.timeout.connecting);`
`130`	`130`	`return NetworkConnectionState::INIT;`
`131`	`131`	`}`
`132`	`132`	`else`
Original file line number	Diff line number	Diff line change
`@@ -114,7 +114,7 @@ NetworkConnectionState WiFiConnectionHandler::update_handleInit()`
`114`	`114`	`{`
`115`	`115`	`#if !defined(__AVR__)`
`116`	`116`	`Debug.print(DBG_ERROR, F("Connection to \"%s\" failed"), _settings.wifi.ssid);`
`117`		`- Debug.print(DBG_INFO, F("Retrying in \"%d\" milliseconds"), CHECK_INTERVAL_TABLE[static_cast<unsigned int>(NetworkConnectionState::INIT)]);`
	`117`	`+ Debug.print(DBG_INFO, F("Retrying in \"%d\" milliseconds"), _timeoutTable.timeout.init);`
`118`	`118`	`#endif`
`119`	`119`	`return NetworkConnectionState::INIT;`
`120`	`120`	`}`
`@@ -146,7 +146,7 @@ NetworkConnectionState WiFiConnectionHandler::update_handleConnecting()`
`146`	`146`	`if (ping_result < 0)`
`147`	`147`	`{`
`148`	`148`	`Debug.print(DBG_ERROR, F("Internet check failed"));`
`149`		`- Debug.print(DBG_INFO, F("Retrying in \"%d\" milliseconds"), CHECK_INTERVAL_TABLE[static_cast<unsigned int>(NetworkConnectionState::CONNECTING)]);`
	`149`	`+ Debug.print(DBG_INFO, F("Retrying in \"%d\" milliseconds"), _timeoutTable.timeout.connecting);`
`150`	`150`	`return NetworkConnectionState::CONNECTING;`
`151`	`151`	`}`
`152`	`152`	`#endif`