docs: document io_context teardown precondition (#298)#307
Merged
Conversation
Document that an io_context must outlive every post/dispatch through its executor, that no thread may be inside a run variant at destruction, and that outstanding work must be drained before the context is destroyed. Added to the io_context class docstring, its executor's dispatch()/post() operations, and the I/O Context guide.
|
An automated preview of the documentation is available at https://307.corosio.prtest3.cppalliance.org/index.html If more commits are pushed to the pull request, the docs will rebuild at the same URL. 2026-07-06 17:36:09 UTC |
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
2 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.
Document that an io_context must outlive every post/dispatch through its executor, that no thread may be inside a run variant at destruction, and that outstanding work must be drained before the context is destroyed. Added to the io_context class docstring, its executor's dispatch()/post() operations, and the I/O Context guide.