Merge pull request #2114 from meshtastic/refactor-apiserver

make a template class for API Server

src/mesh/InterfacesTemplates.cpp

@@ -2,9 +2,23 @@
 #include "SX126xInterface.cpp"
 #include "SX128xInterface.h"
 #include "SX128xInterface.cpp"
+#include "api/ServerAPI.h"
+#include "api/ServerAPI.cpp"
 
 // We need this declaration for proper linking in derived classes
 template class SX126xInterface<SX1262>;
 template class SX126xInterface<SX1268>;
 template class SX126xInterface<LLCC68>;
 template class SX128xInterface<SX1280>;
+
+#if HAS_ETHERNET
+#include "api/ethServerAPI.h"
+template class ServerAPI<EthernetClient>;
+template class APIServerPort<ethServerAPI, EthernetServer>;
+#endif
+
+#if HAS_WIFI
+#include "api/WiFiServerAPI.h"
+template class ServerAPI<WiFiClient>;
+template class APIServerPort<WiFiServerAPI, WiFiServer>;
+#endif

src/mesh/PhoneAPI.h

@@ -86,9 +86,6 @@ class PhoneAPI : public Observer<uint32_t> // FIXME, we shouldn't be inheriting
 
     void setInitialState() { state = STATE_SEND_MY_INFO; }
 
-    /// emit a debugging log character, FIXME - implement
-    void debugOut(char c) { }
-
   protected:
     /// Our fromradio packet while it is being assembled
     FromRadio fromRadioScratch = {};

src/mesh/api/ServerAPI.cpp

@@ -0,0 +1,67 @@
+#include "ServerAPI.h"
+#include "configuration.h"
+#include <Arduino.h>
+
+template<typename T>
+ServerAPI<T>::ServerAPI(T &_client) : StreamAPI(&client), concurrency::OSThread("ServerAPI"), client(_client)
+{
+    LOG_INFO("Incoming wifi connection\n");
+}
+
+template<typename T>
+ServerAPI<T>::~ServerAPI()
+{
+    client.stop();
+}
+
+template<typename T>
+void ServerAPI<T>::close()
+{
+    client.stop(); // drop tcp connection
+    StreamAPI::close();
+}
+
+/// Check the current underlying physical link to see if the client is currently connected
+template<typename T>
+bool ServerAPI<T>::checkIsConnected()
+{
+    return client.connected();
+}
+
+template<class T>
+int32_t ServerAPI<T>::runOnce()
+{
+    if (client.connected()) {
+        return StreamAPI::runOncePart();
+    } else {
+        LOG_INFO("Client dropped connection, suspending API service\n");
+        enabled = false; // we no longer need to run
+        return 0;
+    }
+}
+
+template<class T, class U>
+APIServerPort<T, U>::APIServerPort(int port) : U(port), concurrency::OSThread("ApiServer") {}
+
+template<class T, class U>
+void APIServerPort<T, U>::init()
+{
+    U::begin();
+}
+
+template<class T, class U>
+int32_t APIServerPort<T, U>::runOnce()
+{
+    auto client = U::available();
+    if (client) {
+        // Close any previous connection (see FIXME in header file)
+        if (openAPI) {
+            LOG_INFO("Force closing previous TCP connection\n");
+            delete openAPI;
+        }
+
+        openAPI = new T(client);
+    }
+
+    return 100; // only check occasionally for incoming connections
+}

src/mesh/api/ServerAPI.h

@@ -1,21 +1,21 @@
 #pragma once
 
 #include "StreamAPI.h"
-#include <WiFi.h>
 
 /**
  * Provides both debug printing and, if the client starts sending protobufs to us, switches to send/receive protobufs
  * (and starts dropping debug printing - FIXME, eventually those prints should be encapsulated in protobufs).
  */
-class WiFiServerAPI : public StreamAPI, private concurrency::OSThread
+template<class T>
+class ServerAPI : public StreamAPI, private concurrency::OSThread
 {
   private:
-    WiFiClient client;
+    T client;
 
   public:
-    explicit WiFiServerAPI(WiFiClient &_client);
+    explicit ServerAPI(T &_client);
 
-    virtual ~WiFiServerAPI();
+    virtual ~ServerAPI();
 
     /// override close to also shutdown the TCP link
     virtual void close();
@@ -34,25 +34,21 @@ class WiFiServerAPI : public StreamAPI, private concurrency::OSThread
 /**
  * Listens for incoming connections and does accepts and creates instances of WiFiServerAPI as needed
  */
-class WiFiServerPort : public WiFiServer, private concurrency::OSThread
+template<class T, class U>
+class APIServerPort : public U, private concurrency::OSThread
 {
     /** The currently open port
      *
      * FIXME: We currently only allow one open TCP connection at a time, because we depend on the loop() call in this class to
      * delegate to the worker.  Once coroutines are implemented we can relax this restriction.
      */
-    WiFiServerAPI *openAPI = NULL;
+    T *openAPI = NULL;
 
   public:
-    explicit WiFiServerPort(int port);
+    explicit APIServerPort(int port);
 
     void init();
 
-    /// If an api server is running, we try to spit out debug 'serial' characters there
-    static void debugOut(char c);
-    
   protected:
     int32_t runOnce() override;
 };
-
-void initApiServer(int port=4403);

src/mesh/api/WiFiServerAPI.cpp

@@ -0,0 +1,25 @@
+#include "configuration.h"
+#include <Arduino.h>
+
+#if HAS_WIFI
+#include "WiFiServerAPI.h"
+
+static WiFiServerPort *apiPort;
+
+void initApiServer(int port)
+{
+    // Start API server on port 4403
+    if (!apiPort) {
+        apiPort = new WiFiServerPort(port);
+        LOG_INFO("API server listening on TCP port %d\n", port);
+        apiPort->init();
+    }
+}
+
+WiFiServerAPI::WiFiServerAPI(WiFiClient &_client) : ServerAPI(_client)
+{
+    LOG_INFO("Incoming wifi connection\n");
+}
+
+WiFiServerPort::WiFiServerPort(int port) : APIServerPort(port) {}
+#endif

src/mesh/api/WiFiServerAPI.h

@@ -0,0 +1,25 @@
+#pragma once
+
+#include "ServerAPI.h"
+#include <WiFi.h>
+
+/**
+ * Provides both debug printing and, if the client starts sending protobufs to us, switches to send/receive protobufs
+ * (and starts dropping debug printing - FIXME, eventually those prints should be encapsulated in protobufs).
+ */
+class WiFiServerAPI : public ServerAPI<WiFiClient>
+{
+    public:
+        explicit WiFiServerAPI(WiFiClient &_client);
+};
+
+/**
+ * Listens for incoming connections and does accepts and creates instances of WiFiServerAPI as needed
+ */
+class WiFiServerPort : public APIServerPort<WiFiServerAPI, WiFiServer>
+{
+    public:
+        explicit WiFiServerPort(int port);
+};
+
+void initApiServer(int port=4403);

src/mesh/api/ethServerAPI.cpp

@@ -0,0 +1,27 @@
+#include "configuration.h"
+#include <Arduino.h>
+
+#if HAS_ETHERNET
+
+#include "ethServerAPI.h"
+
+static ethServerPort *apiPort;
+
+void initApiServer(int port)
+{
+    // Start API server on port 4403
+    if (!apiPort) {
+        apiPort = new ethServerPort(port);
+        LOG_INFO("API server listening on TCP port %d\n", port);
+        apiPort->init();
+    }
+}
+
+ethServerAPI::ethServerAPI(EthernetClient &_client) : ServerAPI(_client)
+{
+    LOG_INFO("Incoming ethernet connection\n");
+}
+
+ethServerPort::ethServerPort(int port) : APIServerPort(port) {}
+
+#endif

src/mesh/api/ethServerAPI.h

@@ -0,0 +1,25 @@
+#pragma once
+
+#include "ServerAPI.h"
+#include <RAK13800_W5100S.h>
+
+/**
+ * Provides both debug printing and, if the client starts sending protobufs to us, switches to send/receive protobufs
+ * (and starts dropping debug printing - FIXME, eventually those prints should be encapsulated in protobufs).
+ */
+class ethServerAPI : public ServerAPI<EthernetClient>
+{
+    public:
+        explicit ethServerAPI(EthernetClient &_client);
+};
+
+/**
+ * Listens for incoming connections and does accepts and creates instances of WiFiServerAPI as needed
+ */
+class ethServerPort : public APIServerPort<ethServerAPI, EthernetServer>
+{
+    public:
+        explicit ethServerPort(int port);
+};
+
+void initApiServer(int port=4403);

src/mesh/eth/ethClient.cpp

@@ -5,7 +5,7 @@
 #include <SPI.h>
 #include <RAK13800_W5100S.h>
 #include "target_specific.h"
-#include "mesh/eth/ethServerAPI.h"
+#include "mesh/api/ethServerAPI.h"
 #include "mqtt/MQTT.h"
 
 #ifndef DISABLE_NTP

src/mesh/eth/ethServerAPI.cpp

@@ -1,82 +0,0 @@
-#include "ethServerAPI.h"
-#include "configuration.h"
-#include <Arduino.h>
-
-static ethServerPort *apiPort;
-
-void initApiServer(int port)
-{
-    // Start API server on port 4403
-    if (!apiPort) {
-        apiPort = new ethServerPort(port);
-        LOG_INFO("API server listening on TCP port %d\n", port);
-        apiPort->init();
-    }
-}
-
-ethServerAPI::ethServerAPI(EthernetClient &_client) : StreamAPI(&client), concurrency::OSThread("ethServerAPI"), client(_client)
-{
-    LOG_INFO("Incoming ethernet connection\n");
-}
-
-ethServerAPI::~ethServerAPI()
-{
-    client.stop();
-
-    // FIXME - delete this if the client dropps the connection!
-}
-
-/// override close to also shutdown the TCP link
-void ethServerAPI::close()
-{
-    client.stop(); // drop tcp connection
-    StreamAPI::close();
-}
-
-/// Check the current underlying physical link to see if the client is currently connected
-bool ethServerAPI::checkIsConnected()
-{
-    return client.connected();
-}
-
-int32_t ethServerAPI::runOnce()
-{
-    if (client.connected()) {
-        return StreamAPI::runOncePart();
-    } else {
-        LOG_INFO("Client dropped connection, suspending API service\n");
-        enabled = false; // we no longer need to run
-        return 0;
-    }
-}
-
-/// If an api server is running, we try to spit out debug 'serial' characters there
-void ethServerPort::debugOut(char c)
-{
-    if (apiPort && apiPort->openAPI)
-        apiPort->openAPI->debugOut(c);
-}
-
-
-ethServerPort::ethServerPort(int port) : EthernetServer(port), concurrency::OSThread("ApiServer") {}
-
-void ethServerPort::init()
-{
-    begin();
-}
-
-int32_t ethServerPort::runOnce()
-{
-    auto client = available();
-    if (client) {
-        // Close any previous connection (see FIXME in header file)
-        if (openAPI) {
-            LOG_WARN("Force closing previous TCP connection\n");
-            delete openAPI;
-        }
-
-        openAPI = new ethServerAPI(client);
-    }
-
-    return 100; // only check occasionally for incoming connections
-}

src/mesh/eth/ethServerAPI.h

@@ -1,58 +0,0 @@
-#pragma once
-
-#include "StreamAPI.h"
-#include <RAK13800_W5100S.h>
-
-/**
- * Provides both debug printing and, if the client starts sending protobufs to us, switches to send/receive protobufs
- * (and starts dropping debug printing - FIXME, eventually those prints should be encapsulated in protobufs).
- */
-class ethServerAPI : public StreamAPI, private concurrency::OSThread
-{
-  private:
-    EthernetClient client;
-
-  public:
-    explicit ethServerAPI(EthernetClient &_client);
-
-    virtual ~ethServerAPI();
-
-    /// override close to also shutdown the TCP link
-    virtual void close();
-
-  protected:
-    /// We override this method to prevent publishing EVENT_SERIAL_CONNECTED/DISCONNECTED for wifi links (we want the board to
-    /// stay in the POWERED state to prevent disabling wifi)
-    virtual void onConnectionChanged(bool connected) override {}
-
-    virtual int32_t runOnce() override; // Check for dropped client connections
-
-    /// Check the current underlying physical link to see if the client is currently connected
-    virtual bool checkIsConnected() override;
-};
-
-/**
- * Listens for incoming connections and does accepts and creates instances of WiFiServerAPI as needed
- */
-class ethServerPort : public EthernetServer, private concurrency::OSThread
-{
-    /** The currently open port
-     *
-     * FIXME: We currently only allow one open TCP connection at a time, because we depend on the loop() call in this class to
-     * delegate to the worker.  Once coroutines are implemented we can relax this restriction.
-     */
-    ethServerAPI *openAPI = NULL;
-
-  public:
-    explicit ethServerPort(int port);
-
-    void init();
-
-    /// If an api server is running, we try to spit out debug 'serial' characters there
-    static void debugOut(char c);
-    
-  protected:
-    int32_t runOnce() override;
-};
-
-void initApiServer(int port=4403);

src/mesh/http/WiFiAPClient.cpp

@@ -5,7 +5,7 @@
 #include "configuration.h"
 #include "main.h"
 #include "mesh/http/WebServer.h"
-#include "mesh/wifi/WiFiServerAPI.h"
+#include "mesh/api/WiFiServerAPI.h"
 #include "mqtt/MQTT.h"
 #include "target_specific.h"
 #include <ESPmDNS.h>

src/mesh/wifi/WiFiServerAPI.cpp

@@ -1,82 +0,0 @@
-#include "WiFiServerAPI.h"
-#include "configuration.h"
-#include <Arduino.h>
-
-static WiFiServerPort *apiPort;
-
-void initApiServer(int port)
-{
-    // Start API server on port 4403
-    if (!apiPort) {
-        apiPort = new WiFiServerPort(port);
-        LOG_INFO("API server listening on TCP port %d\n", port);
-        apiPort->init();
-    }
-}
-
-WiFiServerAPI::WiFiServerAPI(WiFiClient &_client) : StreamAPI(&client), concurrency::OSThread("WiFiServerAPI"), client(_client)
-{
-    LOG_INFO("Incoming wifi connection\n");
-}
-
-WiFiServerAPI::~WiFiServerAPI()
-{
-    client.stop();
-
-    // FIXME - delete this if the client dropps the connection!
-}
-
-/// override close to also shutdown the TCP link
-void WiFiServerAPI::close()
-{
-    client.stop(); // drop tcp connection
-    StreamAPI::close();
-}
-
-/// Check the current underlying physical link to see if the client is currently connected
-bool WiFiServerAPI::checkIsConnected()
-{
-    return client.connected();
-}
-
-int32_t WiFiServerAPI::runOnce()
-{
-    if (client.connected()) {
-        return StreamAPI::runOncePart();
-    } else {
-        LOG_INFO("Client dropped connection, suspending API service\n");
-        enabled = false; // we no longer need to run
-        return 0;
-    }
-}
-
-/// If an api server is running, we try to spit out debug 'serial' characters there
-void WiFiServerPort::debugOut(char c)
-{
-    if (apiPort && apiPort->openAPI)
-        apiPort->openAPI->debugOut(c);
-}
-
-
-WiFiServerPort::WiFiServerPort(int port) : WiFiServer(port), concurrency::OSThread("ApiServer") {}
-
-void WiFiServerPort::init()
-{
-    begin();
-}
-
-int32_t WiFiServerPort::runOnce()
-{
-    auto client = available();
-    if (client) {
-        // Close any previous connection (see FIXME in header file)
-        if (openAPI) {
-            LOG_INFO("Force closing previous TCP connection\n");
-            delete openAPI;
-        }
-
-        openAPI = new WiFiServerAPI(client);
-    }
-
-    return 100; // only check occasionally for incoming connections
-}