WiFiServer - deprecate available(), use accept() everywhere (espressi…

…f#8860) esp8266 and esp32 server.available() is not implemented as documented it is implemented like server.accept() is documented by Arduino Co-authored-by: Rodrigo Garcia <[email protected]>
pillo79 · Nov 27, 2023 · 990e3d5 · 990e3d5
1 parent 1e980bd
commit 990e3d5
Show file tree

Hide file tree

Showing 7 changed files with 12 additions and 8 deletions.
diff --git a/libraries/ESPmDNS/examples/mDNS_Web_Server/mDNS_Web_Server.ino b/libraries/ESPmDNS/examples/mDNS_Web_Server/mDNS_Web_Server.ino
@@ -69,7 +69,7 @@ void setup(void)
 void loop(void)
 {
     // Check if a client has connected
-    WiFiClient client = server.available();
+    WiFiClient client = server.accept();
     if (!client) {
         return;
     }

diff --git a/libraries/WebServer/src/WebServer.cpp b/libraries/WebServer/src/WebServer.cpp
@@ -274,7 +274,7 @@ void WebServer::serveStatic(const char* uri, FS& fs, const char* path, const cha
 
 void WebServer::handleClient() {
   if (_currentStatus == HC_NONE) {
-    _currentClient = _server.available();
+    _currentClient = _server.accept();
     if (!_currentClient) {
       if (_nullDelay) {
         delay(1);

diff --git a/libraries/WiFi/examples/SimpleWiFiServer/SimpleWiFiServer.ino b/libraries/WiFi/examples/SimpleWiFiServer/SimpleWiFiServer.ino
@@ -63,7 +63,7 @@ void setup()
 }
 
 void loop(){
- WiFiClient client = server.available();   // listen for incoming clients
+ WiFiClient client = server.accept();   // listen for incoming clients
 
   if (client) {                             // if you get a client,
     Serial.println("New Client.");           // print a message out the serial port

diff --git a/libraries/WiFi/examples/WiFiAccessPoint/WiFiAccessPoint.ino b/libraries/WiFi/examples/WiFiAccessPoint/WiFiAccessPoint.ino
@@ -48,7 +48,7 @@ void setup() {
 }
 
 void loop() {
-  WiFiClient client = server.available();   // listen for incoming clients
+  WiFiClient client = server.accept();   // listen for incoming clients
 
   if (client) {                             // if you get a client,
     Serial.println("New Client.");           // print a message out the serial port

diff --git a/libraries/WiFi/examples/WiFiTelnetToSerial/WiFiTelnetToSerial.ino b/libraries/WiFi/examples/WiFiTelnetToSerial/WiFiTelnetToSerial.ino
@@ -78,7 +78,7 @@ void loop() {
         //find free/disconnected spot
         if (!serverClients[i] || !serverClients[i].connected()){
           if(serverClients[i]) serverClients[i].stop();
-          serverClients[i] = server.available();
+          serverClients[i] = server.accept();
           if (!serverClients[i]) Serial.println("available broken");
           Serial.print("New client: ");
           Serial.print(i); Serial.print(' ');
@@ -88,7 +88,7 @@ void loop() {
       }
       if (i >= MAX_SRV_CLIENTS) {
         //no free/disconnected spot so reject
-        server.available().stop();
+        server.accept().stop();
       }
     }
     //check clients for data

diff --git a/libraries/WiFi/src/WiFiServer.cpp b/libraries/WiFi/src/WiFiServer.cpp
@@ -39,6 +39,10 @@ size_t WiFiServer::write(const uint8_t *data, size_t len){
 void WiFiServer::stopAll(){}
 
 WiFiClient WiFiServer::available(){
+  return accept();
+}
+
+WiFiClient WiFiServer::accept(){
   if(!_listening)
     return WiFiClient();
   int client_sock;

diff --git a/libraries/WiFi/src/WiFiServer.h b/libraries/WiFi/src/WiFiServer.h
@@ -45,8 +45,8 @@ class WiFiServer : public Server {
       log_v("WiFiServer::WiFiServer(addr=%s, port=%d, ...)", addr.toString().c_str(), port);
     }
     ~WiFiServer(){ end();}
-    WiFiClient available();
-    WiFiClient accept(){return available();}
+    WiFiClient available() __attribute__((deprecated("Renamed to accept().")));
+    WiFiClient accept();
     void begin(uint16_t port=0);
     void begin(uint16_t port, int reuse_enable);
     void setNoDelay(bool nodelay);