Skip to content

📚 Docs: receiver thread, server responses, connection state #437

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

Merged
merged 3 commits into from
Apr 20, 2025

Conversation

nevans
Copy link
Collaborator

@nevans nevans commented Apr 20, 2025

nevans added 3 commits April 20, 2025 13:49
Because a `#connection_state` attribute will be added, I'd like to
consistently name the connection states everywhere they are used.
Most importantly, this documents the scenarios that need extra care to
avoid memory leaks:
* Commands such as #list or #fetch can have an enormous number of
  responses.
* Commands such as #fetch can result in an enormous size per response.
* Long-lived connections will gradually accumulate unsolicited server
  responses, especially +EXISTS+, +FETCH+, and +EXPUNGE+ responses.
* A buggy or untrusted server could send inappropriate responses, which
  could be very numerous, very large, and very rapid.
@nevans nevans merged commit 945df80 into v0.3-stable Apr 20, 2025
34 checks passed
@nevans nevans deleted the backport/v0.3-document-response-limits branch April 20, 2025 22:22
@nevans nevans added documentation Improvements or additions to documentation backport This issue or PR is for a stable release branch labels Apr 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport This issue or PR is for a stable release branch documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant