Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Inline documentation: Document clarity: IReliableQueue API concurrency #807

Closed
CamSoper opened this issue Mar 12, 2018 · 1 comment
Closed
Assignees

Comments

@CamSoper
Copy link

This is a reference doc issue that requires a change to the underlying /// comments.

From @yatli (Azure/azure-docs-sdk-dotnet#405):

https://github.com/Azure/azure-docs-sdk-dotnet/blob/99dbe1fc35599241d91e3409af4fa2a75f86da64/xml/Microsoft.ServiceFabric.Data.Collections/IReliableQueue%601.xml#L30

Transaction is the unit of concurrency: Users can have multiple transactions in-flight at any given point of time but for a given transaction each API must be called one at a time.
So all Reliable Collection APIs that take in a transaction and return a Task, must be awaited one at a time.

I don't see the causality here. The first sentence states that if we inspect each transaction individually (regardless of the other txs), we call the APIs sequentially.
The second sentence states that for all the APIs that are ITransaction -> Task, they should be awaited sequentially.
If we wait for tasks from different txs concurrently, rule 1 holds but rule 2 doesn't. This means rule 2 is not an implication of rule 1.

Can someone elaborate on this? We should either remove So, or remove rule 2 altogether.

@gkhanna79 gkhanna79 transferred this issue from microsoft/service-fabric-issues Apr 29, 2020
@CamSoper
Copy link
Author

Cleaning up my open issues. Feel free to re-open if needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants