Add chunkedResponseModeStart, sendChunk, chunkedResponseFinalize

to WebServer library for chunked HTTP responses

Author: ritesh006

libraries/WebServer/src/WebServer.cpp

@@ -551,6 +551,76 @@ void WebServer::enableETag(bool enable, ETagFunction fn) {
   _eTagFunction = fn;
 }
 
+void WebServer::chunkedResponseModeStart(const char* contentType) {
+  if (_chunkedResponseActive) {
+    log_e("Already in chunked response mode");
+    return;
+  }
+
+  // Validate contentType for CRLF injection
+  if (strchr(contentType, '\r') || strchr(contentType, '\n')) {
+    log_e("Invalid character in content type");
+    return;
+  }
+
+  // Tell framework response length is unknown (chunked)
+  _contentLength = CONTENT_LENGTH_UNKNOWN;
+
+  // Prepare and send headers properly once
+  String header;
+  _prepareHeader(header, 200, contentType, 0);
+  _currentClientWrite(header.c_str(), header.length());
+
+  // Activate chunked mode and store client by value (safe)
+  _chunkedResponseActive = true;
+  _chunkedClient = _currentClient;
+}
+
+void WebServer::sendChunk(const char* data, size_t length) {
+  if (!_chunkedResponseActive) return;
+
+  char chunkSize[11]; // Enough for size_t in hex + CRLF + null
+  snprintf(chunkSize, sizeof(chunkSize), "%zx\r\n", length);
+
+  if (_chunkedClient.write(chunkSize) != strlen(chunkSize)) {
+    log_e("Failed to write chunk size");
+    _chunkedResponseActive = false;
+    return;
+  }
+
+  if (_chunkedClient.write((const uint8_t*)data, length) != length) {
+    log_e("Failed to write chunk data");
+    _chunkedResponseActive = false;
+    return;
+  }
+
+  if (_chunkedClient.write("\r\n") != 2) {
+    log_e("Failed to write chunk terminator");
+    _chunkedResponseActive = false;
+    return;
+  }
+
+  // Optionally flush here or less frequently for better performance
+  // _chunkedClient.flush();
+}
+
+void WebServer::chunkedResponseFinalize() {
+  if (!_chunkedResponseActive) return;
+
+  if (_chunkedClient.write("0\r\n\r\n", 5) != 5) {
+    log_e("Failed to write terminating chunk");
+  }
+
+  _chunkedClient.flush();
+
+  // Do NOT call stop() to allow framework to handle connection lifetime
+  _chunkedResponseActive = false;
+  _chunked = false;
+  _chunkedClient = NetworkClient();
+
+  _clearResponseHeaders(); // Clear headers set by sendHeader()
+}
+
 void WebServer::_prepareHeader(String &response, int code, const char *content_type, size_t contentLength) {
   _responseCode = code;
 

libraries/WebServer/src/WebServer.h

@@ -25,6 +25,7 @@
 
 #include <functional>
 #include <memory>
+#include <WiFi.h>
 #include "FS.h"
 #include "Network.h"
 #include "HTTP_Method.h"
@@ -115,6 +116,10 @@ class WebServer {
   const String AuthTypeDigest = F("Digest");
   const String AuthTypeBasic = F("Basic");
 
+  void chunkedResponseModeStart(const char* contentType = "text/plain");
+  void sendChunk(const char* data, size_t length);
+  void chunkedResponseFinalize();
+
   /* Callbackhandler for authentication. The extra parameters depend on the
    * HTTPAuthMethod mode:
    *
@@ -241,6 +246,10 @@ class WebServer {
 
   static String responseCodeToString(int code);
 
+private:
+  bool _chunkedResponseActive = false;
+  NetworkClient _chunkedClient; // Store by value, no dangling pointer
+
 protected:
   virtual size_t _currentClientWrite(const char *b, size_t l) {
     return _currentClient.write(b, l);