SocketWrapper - copyable networking clients

Author: JAndrassy

libraries/Ethernet/src/EthernetClient.h

@@ -21,11 +21,11 @@
 #define ethernetclient_h
 
 #include "Ethernet.h"
-#include "MbedClient.h"
+#include "AClient.h"
 
 namespace arduino {
 
-class EthernetClient : public MbedClient {
+class EthernetClient : public AClient {
   NetworkInterface *getNetwork() {
     return Ethernet.getNetwork();
   }

libraries/Ethernet/src/EthernetSSLClient.h

@@ -21,13 +21,13 @@
 #define ETHERNETSSLCLIENT_H
 
 #include "EthernetClient.h"
-#include "MbedSSLClient.h"
+#include "AClient.h"
 
 extern const char CA_CERTIFICATES[];
 
 namespace arduino {
 
-class EthernetSSLClient : public arduino::MbedSSLClient {
+class EthernetSSLClient : public arduino::ASslClient {
   NetworkInterface *getNetwork() {
     return Ethernet.getNetwork();
   }

libraries/GSM/src/GSMClient.cpp

@@ -19,6 +19,6 @@
 
 #include "GSMClient.h"
 
-arduino::GSMClient::GSMClient(): MbedClient(100) {
+arduino::GSMClient::GSMClient(): AClient(100) {
 
 }

libraries/GSM/src/GSMClient.h

@@ -21,11 +21,11 @@
 #define gsmclient_h
 
 #include "GSM.h"
-#include "MbedClient.h"
+#include "AClient.h"
 
 namespace arduino {
 
-class GSMClient : public MbedClient {
+class GSMClient : public AClient {
 public:
   GSMClient();
 

libraries/GSM/src/GSMSSLClient.cpp

@@ -19,6 +19,6 @@
 
 #include "GSMSSLClient.h"
 
-arduino::GSMSSLClient::GSMSSLClient(): MbedSSLClient(100) {
+arduino::GSMSSLClient::GSMSSLClient(): ASslClient(100) {
 
 }

libraries/GSM/src/GSMSSLClient.h

@@ -21,13 +21,13 @@
 #define GSMSSLCLIENT_H
 
 #include "GSM.h"
-#include "MbedSSLClient.h"
+#include "AClient.h"
 
 extern const char CA_CERTIFICATES[];
 
 namespace arduino {
 
-class GSMSSLClient : public arduino::MbedSSLClient {
+class GSMSSLClient : public arduino::ASslClient {
 public:
   GSMSSLClient();
 

libraries/SocketWrapper/src/AClient.cpp

@@ -0,0 +1,143 @@
+
+#include "AClient.h"
+#include "MbedSSLClient.h"
+
+AClient::AClient(unsigned long  timeout) {
+  setSocketTimeout(timeout);
+}
+
+void arduino::AClient::newMbedClient() {
+  client.reset(new MbedClient());
+  client->setNetwork(getNetwork());
+}
+
+arduino::AClient::operator bool() {
+  return client && *client;
+}
+
+void arduino::AClient::setSocket(Socket *sock) {
+  if (!client) {
+    newMbedClient();
+  }
+  client->setSocket(sock);
+}
+
+void arduino::AClient::setSocketTimeout(unsigned long timeout) {
+  if (!client) {
+    newMbedClient();
+  }
+  client->setTimeout(timeout);
+}
+
+int arduino::AClient::connect(IPAddress ip, uint16_t port) {
+  if (!client) {
+    newMbedClient();
+  }
+  return client->connect(ip, port);
+}
+
+int arduino::AClient::connect(const char *host, uint16_t port) {
+  if (!client) {
+    newMbedClient();
+  }
+  return client->connect(host, port);
+}
+
+int arduino::AClient::connectSSL(IPAddress ip, uint16_t port) {
+  if (!client) {
+    newMbedClient();
+  }
+  return client->connectSSL(ip, port);
+}
+
+int arduino::AClient::connectSSL(const char *host, uint16_t port, bool disableSNI) {
+  if (!client) {
+    newMbedClient();
+  }
+  return client->connectSSL(host, port, disableSNI);
+}
+
+void arduino::AClient::stop() {
+  if (!client)
+    return;
+  client->stop();
+}
+
+uint8_t arduino::AClient::connected() {
+  if (!client)
+    return false;
+  return client->connected();
+}
+
+IPAddress arduino::AClient::remoteIP() {
+  if (!client)
+    return INADDR_NONE;
+  return client->remoteIP();
+}
+
+uint16_t arduino::AClient::remotePort() {
+  if (!client)
+    return 0;
+  return client->remotePort();
+}
+
+size_t arduino::AClient::write(uint8_t b) {
+  if (!client)
+    return 0;
+  return client->write(b);
+}
+
+size_t arduino::AClient::write(const uint8_t *buf, size_t size) {
+  if (!client)
+    return 0;
+  return client->write(buf, size);
+}
+
+void arduino::AClient::flush() {
+  if (!client)
+    return;
+  client->flush();
+}
+
+int arduino::AClient::available() {
+  if (!client)
+    return 0;
+  return client->available();
+}
+
+int arduino::AClient::read() {
+  if (!client)
+    return -1;
+  return client->read();
+}
+
+int arduino::AClient::read(uint8_t *buf, size_t size) {
+  if (!client)
+    return 0;
+  return client->read(buf, size);
+}
+
+int arduino::AClient::peek() {
+  if (!client)
+    return -1;
+  return client->peek();
+}
+
+void arduino::ASslClient::newMbedClient() {
+  client.reset(new MbedSSLClient());
+  client->setNetwork(getNetwork());
+}
+
+void arduino::ASslClient::disableSNI(bool statusSNI) {
+  if (!client) {
+    newMbedClient();
+  }
+  static_cast<MbedSSLClient*>(client.get())->disableSNI(statusSNI);
+}
+
+void arduino::ASslClient::appendCustomCACert(const char* ca_cert) {
+  if (!client) {
+    newMbedClient();
+  }
+  static_cast<MbedSSLClient*>(client.get())->appendCustomCACert(ca_cert);
+}

libraries/SocketWrapper/src/AClient.h

@@ -0,0 +1,83 @@
+/*
+  AClient.h - Copyable Client implementation for Mbed Core
+
+  This library is free software; you can redistribute it and/or
+  modify it under the terms of the GNU Lesser General Public
+  License as published by the Free Software Foundation; either
+  version 2.1 of the License, or (at your option) any later version.
+
+  This library is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+  Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public
+  License along with this library; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+*/
+
+#ifndef MBEDACLIENT_H
+#define MBEDACLIENT_H
+
+#include <Arduino.h>
+#include "MbedClient.h"
+
+namespace arduino {
+
+class AClient : public Client {
+public:
+
+  AClient() {}
+  AClient(unsigned long  timeout);
+
+  virtual int connect(IPAddress ip, uint16_t port);
+  virtual int connect(const char *host, uint16_t port);
+  int connectSSL(IPAddress ip, uint16_t port);
+  int connectSSL(const char* host, uint16_t port, bool disableSNI = false);
+  virtual void stop();
+
+  virtual explicit operator bool();
+  virtual uint8_t connected();
+  uint8_t status();
+
+  IPAddress remoteIP();
+  uint16_t remotePort();
+
+  virtual size_t write(uint8_t);
+  virtual size_t write(const uint8_t *buf, size_t size);
+  virtual void flush();
+
+  virtual int available();
+  virtual int read();
+  virtual int read(uint8_t *buf, size_t size);
+  virtual int peek();
+
+  void setSocketTimeout(unsigned long timeout);
+
+protected:
+  friend class EthernetServer;
+  friend class WiFiServer;
+
+  std::shared_ptr<MbedClient> client;
+  virtual NetworkInterface* getNetwork() = 0;
+  virtual void newMbedClient();
+  void setSocket(Socket* sock);
+
+};
+
+class ASslClient : public AClient {
+public:
+
+  ASslClient() {}
+  ASslClient(unsigned long  timeout) : AClient(timeout) {}
+
+  void disableSNI(bool statusSNI);
+
+  void appendCustomCACert(const char* ca_cert);
+
+protected:
+  virtual void newMbedClient();
+};
+
+}
+#endif

libraries/SocketWrapper/src/MbedClient.cpp

@@ -24,7 +24,7 @@ void arduino::MbedClient::readSocket() {
         continue;
       }
       mutex->lock();
-      if (sock == nullptr || (closing && borrowed_socket)) {
+      if (sock == nullptr) {
         goto cleanup;
       }
       ret = sock->recv(data, rxBuffer.availableForStore());
@@ -270,15 +270,14 @@ void arduino::MbedClient::stop() {
   if (mutex != nullptr) {
     mutex->lock();
   }
-  if (sock != nullptr && borrowed_socket == false) {
+  if (sock != nullptr) {
     if (_own_socket) {
       delete sock;
     } else {
       sock->close();
     }
     sock = nullptr;
   }
-  closing = true;
   if (mutex != nullptr) {
     mutex->unlock();
   }