Function 'check()' directly returns the NetworkConnectionState which eliminates the need to query the member variable NetConnectionStatus via 'getStatus()'

Author: aentinger

src/Arduino_ConnectionHandler.h

@@ -137,7 +137,7 @@ typedef void (*OnNetworkEventCallback)(void * /* arg */);
 class ConnectionHandler {
   public:
     virtual void init() = 0;
-    virtual void check() = 0;
+    virtual NetworkConnectionState check() = 0;
 
     #if defined(BOARD_HAS_WIFI) || defined(BOARD_HAS_GSM) || defined(BOARD_HAS_NB)
       virtual unsigned long getTime() = 0;

src/Arduino_GSMConnectionHandler.cpp

@@ -71,7 +71,7 @@ unsigned long GSMConnectionHandler::getTime() {
   return gsmAccess.getTime();
 }
 
-void GSMConnectionHandler::check() {
+NetworkConnectionState GSMConnectionHandler::check() {
   unsigned long const now = millis();
   int gsmAccessAlive;
   if (now - lastConnectionTickTime > connectionTickTimeInterval) {
@@ -89,7 +89,7 @@ void GSMConnectionHandler::check() {
           if (networkStatus == GSM3_NetworkStatus_t::ERROR) {
             // NO FURTHER ACTION WILL FOLLOW THIS
             changeConnectionState(NetworkConnectionState::ERROR);
-            return;
+            return netConnectionState;
           }
           Debug.print(DBG_INFO, "Sending PING to outer space...");
           int pingResult;
@@ -98,11 +98,11 @@ void GSMConnectionHandler::check() {
           if (pingResult < 0) {
             Debug.print(DBG_ERROR, "PING failed");
             Debug.print(DBG_INFO, "Retrying in  \"%d\" milliseconds", connectionTickTimeInterval);
-            return;
+            return netConnectionState;
           } else {
             Debug.print(DBG_INFO, "Connected to GPRS Network");
             changeConnectionState(NetworkConnectionState::CONNECTED);
-            return;
+            return netConnectionState;
           }
         }
         break;
@@ -111,7 +111,7 @@ void GSMConnectionHandler::check() {
           Debug.print(DBG_VERBOSE, "GPRS.isAccessAlive(): %d", gsmAccessAlive);
           if (gsmAccessAlive != 1) {
             changeConnectionState(NetworkConnectionState::DISCONNECTED);
-            return;
+            return netConnectionState;
           }
           Debug.print(DBG_VERBOSE, "Connected to Cellular Network");
         }
@@ -130,6 +130,8 @@ void GSMConnectionHandler::check() {
     }
     lastConnectionTickTime = now;
   }
+
+  return netConnectionState;
 }
 
 /******************************************************************************

src/Arduino_GSMConnectionHandler.h

@@ -37,7 +37,7 @@ class GSMConnectionHandler : public TcpIpConnectionHandler {
 
     virtual void init();
     virtual unsigned long getTime();
-    virtual void check();
+    virtual NetworkConnectionState check();
     virtual Client &getClient() {
       return networkClient;
     };

src/Arduino_LPWANConnectionHandler.h

@@ -32,7 +32,7 @@
 class LPWANConnectionHandler : public ConnectionHandler {
   public:
     virtual void init() = 0;
-    virtual void check();
+    virtual NetworkConnectionState check();
     virtual unsigned long getTime() = 0;
 
     virtual int write(const uint8_t *buf, size_t size) = 0;

src/Arduino_LoRaConnectionHandler.cpp

@@ -104,7 +104,7 @@ bool LoRaConnectionHandler::available() {
   return modem.available();
 }
 
-void LoRaConnectionHandler::check() {
+NetworkConnectionState LoRaConnectionHandler::check() {
 
   unsigned long const now = millis();
   int networkStatus = 0;
@@ -121,6 +121,8 @@ void LoRaConnectionHandler::check() {
       case NetworkConnectionState::CLOSED:                                                           break;
     }
   }
+
+  return netConnectionState;
 }
 
 /******************************************************************************

src/Arduino_LoRaConnectionHandler.h

@@ -46,7 +46,7 @@ class LoRaConnectionHandler : public LPWANConnectionHandler {
 
     void init();
     unsigned long getTime();
-    void check();
+    NetworkConnectionState check();
 
     int write(const uint8_t *buf, size_t size);
     int read();

src/Arduino_NBConnectionHandler.cpp

@@ -78,7 +78,7 @@ unsigned long NBConnectionHandler::getTime() {
   return nbAccess.getTime();
 }
 
-void NBConnectionHandler::check() {
+NetworkConnectionState NBConnectionHandler::check() {
   unsigned long const now = millis();
   int nbAccessAlive;
   if (now - lastConnectionTickTime > connectionTickTimeInterval) {
@@ -96,7 +96,7 @@ void NBConnectionHandler::check() {
           if (networkStatus == NB_NetworkStatus_t::ERROR) {
             // NO FURTHER ACTION WILL FOLLOW THIS
             changeConnectionState(NetworkConnectionState::ERROR);
-            return;
+            return netConnectionState;
           }
           Debug.print(DBG_INFO, "Sending PING to outer space...");
           int pingResult;
@@ -106,11 +106,11 @@ void NBConnectionHandler::check() {
           if (pingResult < 0) {
             Debug.print(DBG_ERROR, "PING failed");
             Debug.print(DBG_INFO, "Retrying in  \"%d\" milliseconds", connectionTickTimeInterval);
-            return;
+            return netConnectionState;
           } else {
             Debug.print(DBG_INFO, "Connected to GPRS Network");
             changeConnectionState(NetworkConnectionState::CONNECTED);
-            return;
+            return netConnectionState;
           }
         }
         break;
@@ -119,7 +119,7 @@ void NBConnectionHandler::check() {
           Debug.print(DBG_VERBOSE, "GPRS.isAccessAlive(): %d", nbAccessAlive);
           if (nbAccessAlive != 1) {
             changeConnectionState(NetworkConnectionState::DISCONNECTED);
-            return;
+            return netConnectionState;
           }
           Debug.print(DBG_VERBOSE, "Connected to Cellular Network");
         }
@@ -138,6 +138,8 @@ void NBConnectionHandler::check() {
     }
     lastConnectionTickTime = now;
   }
+
+  return netConnectionState;
 }
 
 /******************************************************************************

src/Arduino_NBConnectionHandler.h

@@ -38,7 +38,7 @@ class NBConnectionHandler : public TcpIpConnectionHandler {
 
     virtual void init();
     virtual unsigned long getTime();
-    virtual void check();
+    virtual NetworkConnectionState check();
     virtual Client &getClient() {
       return networkClient;
     };

src/Arduino_TcpIpConnectionHandler.h

@@ -35,7 +35,7 @@
 class TcpIpConnectionHandler : public ConnectionHandler {
   public:
     virtual void init() = 0;
-    virtual void check() = 0;
+    virtual NetworkConnectionState check() = 0;
     virtual unsigned long getTime() = 0;
     virtual Client &getClient() = 0;
     virtual UDP &getUDP() = 0;

src/Arduino_WiFiConnectionHandler.cpp

@@ -50,7 +50,7 @@ unsigned long WiFiConnectionHandler::getTime() {
 #endif
 }
 
-void WiFiConnectionHandler::check() {
+NetworkConnectionState WiFiConnectionHandler::check() {
 
   unsigned long const now = millis();
   if((now - lastConnectionTickTime) > connectionTickTimeInterval)
@@ -68,6 +68,8 @@ void WiFiConnectionHandler::check() {
       case NetworkConnectionState::CLOSED:                                                           break;
     }
   }
+
+  return netConnectionState;
 }
 
 /******************************************************************************