From c3f1211134e56630dc2799c59dc22dc3c77a1777 Mon Sep 17 00:00:00 2001 From: "Earle F. Philhower, III" Date: Wed, 24 Jul 2019 13:09:46 -0700 Subject: [PATCH] Update WiFiServer docs for ::write(all clients) Fixes #5116 Fixes #2743 The Arduino WiFiClient object allows sending the same packet to all connected clients of a WiFiServer. In their implementation it may make sense, but on the 8266 with things like SSL it doesn't. Update the docs to note that WiFiServer::write() is a no-op, and that the app should use the WiFiCliebnt::write() on all connected clients as appropriate. --- doc/esp8266wifi/server-class.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/esp8266wifi/server-class.rst b/doc/esp8266wifi/server-class.rst index 8855083ab9..5603228378 100644 --- a/doc/esp8266wifi/server-class.rst +++ b/doc/esp8266wifi/server-class.rst @@ -14,6 +14,13 @@ Methods documented for the `Server Class `__ documentation. Before they are fully documented please refer to information below. +write (write to all clients) not supported +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Please note that the ``write`` method on the ``WiFiServer`` object is not implemented and returns failure always. Use the returned +``WiFiClient`` object from the ``WiFiServer::available()`` method to communicate with individual clients. If you need to send +the exact same packets to a series of clients, your application must maintain a list of connected clients and iterate over them manually. + setNoDelay ~~~~~~~~~~