avoid connect to loop forever if connection to APN is not established

Author: maidnl

src/ArduinoCellular.cpp

@@ -44,7 +44,12 @@ void ArduinoCellular::begin() {
 
 }
 
-bool ArduinoCellular::connect(String apn, String username, String password){
+bool ArduinoCellular::connect(String apn, bool wait_forever) {
+    connect(apn,String(""),String(""), wait_forever);
+}
+
+
+bool ArduinoCellular::connect(String apn, String username, String password, bool wait_forever){
     SimStatus simStatus = getSimStatus();
 
     if(simStatus == SimStatus::SIM_LOCKED){
@@ -62,7 +67,7 @@ bool ArduinoCellular::connect(String apn, String username, String password){
         return false;
     }
 
-    if(!awaitNetworkRegistration()){    
+    if(!awaitNetworkRegistration(wait_forever)){    
         return false;
     }
 
@@ -225,11 +230,16 @@ bool ArduinoCellular::unlockSIM(String pin){
     return modem.simUnlock(pin.c_str()); 
 }
 
-bool ArduinoCellular::awaitNetworkRegistration(){
+bool ArduinoCellular::awaitNetworkRegistration(bool wait_forever){
     if(this->debugStream != nullptr){
         this->debugStream->println("Waiting for network registration...");
     }
     while (!modem.waitForNetwork(waitForNetworkTimeout)) {
+        
+        if(!wait_forever) {
+            return false;
+        }
+
         if(this->debugStream != nullptr){
             this->debugStream->print(".");
         }

src/ArduinoCellular.h

@@ -119,9 +119,15 @@ class ArduinoCellular {
          * @param apn The Access Point Name.
          * @param username The APN username.
          * @param password The APN password.
+         * @param wait_forever The function does not return unless a connection has been established
          * @return True if the connection is successful, false otherwise.
          */
-        bool connect(String apn = "", String username = "", String password = "");
+        bool connect(String apn = "", String username = "", String password = "", bool wait_forever = true);
+        
+        /**
+         * @brief same as previous, username and password are empty
+         */
+        bool connect(String apn, bool wait_forever);
 
         /**
          * @brief Checks if the modem is registered on the network.
@@ -271,9 +277,10 @@ class ArduinoCellular {
 
         /**
          * @brief Waits for network registration. (Blocking call)
+         * @param wait_forever if true the function does not return untill a connection has been established
          * @return True if the network registration is successful, false otherwise.
          */
-        bool awaitNetworkRegistration();
+        bool awaitNetworkRegistration(bool wait_forever);
 
         /**
          * @brief Gets the GPS location. (Blocking call)