Merge pull request #25 from arduino-libraries/return-network-state-in-check-method

aentinger · web-flow · commit 6a87f58c9aab · 2020-03-05T06:50:07.000+01:00
Return the connection state directly when calling function check()
diff --git a/examples/ConnectionHandlerDemo/ConnectionHandlerDemo.ino b/examples/ConnectionHandlerDemo/ConnectionHandlerDemo.ino
@@ -51,7 +51,7 @@ void loop() {
    * object.
    */
 
-  conMan.update();
+  conMan.check();
 }
 
 void onNetworkConnect(void *_arg) {
diff --git a/src/Arduino_ConnectionHandler.h b/src/Arduino_ConnectionHandler.h
@@ -137,20 +137,25 @@ typedef void (*OnNetworkEventCallback)(void * /* arg */);
 class ConnectionHandler {
   public:
     virtual void init() = 0;
-    virtual void check() = 0;
-    virtual void update() __attribute__((deprecated)) = 0; /* use 'check()' instead */
+    virtual NetworkConnectionState check() = 0;
 
     #if defined(BOARD_HAS_WIFI) || defined(BOARD_HAS_GSM) || defined(BOARD_HAS_NB)
       virtual unsigned long getTime() = 0;
       virtual Client &getClient() = 0;
       virtual UDP &getUDP() = 0;
     #endif
 
-    virtual NetworkConnectionState getStatus() {
+    #if defined(BOARD_HAS_LORA)
+      virtual int write(const uint8_t *buf, size_t size) = 0;
+      virtual int read() = 0;
+      virtual bool available() = 0;
+    #endif
+
+    virtual NetworkConnectionState getStatus() __attribute__((deprecated)) {
       return netConnectionState;
     }
-    virtual void connect();
-    virtual void disconnect();
+    virtual void connect() = 0;
+    virtual void disconnect() = 0;
     void addCallback(NetworkConnectionEvent const event, OnNetworkEventCallback callback);
     void addConnectCallback(OnNetworkEventCallback callback);
     void addDisconnectCallback(OnNetworkEventCallback callback);
@@ -168,12 +173,14 @@ class ConnectionHandler {
 
 };
 
-#if defined(BOARD_HAS_WIFI) || defined(BOARD_HAS_GSM) || defined(BOARD_HAS_NB)
-  #include "Arduino_TcpIpConnectionHandler.h"
-#endif
-
-#if defined(ARDUINO_SAMD_MKRWAN1300) || defined(ARDUINO_SAMD_MKRWAN1310)
-  #include "Arduino_LPWANConnectionHandler.h"
+#if defined(BOARD_HAS_WIFI)
+  #include "Arduino_WiFiConnectionHandler.h"
+#elif defined(BOARD_HAS_GSM)
+  #include "Arduino_GSMConnectionHandler.h"
+#elif defined(BOARD_HAS_NB)
+  #include "Arduino_NBConnectionHandler.h"
+#elif defined(BOARD_HAS_LORA)
+  #include "Arduino_LoRaConnectionHandler.h"
 #endif
 
 #endif /* CONNECTION_HANDLER_H_ */
diff --git a/src/Arduino_GSMConnectionHandler.cpp b/src/Arduino_GSMConnectionHandler.cpp
@@ -71,7 +71,7 @@ unsigned long GSMConnectionHandler::getTime() {
   return gsmAccess.getTime();
 }
 
-void GSMConnectionHandler::update() {
+NetworkConnectionState GSMConnectionHandler::check() {
   unsigned long const now = millis();
   int gsmAccessAlive;
   if (now - lastConnectionTickTime > connectionTickTimeInterval) {
@@ -89,7 +89,7 @@ void GSMConnectionHandler::update() {
           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::update() {
           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::update() {
           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::update() {
     }
     lastConnectionTickTime = now;
   }
+
+  return netConnectionState;
 }
 
 /******************************************************************************
diff --git a/src/Arduino_GSMConnectionHandler.h b/src/Arduino_GSMConnectionHandler.h
@@ -22,7 +22,7 @@
    INCLUDE
  ******************************************************************************/
 
-#include "Arduino_TcpIpConnectionHandler.h"
+#include "Arduino_ConnectionHandler.h"
 
 
 #ifdef BOARD_HAS_GSM /* Only compile if this is a board with GSM */
@@ -31,16 +31,13 @@
    CLASS DECLARATION
  ******************************************************************************/
 
-class GSMConnectionHandler : public TcpIpConnectionHandler {
+class GSMConnectionHandler : public ConnectionHandler {
   public:
     GSMConnectionHandler(const char *pin, const char *apn, const char *login, const char *pass, const bool keepAlive = true);
 
     virtual void init();
     virtual unsigned long getTime();
-    virtual void check() {
-      update();
-    }
-    virtual void update() __attribute__((deprecated)); /* use 'check()' instead */
+    virtual NetworkConnectionState check();
     virtual Client &getClient() {
       return networkClient;
     };
@@ -77,6 +74,8 @@ class GSMConnectionHandler : public TcpIpConnectionHandler {
 
 };
 
+typedef GSMConnectionHandler TcpIpConnectionHandler;
+
 #endif /* #ifdef BOARD_HAS_GSM  */
 
 #endif /* #ifndef GSM_CONNECTION_MANAGER_H_ */
diff --git a/src/Arduino_LPWANConnectionHandler.h b/src/Arduino_LPWANConnectionHandler.h
diff --git a/src/Arduino_LoRaConnectionHandler.cpp b/src/Arduino_LoRaConnectionHandler.cpp
@@ -104,7 +104,7 @@ bool LoRaConnectionHandler::available() {
   return modem.available();
 }
 
-void LoRaConnectionHandler::update() {
+NetworkConnectionState LoRaConnectionHandler::check() {
 
   unsigned long const now = millis();
   int networkStatus = 0;
@@ -121,6 +121,8 @@ void LoRaConnectionHandler::update() {
       case NetworkConnectionState::CLOSED:                                                           break;
     }
   }
+
+  return netConnectionState;
 }
 
 /******************************************************************************
diff --git a/src/Arduino_LoRaConnectionHandler.h b/src/Arduino_LoRaConnectionHandler.h
@@ -22,7 +22,7 @@
    INCLUDE
  ******************************************************************************/
 
-#include "Arduino_LPWANConnectionHandler.h"
+#include "Arduino_ConnectionHandler.h"
 
 typedef enum {
   LORA_ERROR_ACK_NOT_RECEIVED = -1,
@@ -40,23 +40,20 @@ typedef enum {
    CLASS DECLARATION
  ******************************************************************************/
 
-class LoRaConnectionHandler : public LPWANConnectionHandler {
+class LoRaConnectionHandler : public ConnectionHandler {
   public:
     LoRaConnectionHandler(const char *_appeui, const char *_appkey, _lora_band = _lora_band::EU868, _lora_class = _lora_class::CLASS_A);
 
-    void init();
-    unsigned long getTime();
-    void check() {
-      update();
-    }
-    void update() __attribute__((deprecated)); /* use 'check()' instead */
+    virtual void init();
+    virtual unsigned long getTime();
+    virtual NetworkConnectionState check();
 
-    int write(const uint8_t *buf, size_t size);
-    int read();
-    bool available();
+    virtual int write(const uint8_t *buf, size_t size);
+    virtual int read();
+    virtual bool available();
 
-    void disconnect();
-    void connect();
+    virtual void disconnect();
+    virtual void connect();
 
   private:
 
@@ -89,4 +86,6 @@ class LoRaConnectionHandler : public LPWANConnectionHandler {
 
 };
 
+typedef LoRaConnectionHandler LPWANConnectionHandler;
+
 #endif /* ARDUINO_LORA_CONNECTION_HANDLER_H_ */
diff --git a/src/Arduino_NBConnectionHandler.cpp b/src/Arduino_NBConnectionHandler.cpp
@@ -78,7 +78,7 @@ unsigned long NBConnectionHandler::getTime() {
   return nbAccess.getTime();
 }
 
-void NBConnectionHandler::update() {
+NetworkConnectionState NBConnectionHandler::check() {
   unsigned long const now = millis();
   int nbAccessAlive;
   if (now - lastConnectionTickTime > connectionTickTimeInterval) {
@@ -96,7 +96,7 @@ void NBConnectionHandler::update() {
           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::update() {
           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::update() {
           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::update() {
     }
     lastConnectionTickTime = now;
   }
+
+  return netConnectionState;
 }
 
 /******************************************************************************
diff --git a/src/Arduino_NBConnectionHandler.h b/src/Arduino_NBConnectionHandler.h
@@ -30,18 +30,15 @@
    CLASS DECLARATION
  ******************************************************************************/
 
-class NBConnectionHandler : public TcpIpConnectionHandler {
+class NBConnectionHandler : public ConnectionHandler {
   public:
     NBConnectionHandler(const char *pin, const bool keepAlive = true);
     NBConnectionHandler(const char *pin, const char *apn, const bool keepAlive = true);
     NBConnectionHandler(const char *pin, const char *apn, const char *login, const char *pass, const bool keepAlive = true);
 
     virtual void init();
     virtual unsigned long getTime();
-    virtual void check() {
-      update();
-    }
-    virtual void update() __attribute__((deprecated)); /* use 'update()' instead */
+    virtual NetworkConnectionState check();
     virtual Client &getClient() {
       return networkClient;
     };
@@ -78,6 +75,8 @@ class NBConnectionHandler : public TcpIpConnectionHandler {
 
 };
 
+typedef NBConnectionHandler TcpIpConnectionHandler;
+
 #endif /* #ifdef BOARD_HAS_NB  */
 
 #endif /* #ifndef NB_CONNECTION_MANAGER_H_ */
diff --git a/src/Arduino_TcpIpConnectionHandler.h b/src/Arduino_TcpIpConnectionHandler.h
diff --git a/src/Arduino_WiFiConnectionHandler.cpp b/src/Arduino_WiFiConnectionHandler.cpp
diff --git a/src/Arduino_WiFiConnectionHandler.h b/src/Arduino_WiFiConnectionHandler.h

Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ void loop() {`
`51`	`51`	`* object.`
`52`	`52`	`*/`
`53`	`53`
`54`		`- conMan.update();`
	`54`	`+ conMan.check();`
`55`	`55`	`}`
`56`	`56`
`57`	`57`	`void onNetworkConnect(void *_arg) {`
Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ unsigned long GSMConnectionHandler::getTime() {`
`71`	`71`	`return gsmAccess.getTime();`
`72`	`72`	`}`
`73`	`73`
`74`		`-void GSMConnectionHandler::update() {`
	`74`	`+NetworkConnectionState GSMConnectionHandler::check() {`
`75`	`75`	`unsigned long const now = millis();`
`76`	`76`	`int gsmAccessAlive;`
`77`	`77`	`if (now - lastConnectionTickTime > connectionTickTimeInterval) {`
`@@ -89,7 +89,7 @@ void GSMConnectionHandler::update() {`
`89`	`89`	`if (networkStatus == GSM3_NetworkStatus_t::ERROR) {`
`90`	`90`	`// NO FURTHER ACTION WILL FOLLOW THIS`
`91`	`91`	`changeConnectionState(NetworkConnectionState::ERROR);`
`92`		`- return;`
	`92`	`+ return netConnectionState;`
`93`	`93`	`}`
`94`	`94`	`Debug.print(DBG_INFO, "Sending PING to outer space...");`
`95`	`95`	`int pingResult;`
`@@ -98,11 +98,11 @@ void GSMConnectionHandler::update() {`
`98`	`98`	`if (pingResult < 0) {`
`99`	`99`	`Debug.print(DBG_ERROR, "PING failed");`
`100`	`100`	`Debug.print(DBG_INFO, "Retrying in \"%d\" milliseconds", connectionTickTimeInterval);`
`101`		`- return;`
	`101`	`+ return netConnectionState;`
`102`	`102`	`} else {`
`103`	`103`	`Debug.print(DBG_INFO, "Connected to GPRS Network");`
`104`	`104`	`changeConnectionState(NetworkConnectionState::CONNECTED);`
`105`		`- return;`
	`105`	`+ return netConnectionState;`
`106`	`106`	`}`
`107`	`107`	`}`
`108`	`108`	`break;`
`@@ -111,7 +111,7 @@ void GSMConnectionHandler::update() {`
`111`	`111`	`Debug.print(DBG_VERBOSE, "GPRS.isAccessAlive(): %d", gsmAccessAlive);`
`112`	`112`	`if (gsmAccessAlive != 1) {`
`113`	`113`	`changeConnectionState(NetworkConnectionState::DISCONNECTED);`
`114`		`- return;`
	`114`	`+ return netConnectionState;`
`115`	`115`	`}`
`116`	`116`	`Debug.print(DBG_VERBOSE, "Connected to Cellular Network");`
`117`	`117`	`}`
`@@ -130,6 +130,8 @@ void GSMConnectionHandler::update() {`
`130`	`130`	`}`
`131`	`131`	`lastConnectionTickTime = now;`
`132`	`132`	`}`
	`133`	`+`
	`134`	`+ return netConnectionState;`
`133`	`135`	`}`
`134`	`136`
`135`	`137`	`/******************************************************************************`
Original file line number	Diff line number	Diff line change
`@@ -104,7 +104,7 @@ bool LoRaConnectionHandler::available() {`
`104`	`104`	`return modem.available();`
`105`	`105`	`}`
`106`	`106`
`107`		`-void LoRaConnectionHandler::update() {`
	`107`	`+NetworkConnectionState LoRaConnectionHandler::check() {`
`108`	`108`
`109`	`109`	`unsigned long const now = millis();`
`110`	`110`	`int networkStatus = 0;`
`@@ -121,6 +121,8 @@ void LoRaConnectionHandler::update() {`
`121`	`121`	`case NetworkConnectionState::CLOSED: break;`
`122`	`122`	`}`
`123`	`123`	`}`
	`124`	`+`
	`125`	`+ return netConnectionState;`
`124`	`126`	`}`
`125`	`127`
`126`	`128`	`/******************************************************************************`
Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,7 @@ unsigned long NBConnectionHandler::getTime() {`
`78`	`78`	`return nbAccess.getTime();`
`79`	`79`	`}`
`80`	`80`
`81`		`-void NBConnectionHandler::update() {`
	`81`	`+NetworkConnectionState NBConnectionHandler::check() {`
`82`	`82`	`unsigned long const now = millis();`
`83`	`83`	`int nbAccessAlive;`
`84`	`84`	`if (now - lastConnectionTickTime > connectionTickTimeInterval) {`
`@@ -96,7 +96,7 @@ void NBConnectionHandler::update() {`
`96`	`96`	`if (networkStatus == NB_NetworkStatus_t::ERROR) {`
`97`	`97`	`// NO FURTHER ACTION WILL FOLLOW THIS`
`98`	`98`	`changeConnectionState(NetworkConnectionState::ERROR);`
`99`		`- return;`
	`99`	`+ return netConnectionState;`
`100`	`100`	`}`
`101`	`101`	`Debug.print(DBG_INFO, "Sending PING to outer space...");`
`102`	`102`	`int pingResult;`
`@@ -106,11 +106,11 @@ void NBConnectionHandler::update() {`
`106`	`106`	`if (pingResult < 0) {`
`107`	`107`	`Debug.print(DBG_ERROR, "PING failed");`
`108`	`108`	`Debug.print(DBG_INFO, "Retrying in \"%d\" milliseconds", connectionTickTimeInterval);`
`109`		`- return;`
	`109`	`+ return netConnectionState;`
`110`	`110`	`} else {`
`111`	`111`	`Debug.print(DBG_INFO, "Connected to GPRS Network");`
`112`	`112`	`changeConnectionState(NetworkConnectionState::CONNECTED);`
`113`		`- return;`
	`113`	`+ return netConnectionState;`
`114`	`114`	`}`
`115`	`115`	`}`
`116`	`116`	`break;`
`@@ -119,7 +119,7 @@ void NBConnectionHandler::update() {`
`119`	`119`	`Debug.print(DBG_VERBOSE, "GPRS.isAccessAlive(): %d", nbAccessAlive);`
`120`	`120`	`if (nbAccessAlive != 1) {`
`121`	`121`	`changeConnectionState(NetworkConnectionState::DISCONNECTED);`
`122`		`- return;`
	`122`	`+ return netConnectionState;`
`123`	`123`	`}`
`124`	`124`	`Debug.print(DBG_VERBOSE, "Connected to Cellular Network");`
`125`	`125`	`}`
`@@ -138,6 +138,8 @@ void NBConnectionHandler::update() {`
`138`	`138`	`}`
`139`	`139`	`lastConnectionTickTime = now;`
`140`	`140`	`}`
	`141`	`+`
	`142`	`+ return netConnectionState;`
`141`	`143`	`}`
`142`	`144`
`143`	`145`	`/******************************************************************************`