Skip to content

📚 Improve docs for unbounded memory use and thread safety #418

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

Conversation

nevans
Copy link
Collaborator

@nevans nevans commented Mar 22, 2025

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.

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 force-pushed the docs-for-receiver-thread-and-managing-server-responses branch from 14c7bb9 to 9df57b7 Compare March 22, 2025 19:07
@nevans nevans changed the title 📚 Add docs for receiver thread & server responses 📚 Improve docs for thread safety and unbounded memory use Mar 22, 2025
@nevans nevans changed the title 📚 Improve docs for thread safety and unbounded memory use 📚 Improve docs for unbounded memory use and thread safety Mar 22, 2025
@nevans nevans added the documentation Improvements or additions to documentation label Mar 22, 2025
@nevans nevans merged commit a6b803b into master Mar 22, 2025
37 checks passed
@nevans nevans deleted the docs-for-receiver-thread-and-managing-server-responses branch March 22, 2025 19:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant