Explain function of special PolledTimeout to the code reader

dok-net · dok-net · commit 28c33b2c95b3 · 2021-04-28T14:15:59.000+02:00
diff --git a/libraries/ESP8266WiFi/src/ESP8266WiFiSTA.cpp b/libraries/ESP8266WiFi/src/ESP8266WiFiSTA.cpp
@@ -431,6 +431,7 @@ int8_t ESP8266WiFiSTAClass::waitForConnectResult(unsigned long timeoutLength) {
     if((wifi_get_opmode() & 1) == 0) {
         return WL_DISCONNECTED;
     }
+    // if probing doesn't trip, this yields
     using oneShotYieldMs = esp8266::polledTimeout::timeoutTemplate<false, esp8266::polledTimeout::YieldPolicy::YieldOrSkip>;
     oneShotYieldMs timeout(timeoutLength); // number of milliseconds to wait before returning timeout error
     while(!timeout) {

Original file line number	Diff line number	Diff line change
`@@ -431,6 +431,7 @@ int8_t ESP8266WiFiSTAClass::waitForConnectResult(unsigned long timeoutLength) {`
`431`	`431`	`if((wifi_get_opmode() & 1) == 0) {`
`432`	`432`	`return WL_DISCONNECTED;`
`433`	`433`	`}`
	`434`	`+ // if probing doesn't trip, this yields`
`434`	`435`	`using oneShotYieldMs = esp8266::polledTimeout::timeoutTemplate<false, esp8266::polledTimeout::YieldPolicy::YieldOrSkip>;`
`435`	`436`	`oneShotYieldMs timeout(timeoutLength); // number of milliseconds to wait before returning timeout error`
`436`	`437`	`while(!timeout) {`