docs: Update Async Context docs #3229
Open
Conversation
This file contains 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
Motivation: CapturedContext is not well represented in the docs now. Modifications: Adjust our documentation to descrive CapturedContext and its use cases.
daschl
reviewed
Apr 11, 2025
| == `AsyncContext` | ||
|
|
||
| Although `AsyncContext` may be convenient to use it shouldn't be overused when traditional argument passing is an | ||
| option. The intended use case of `AsyncContext` is to propagate context across method boundaries which do not |
There was a problem hiding this comment.
also maybe clarify between method and filter boundaries (just clarifying since I assume a big use case is across filters)?
There was a problem hiding this comment.
I changed it to API boundaries.
I'm not sure if filters are generally a good use case since our request and response methods carry a ContextMap themselves. Within the filter chain, this would be my preferred way to store the data since it's very tightly connected to the request and response objects it will be associated with.
idelpivnitskiy
approved these changes
Apr 14, 2025
servicetalk-concurrent-api/docs/modules/ROOT/pages/async-context.adoc
Outdated
Show resolved
Hide resolved
servicetalk-concurrent-api/docs/modules/ROOT/pages/async-context.adoc
Outdated
Show resolved
Hide resolved
servicetalk-concurrent-api/docs/modules/ROOT/pages/async-context.adoc
Outdated
Show resolved
Hide resolved
servicetalk-concurrent-api/docs/modules/ROOT/pages/async-context.adoc
Outdated
Show resolved
Hide resolved
servicetalk-concurrent-api/docs/modules/ROOT/pages/async-context.adoc
Outdated
Show resolved
Hide resolved
idelpivnitskiy
approved these changes
Apr 14, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Motivation:
CapturedContext is not well represented in the docs now.
Modifications:
Adjust our documentation to descrive CapturedContext and its use cases.