comment and add comments about eth.setDefault()

esp8266 · d-a-v · Jun 2, 2022 · Nov 30, 2021 · Nov 30, 2021 · Mar 4, 2022
commit 95b6601bc3949088cccc135894566a8ea9bf570f
diff --git a/cores/esp8266/LwipIntfDev.h b/cores/esp8266/LwipIntfDev.h
@@ -59,6 +59,11 @@ class LwipIntfDev: public LwipIntf, public RawDev
         return IPAddress(ip4_addr_get_u32(ip_2_ip4(&_netif.gw)));
     }
 
+    // Use `::setDefault()` to force routing through this interface.
+    // Default is set to false. In this case lwIP selects the best suited
+    // output interface matching the destination address.
+    // If several interfaces match, the first one is picked.
+    // On esp8266/Arduno: WiFi interfaces are checked first.
     void setDefault(bool deflt = true);
 
     // true if interface has a valid IPv4 address

diff --git a/libraries/lwIP_Ethernet/examples/EthClient/EthClient.ino b/libraries/lwIP_Ethernet/examples/EthClient/EthClient.ino
@@ -18,9 +18,9 @@ void setup() {
 
   Serial.println("\nEthernet\n");
 
-  // Uncomment to force routing through this interface.
-  // Default is set to false. In this case lwIP searches for
-  // the best suited output interface matching the destination address.
+  // Uncomment `eth.setDefault(true)` to force routing through this interface.
+  // Default is set to false. In this case lwIP selects the best suited
+  // output interface matching the destination address.
   // If several interfaces match, the first one is picked.
   // On esp8266/Arduno: WiFi interfaces are checked first.
   // eth.setDefault(true); // default route set through this interface

diff --git a/libraries/lwIP_Ethernet/examples/EthClientStatic/EthClientStatic.ino b/libraries/lwIP_Ethernet/examples/EthClientStatic/EthClientStatic.ino
@@ -23,7 +23,13 @@ void setup() {
 
   Serial.println("\nEthernet\n");
 
-  eth.setDefault(true);  // default route set through this interface
+  // Uncomment `eth.setDefault(true)` to force routing through this interface.
+  // Default is set to false. In this case lwIP selects the best suited
+  // output interface matching the destination address.
+  // If several interfaces match, the first one is picked.
+  // On esp8266/Arduno: WiFi interfaces are checked first.
+  // eth.setDefault(true); // default route set through this interface
+
   if (!ethInitStatic(eth, LOCAL_IP, LOCAL_GW, LOCAL_MASK, DNS)) {
     // enabling debug message will show the real cause
     Serial.printf("no hardware found or bad network configuration\n");

diff --git a/libraries/lwIP_Ethernet/examples/EthSSLValidation/EthSSLValidation.ino b/libraries/lwIP_Ethernet/examples/EthSSLValidation/EthSSLValidation.ino
@@ -198,7 +198,13 @@ void setup() {
 
   Serial.println("\nEthernet\n");
 
-  eth.setDefault(true);  // default route set through this interface
+  // Uncomment `eth.setDefault(true)` to force routing through this interface.
+  // Default is set to false. In this case lwIP selects the best suited
+  // output interface matching the destination address.
+  // If several interfaces match, the first one is picked.
+  // On esp8266/Arduno: WiFi interfaces are checked first.
+  // eth.setDefault(true); // default route set through this interface
+
   if (!ethInitDHCP(eth)) {
     Serial.printf("no hardware found\n");
     while (1)

diff --git a/libraries/lwIP_Ethernet/examples/Eth_mDNS_Clock/Eth_mDNS_Clock.ino b/libraries/lwIP_Ethernet/examples/Eth_mDNS_Clock/Eth_mDNS_Clock.ino
@@ -214,7 +214,13 @@ void setup(void) {
 
   Serial.println("\nEthernet\n");
 
-  eth.setDefault(true);  // default route set through this interface
+  // Uncomment `eth.setDefault(true)` to force routing through this interface.
+  // Default is set to false. In this case lwIP selects the best suited
+  // output interface matching the destination address.
+  // If several interfaces match, the first one is picked.
+  // On esp8266/Arduno: WiFi interfaces are checked first.
+  // eth.setDefault(true); // default route set through this interface
+
   if (!ethInitDHCP(eth)) {
     Serial.printf("no hardware found\n");
     while (1) {