Upadte comments and Readme.

Author: mobizt

README.md

@@ -103,7 +103,9 @@ The SPI Ethernet module that uses WIZNet W5100, W5500 and ENC28J60 are supported
   // by not set any buffer size or set the rx buffer size to maximum SSL record size (16384) and 512 for tx buffer size.  
   ssl_client.setBufferSizes(1024 /* rx */, 512 /* tx */);
 
-  // assign the basic client
+  // Assign the basic client
+  // Due to the basic_client pointer is assigned, to avoid dangling pointer, basic_client should be existed 
+  // as long as it was used by ssl_client for transportation.
   ssl_client.setClient(&basic_client);
 
   Serial.print("Connecting to server...");
@@ -182,6 +184,8 @@ param **`client`** The pointer to Client interface.
 
 param **`enableSSL`** The ssl option; true for enable, false for disable.
 
+Due to the client pointer is assigned, to avoid dangling pointer, basic_client should be existed as long as it was used by ssl_client for transportation.
+
 ```cpp
 void setClient(Client *client, bool enableSSL = true);
 ```

examples/certificate/certificate.ino

@@ -141,7 +141,9 @@ void setup()
      */
     ssl_client.setDebugLevel(1);
 
-    // assign the basic client
+    // Assign the basic client
+    // Due to the basic_client pointer is assigned, to avoid dangling pointer, basic_client should be existed
+    // as long as it was used by ssl_client for transportation.
     ssl_client.setClient(&basic_client);
 }
 

examples/ethernet/ethernet.ino

@@ -90,7 +90,9 @@ void setup()
      */
     ssl_client.setDebugLevel(1);
 
-    // assign the basic client
+    // Assign the basic client
+    // Due to the basic_client pointer is assigned, to avoid dangling pointer, basic_client should be existed
+    // as long as it was used by ssl_client for transportation.
     ssl_client.setClient(&basic_client);
 }
 

examples/gsm/gsm.ino

@@ -210,7 +210,9 @@ void loop()
      */
     ssl_client.setDebugLevel(1);
 
-    // assign the basic client
+    // Assign the basic client
+    // Due to the basic_client pointer is assigned, to avoid dangling pointer, basic_client should be existed
+    // as long as it was used by ssl_client for transportation.
     ssl_client.setClient(&basic_client);
 
     Serial.println("---------------------------------");

examples/http_upgrade/http_upgrade.ino

@@ -81,7 +81,9 @@ void setup()
    */
   ssl_client.setDebugLevel(1);
 
-  // assign the basic client
+  // Assign the basic client
+  // Due to the basic_client pointer is assigned, to avoid dangling pointer, basic_client should be existed
+  // as long as it was used by ssl_client for transportation.
   ssl_client.setClient(&basic_client, false /* set enable SSL option to false */);
 }
 

examples/https/https.ino

@@ -82,7 +82,9 @@ void setup()
      */
     ssl_client.setDebugLevel(1);
 
-    // assign the basic client
+    // Assign the basic client
+    // Due to the basic_client pointer is assigned, to avoid dangling pointer, basic_client should be existed
+    // as long as it was used by ssl_client for transportation.
     ssl_client.setClient(&basic_client);
 }
 

examples/mqtt/mqtt.ino

@@ -99,7 +99,9 @@ void setup()
    */
   ssl_client.setDebugLevel(1);
 
-  // assign the basic client
+  // Assign the basic client
+  // Due to the basic_client pointer is assigned, to avoid dangling pointer, basic_client should be existed
+  // as long as it was used by ssl_client for transportation.
   ssl_client.setClient(&basic_client);
 
   Serial.print("Attempting to connect to the MQTT broker over ssl: ");

examples/session/session.ino

@@ -202,7 +202,9 @@ void setup()
      */
     ssl_client.setDebugLevel(1);
 
-    // assign the basic client
+    // Assign the basic client
+    // Due to the basic_client pointer is assigned, to avoid dangling pointer, basic_client should be existed
+    // as long as it was used by ssl_client for transportation.
     ssl_client.setClient(&basic_client);
 }
 

src/client/BSSL_TCP_Client.h

@@ -78,6 +78,9 @@ class BSSL_TCP_Client : public Client
      * Set the client.
      * @param client The pointer to Client interface.
      * @param enableSSL The ssl option; true for enable, false for disable.
+     * 
+     * Due to the client pointer is assigned, to avoid dangling pointer, 
+     * basic_client should be existed as long as it was used by ssl_client for transportation.
      */
     void setClient(Client *client, bool enableSSL = true);