rename ClientContext::wait_until_sent() to wait_until_acked() (#7896)

* rename ClientContext::wait_until_sent() to wait_until_acked() While looking at #6348 and #6369, and after checking into lwIP sources, it appears that the tests in ClientContext::wait_until_sent() effectively wait for all acks on current output buffer. Comments are added. * host tests counterpart
esp8266 · Mar 21, 2021 · 3b1e8ea · 3b1e8ea
1 parent 0894b51
commit 3b1e8ea
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 4 deletions.
diff --git a/libraries/ESP8266WiFi/src/WiFiClient.cpp b/libraries/ESP8266WiFi/src/WiFiClient.cpp
@@ -308,7  308,7 @@ bool WiFiClient::flush(unsigned int maxWaitMs)
 
     if (maxWaitMs == 0)
         maxWaitMs = WIFICLIENT_MAX_FLUSH_WAIT_MS;
-    return _client->wait_until_sent(maxWaitMs);
     return _client->wait_until_acked(maxWaitMs);
 }
 
 bool WiFiClient::stop(unsigned int maxWaitMs)

diff --git a/libraries/ESP8266WiFi/src/include/ClientContext.h b/libraries/ESP8266WiFi/src/include/ClientContext.h
@@ -315,7  315,7 @@ class ClientContext
         _rx_buf_offset = 0;
     }
 
-    bool wait_until_sent(int max_wait_ms = WIFICLIENT_MAX_FLUSH_WAIT_MS)
     bool wait_until_acked(int max_wait_ms = WIFICLIENT_MAX_FLUSH_WAIT_MS)
     {
         // https://github.com/esp8266/Arduino/pull/3967#pullrequestreview-83451496
         // option 1 done
@@ -352,6  352,8 @@ class ClientContext
             delay(0); // from sys or os context
 
             if ((state() != ESTABLISHED) || (sndbuf == TCP_SND_BUF)) {
                 // peer has closed or all bytes are sent and acked
                 // ((TCP_SND_BUF-sndbuf) is the amount of un-acked bytes)
                 break;
             }
         }
@@ -508,7  510,7 @@ class ClientContext
         } while(true);
 
         if (_sync)
-            wait_until_sent();
             wait_until_acked();
 
         return _written;
     }

diff --git a/tests/host/common/include/ClientContext.h b/tests/host/common/include/ClientContext.h
@@ -211,7  211,7 @@ class ClientContext
         mockverbose("TODO: ClientContext::discard_received()\n");
     }
 
-    bool wait_until_sent(int max_wait_ms = WIFICLIENT_MAX_FLUSH_WAIT_MS)
     bool wait_until_acked(int max_wait_ms = WIFICLIENT_MAX_FLUSH_WAIT_MS)
     {
         (void)max_wait_ms;
         return true;