search

Azure / azure-sdk-for-net

This repository is for active development of the Azure SDK for .NET. For consumers of the SDK we recommend visiting our public developer docs at https://learn.microsoft.com/dotnet/azure/ or our versioned developer docs at https://azure.github.io/azure-sdk-for-net.
MIT License
5.25k stars 4.58k forks source link

IReliableConcurrentQueue<T>.TryDequeue Timeout behavior description #21326

Closed smstuebe closed 5 months ago

smstuebe commented 3 years ago

The documentations says:

If a value was dequeued within the given time, return a ConditionalValue with HasValue as false, else it returns a ConditionalValue with HasValue as true and the Value as the dequeued item of Type T

shouldn't it be:

If a value was >>>not<<< dequeued within the given time, return a ConditionalValue with HasValue as false, else it returns a ConditionalValue with HasValue as true and the Value as the dequeued item of Type T

?

Second topic I as a reader can't understand what the exact timeout behavior is, because there is this the sentence I mentioned above, but there is also a TimeOutException. The documentation should be more explicitly about the differences and when wich case happens.

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

ghost commented 3 years ago

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @QingChenmsft, @vaishnavk, @juhacket.

Issue Details
The documentations says: > If a value was dequeued within the given time, return a ConditionalValue with HasValue as false, else it returns a ConditionalValue with HasValue as true and the Value as the dequeued item of Type T shouldn't it be: > If a value was >>>not<<< dequeued within the given time, return a ConditionalValue with HasValue as false, else it returns a ConditionalValue with HasValue as true and the Value as the dequeued item of Type T ? **Second topic** I as a reader can't understand what the exact timeout behavior is, because there is this the sentence I mentioned above, but there is also a `TimeOutException`. The documentation should be more explicitly about the differences and when wich case happens. --- #### Document Details ⚠ *Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.* * ID: 717b1d3d-c79c-79bf-d5e6-580ab89954ed * Version Independent ID: 3e72f47e-8899-ce6e-1fb8-c18ef8a3c978 * Content: [IReliableConcurrentQueue<T>.TryDequeueAsync(ITransaction, CancellationToken, Nullable<TimeSpan>) Method (Microsoft.ServiceFabric.Data.Collections) - Azure for .NET Developers](https://docs.microsoft.com/en-us/dotnet/api/microsoft.servicefabric.data.collections.ireliableconcurrentqueue-1.trydequeueasync?f1url=%3FappId%3DDev16IDEF1%26l%3DEN-US%26k%3Dk(Microsoft.ServiceFabric.Data.Collections.IReliableConcurrentQueue%601.TryDequeueAsync);k(SolutionItemsProject);k(DevLang-csharp)%26rd%3Dtrue&view=azure-dotnet) * Content Source: [xml/Microsoft.ServiceFabric.Data.Collections/IReliableConcurrentQueue`1.xml](https://github.com/Azure/azure-docs-sdk-dotnet/blob/master/xml/Microsoft.ServiceFabric.Data.Collections/IReliableConcurrentQueue`1.xml) * Service: **service-fabric** * GitHub Login: @rloutlaw * Microsoft Alias: **routlaw**
Author: smstuebe
Assignees: -
Labels: `Client`, `Docs`, `Service Attention`, `Service Fabric`, `customer-reported`, `needs-team-attention`, `needs-triage`, `question`
Milestone: -
jsquire commented 3 years ago

Thank you for your feedback. Tagging and routing to the team best able to assist.

SaurabhSharma-MSFT commented 2 years ago

@QingChenmsft, @vaishnavk, @juhacket Do you have any updates on this issue.

github-actions[bot] commented 6 months ago

Hi @smstuebe, we deeply appreciate your input into this project. Regrettably, this issue has remained inactive for over 2 years, leading us to the decision to close it. We've implemented this policy to maintain the relevance of our issue queue and facilitate easier navigation for new contributors. If you still believe this topic requires attention, please feel free to create a new issue, referencing this one. Thank you for your understanding and ongoing support.

github-actions[bot] commented 5 months ago

Hi @smstuebe, we deeply appreciate your input into this project. Regrettably, this issue has remained inactive for over 2 years, leading us to the decision to close it. We've implemented this policy to maintain the relevance of our issue queue and facilitate easier navigation for new contributors. If you still believe this topic requires attention, please feel free to create a new issue, referencing this one. Thank you for your understanding and ongoing support.