Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft: AsyncWebServer queue support #4119

Open
wants to merge 12 commits into
base: 0_15
Choose a base branch
from

Conversation

willmmiles
Copy link
Collaborator

Add queuing capabilities to AsyncWebServer, allowing deferred request handling to spread out memory load, generating 503 responses when the device is overloaded, and effectively preventing the web API from causing OOM crashes.

This PR should be considered beta quality; the upstream branch has not yet been merged, pending wider testing. I've tested it as thoroughly as I can, given my limited stable of devices, and I have run out of ways to make them hang or crash with curl. Please consider merging this branch with your work-in-progress code to try it in more devices and under different load conditions.

Update ESPAsyncWebserver and AsyncTCP dependency calls to the
queue supporting branches.
Enable the new concurrent request and queue size limit features
of AsyncWebServer.  This should improve the handling of burst
traffic or many clients, and significantly reduce the likelihood
of OOM crashes due to HTTP requests.
This can be helpful for debugging web handler related issues.
Use the web server's queuing mechanism to call us back later.
No locking contention, but a much larger target
Update based on empirical data on an ESP32-WROVER, -WROOM, and -S2.
@willmmiles willmmiles marked this pull request as draft August 27, 2024 18:02
@blazoncek
Copy link
Collaborator

When I get home from vacation I'll give it a spin.

@willmmiles willmmiles marked this pull request as ready for review September 14, 2024 20:56
@softhack007 softhack007 added this to the 0.15.1 candidate milestone Sep 28, 2024
@softhack007 softhack007 added enhancement optimization re-working an existing feature to be faster, or use less memory labels Oct 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement optimization re-working an existing feature to be faster, or use less memory
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants