Merge pull request #113 from arduino-libraries/reduce-lora-api

Reduce public API by turning connect/disconnect into protected methods.

Author: aentinger

src/ArduinoIoTCloud.h

@@ -81,8 +81,6 @@ class ArduinoIoTCloudClass
     virtual ~ArduinoIoTCloudClass() { }
 
 
-    virtual int  connect       () = 0;
-    virtual bool disconnect    () = 0;
     virtual void update        () = 0;
     virtual int  connected     () = 0;
     virtual void printDebugInfo() = 0;
@@ -134,6 +132,9 @@ class ArduinoIoTCloudClass
 
   protected:
 
+    virtual int  connect   () = 0;
+    virtual void disconnect() = 0;
+
     inline ArduinoIoTConnectionStatus getIoTStatus() { return _iot_status; }
 
     ConnectionHandler * _connection = nullptr;

src/ArduinoIoTCloudLPWAN.cpp

@@ -47,18 +47,6 @@ ArduinoIoTCloudLPWAN::ArduinoIoTCloudLPWAN()
  * PUBLIC MEMBER FUNCTIONS
  ******************************************************************************/
 
-int ArduinoIoTCloudLPWAN::connect()
-{
-  _connection->connect();
-  return 1;
-}
-
-bool ArduinoIoTCloudLPWAN::disconnect()
-{
-  _connection->disconnect();
-  return true;
-}
-
 int ArduinoIoTCloudLPWAN::connected()
 {
   return (_connection->getStatus() == NetworkConnectionState::CONNECTED) ? 1 : 0;
@@ -116,6 +104,21 @@ void ArduinoIoTCloudLPWAN::printDebugInfo()
   Debug.print(DBG_INFO, "Thing ID: %s", getThingId().c_str());
 }
 
+/******************************************************************************
+ * PROTECTED MEMBER FUNCTIONS
+ ******************************************************************************/
+
+int ArduinoIoTCloudLPWAN::connect()
+{
+  _connection->connect();
+  return 1;
+}
+
+void ArduinoIoTCloudLPWAN::disconnect()
+{
+  _connection->disconnect();
+}
+
 /******************************************************************************
  * PRIVATE MEMBER FUNCTIONS
  ******************************************************************************/

src/ArduinoIoTCloudLPWAN.h

@@ -35,8 +35,6 @@ class ArduinoIoTCloudLPWAN : public ArduinoIoTCloudClass
              ArduinoIoTCloudLPWAN();
     virtual ~ArduinoIoTCloudLPWAN() { }
 
-    virtual int  connect       () override;
-    virtual bool disconnect    () override;
     virtual void update        () override;
     virtual int  connected     () override;
     virtual void printDebugInfo() override;
@@ -52,6 +50,12 @@ class ArduinoIoTCloudLPWAN : public ArduinoIoTCloudClass
     inline void setIntervalRetry(long val) { _intervalRetry = val; }
 
 
+  protected:
+
+    virtual int  connect       () override;
+    virtual void disconnect    () override;
+
+
   private:
 
     bool _retryEnable;

src/ArduinoIoTCloudTCP.cpp

@@ -141,35 +141,6 @@ int ArduinoIoTCloudTCP::begin(String brokerAddress, uint16_t brokerPort)
   return 1;
 }
 
-int ArduinoIoTCloudTCP::connect()
-{
-  if (!_mqttClient->connect(_brokerAddress.c_str(), _brokerPort)) {
-    return CONNECT_FAILURE;
-  }
-  if (_mqttClient->subscribe(_stdinTopic) == 0) {
-    return CONNECT_FAILURE_SUBSCRIBE;
-  }
-  if (_mqttClient->subscribe(_dataTopicIn) == 0) {
-    return CONNECT_FAILURE_SUBSCRIBE;
-  }
-  if (_shadowTopicIn != "") {
-    if (_mqttClient->subscribe(_shadowTopicIn) == 0) {
-      return CONNECT_FAILURE_SUBSCRIBE;
-    }
-    _syncStatus = ArduinoIoTSynchronizationStatus::SYNC_STATUS_WAIT_FOR_CLOUD_VALUES;
-    _lastSyncRequestTickTime = 0;
-  }
-
-  return CONNECT_SUCCESS;
-}
-
-
-bool ArduinoIoTCloudTCP::disconnect()
-{
-  _mqttClient->stop();
-  return true;
-}
-
 void ArduinoIoTCloudTCP::update()
 {
   // Check if a primitive property wrapper is locally changed
@@ -209,6 +180,11 @@ void ArduinoIoTCloudTCP::update()
   }
 }
 
+int ArduinoIoTCloudTCP::connected()
+{
+  return _mqttClient->connected();
+}
+
 void ArduinoIoTCloudTCP::printDebugInfo()
 {
   Debug.print(DBG_INFO, "***** Arduino IoT Cloud - configuration info *****");
@@ -225,10 +201,29 @@ int ArduinoIoTCloudTCP::reconnect()
   return connect();
 }
 
+/******************************************************************************
+ * PROTECTED MEMBER FUNCTIONS
+ ******************************************************************************/
 
-int ArduinoIoTCloudTCP::connected()
+int ArduinoIoTCloudTCP::connect()
 {
-  return _mqttClient->connected();
+  if (!_mqttClient->connect(_brokerAddress.c_str(), _brokerPort)) return CONNECT_FAILURE;
+  if (_mqttClient->subscribe(_stdinTopic) == 0)                   return CONNECT_FAILURE_SUBSCRIBE;
+  if (_mqttClient->subscribe(_dataTopicIn) == 0)                  return CONNECT_FAILURE_SUBSCRIBE;
+
+  if (_shadowTopicIn != "")
+  {
+    if (_mqttClient->subscribe(_shadowTopicIn) == 0)              return CONNECT_FAILURE_SUBSCRIBE;
+    _syncStatus = ArduinoIoTSynchronizationStatus::SYNC_STATUS_WAIT_FOR_CLOUD_VALUES;
+    _lastSyncRequestTickTime = 0;
+  }
+
+  return CONNECT_SUCCESS;
+}
+
+void ArduinoIoTCloudTCP::disconnect()
+{
+  _mqttClient->stop();
 }
 
 /******************************************************************************

src/ArduinoIoTCloudTCP.h

@@ -53,8 +53,7 @@ class ArduinoIoTCloudTCP: public ArduinoIoTCloudClass
              ArduinoIoTCloudTCP();
     virtual ~ArduinoIoTCloudTCP();
 
-    virtual int  connect       () override;
-    virtual bool disconnect    () override;
+
     virtual void update        () override;
     virtual int  connected     () override;
     virtual void printDebugInfo() override;
@@ -79,6 +78,13 @@ class ArduinoIoTCloudTCP: public ArduinoIoTCloudClass
 
     friend class CloudSerialClass;
 
+
+  protected:
+
+    virtual int  connect       () override;
+    virtual void disconnect    () override;
+
+
   private:
     static const int MQTT_TRANSMIT_BUFFER_SIZE = 256;