docs(client): document Drop behavior for Connection types#4064
Merged
seanmonstar merged 1 commit intohyperium:masterfrom May 8, 2026
Merged
docs(client): document Drop behavior for Connection types#4064seanmonstar merged 1 commit intohyperium:masterfrom
seanmonstar merged 1 commit intohyperium:masterfrom
Conversation
Explain what happens when Connection is dropped: the underlying IO resource is closed and in-flight requests are interrupted. Suggest polling to completion for graceful shutdown. Closes hyperium#3192
dswij
approved these changes
May 8, 2026
seanmonstar
approved these changes
May 8, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds documentation for the Drop behavior of Connection types in both http1 and http2 client connection modules.
Currently, the docs explain that Connection should be polled, but do not mention what happens if it is dropped. This PR clarifies that dropping the Connection closes the underlying IO resource and interrupts in-flight requests.
Closes #3192
Changes