handle wificlient lifetime through the wificlient itself

esp8266 · mcspr · Oct 13, 2021 · Jul 24, 2021 · Jul 24, 2021 · Sep 6, 2021
commit bf8d804d14638e04c4c8fc0bcaf4ab32c26f2b36
diff --git a/libraries/ESP8266HTTPClient/src/ESP8266HTTPClient.cpp b/libraries/ESP8266HTTPClient/src/ESP8266HTTPClient.cpp
@@ -69,8 +69,6 @@ void HTTPClient::clear()
  * @return success bool
  */
 bool HTTPClient::begin(WiFiClient &client, const String& url) {
-    _client = &client;
-
     // check for : (http: or https:)
     int index = url.indexOf(':');
     if(index < 0) {
@@ -86,6 +84,8 @@ bool HTTPClient::begin(WiFiClient &client, const String& url) {
     }
 
     _port = (protocol == "https" ? 443 : 80);
+    _client = std::make_unique<WiFiClient>(client);
+
     return beginInternal(url, protocol.c_str());
 }
 
@@ -101,7 +101,7 @@ bool HTTPClient::begin(WiFiClient &client, const String& url) {
  */
 bool HTTPClient::begin(WiFiClient &client, const String& host, uint16_t port, const String& uri, bool https)
 {
-    _client = &client;
+    _client = std::make_unique<WiFiClient>(client);
 
      clear();
     _host = host;

diff --git a/libraries/ESP8266HTTPClient/src/ESP8266HTTPClient.h b/libraries/ESP8266HTTPClient/src/ESP8266HTTPClient.h
@@ -157,10 +157,7 @@ class HTTPClient
     HTTPClient(HTTPClient&&) = default;
     HTTPClient& operator=(HTTPClient&&) = default;
 
-/*
- * Since both begin() functions take a reference to client as a parameter, you need to 
- * ensure the client object lives the entire time of the HTTPClient
- */
+    // Note that WiFiClient instance *will* be captured by the internal handler.
     bool begin(WiFiClient &client, const String& url);
     bool begin(WiFiClient &client, const String& host, uint16_t port, const String& uri = "/", bool https = false);
 
@@ -235,55 +232,6 @@ class HTTPClient
     // in case wificlient supports seamless ref() / unref() of the underlying connection
     // for both wificlient and wificlientsecure, this may be removed in favour of that approach.
 
-    struct NonOwningClientPtr {
-        NonOwningClientPtr() = default;
-        NonOwningClientPtr(const NonOwningClientPtr&) = delete;
-        NonOwningClientPtr(NonOwningClientPtr&& other) noexcept {
-            *this = std::move(other);
-        }
-
-        ~NonOwningClientPtr() noexcept {
-            if (_ptr) {
-                _ptr->stop();
-            }
-        }
-
-        explicit NonOwningClientPtr(WiFiClient* ptr) noexcept :
-            _ptr(ptr)
-        {}
-
-        explicit operator bool() const {
-            return _ptr != nullptr;
-        }
-
-        WiFiClient* get() const noexcept {
-            return _ptr;
-        }
-
-        WiFiClient& operator*() const {
-            return *_ptr;
-        }
-
-        WiFiClient* operator->() const noexcept {
-            return _ptr;
-        }

-        NonOwningClientPtr& operator=(WiFiClient* ptr) noexcept {
-            _ptr = ptr;
-            return *this;
-        }
-
-        NonOwningClientPtr& operator=(const NonOwningClientPtr&) = delete;
-        NonOwningClientPtr& operator=(NonOwningClientPtr&& other) noexcept {
-            _ptr = other._ptr;
-            other._ptr = nullptr;
-            return *this;
-        }
-
-    private:
-        WiFiClient* _ptr = nullptr;
-    };
-
     bool beginInternal(const String& url, const char* expectedProtocol);
     void disconnect(bool preserveClient = false);
     void clear();
@@ -293,7 +241,7 @@ class HTTPClient
     int handleHeaderResponse();
     int writeToStreamDataBlock(Stream * stream, int len);
 
-    NonOwningClientPtr _client;
+    std::unique_ptr<WiFiClient> _client;
 
     /// request handling
     String _host;