comments in ClientContext::connect() (#7961)

d-a-v · web-flow · commit 0049090e488f · 2021-04-05T15:09:27.000+02:00
* add comment
diff --git a/libraries/ESP8266WiFi/src/include/ClientContext.h b/libraries/ESP8266WiFi/src/include/ClientContext.h
@@ -131,6 +131,9 @@ class ClientContext
 
     int connect(ip_addr_t* addr, uint16_t port)
     {
+        // note: not using `const ip_addr_t* addr` because
+        // - `ip6_addr_assign_zone()` below modifies `*addr`
+        // - caller's parameter `WiFiClient::connect` is a local copy
 #if LWIP_IPV6
         // Set zone so that link local addresses use the default interface
         if (IP_IS_V6(addr) && ip6_addr_lacks_zone(ip_2_ip6(addr), IP6_UNKNOWN)) {

Original file line number	Diff line number	Diff line change
`@@ -131,6 +131,9 @@ class ClientContext`
`131`	`131`
`132`	`132`	`int connect(ip_addr_t* addr, uint16_t port)`
`133`	133	`{`
	`134`	+ // note: not using `const ip_addr_t* addr` because
	`135`	+ // - `ip6_addr_assign_zone()` below modifies `*addr`
	`136`	+ // - caller's parameter `WiFiClient::connect` is a local copy
`134`	`137`	`#if LWIP_IPV6`
`135`	`138`	`// Set zone so that link local addresses use the default interface`
`136`	`139`	`if (IP_IS_V6(addr) && ip6_addr_lacks_zone(ip_2_ip6(addr), IP6_UNKNOWN)) {`