- Notifications
You must be signed in to change notification settings - Fork1.6k
Add info about failure modes to ConcurrentQueue Try methods#11588
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Open
Smaug123 wants to merge1 commit intodotnet:mainChoose a base branch
base:main
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
+4 −4
Conversation
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
Tagging subscribers to this area: @dotnet/area-system-collections |
| @@ -551,7 +551,7 @@ | |||
| <param name="item">The object to add to the <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection`1" />. The value can be a null reference (Nothing in Visual Basic) for reference types.</param> | |||
| <summary>Attempts to add an object to the <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection`1" />.</summary> | |||
| <returns> | |||
| <see langword="true" /> if the object was added successfully; otherwise, <see langword="false" />.</returns> | |||
| <see langword="true" /> if the object was added successfully; otherwise, <see langword="false" />. (This operation never returns <see langword="false" /> for <xref:System.Collections.Concurrent.ConcurrentQueue%601>.)</returns> | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Thisis mentioned in the remarks section below, but that is not the first place I looked for the answer, suggesting that more docs are required.
22ab3e8 to6b8088dCompareSign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Labels
area-System.Collectionscommunity-contributionIndicates that the PR has been added by a community member
1 participant
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
The docs are currently silent on the failure modes of most of the
System.Collections.Generic.ConcurrentQueue.Try*methods. This PR clarifies what I believe are the semantics: that theTryoperations can only fail for the trivial reason that the queue was empty at the time the operation was attempted.