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

Add Thread Safety and Additional Concepts README sections to Event Hubs and Service Bus #18548

Closed
kinelski opened this issue Feb 8, 2021 · 0 comments
Assignees
Labels
Client This issue points to a problem in the data-plane of the library. Docs Event Hubs Service Bus
Milestone

Comments

@kinelski
Copy link
Member

kinelski commented Feb 8, 2021

The READMEs in our libraries usually contain the following sections:

### Thread safety
We guarantee that all client instance methods are thread-safe and independent of each other ([guideline](https://azure.github.io/azure-sdk/dotnet_introduction.html#dotnet-service-methods-thread-safety)). This ensures that the recommendation of reusing client instances is always safe, even across threads.

### Additional concepts
<!-- CLIENT COMMON BAR -->
[Client options](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/README.md#configuring-service-clients-using-clientoptions) |
[Accessing the response](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/README.md#accessing-http-response-details-using-responset) |
[Long-running operations](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/README.md#consuming-long-running-operations-using-operationt) |
[Handling failures](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/README.md#reporting-errors-requestfailedexception) |
[Diagnostics](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/samples/Diagnostics.md) |
[Mocking](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/README.md#mocking) |
[Client lifetime](https://devblogs.microsoft.com/azure-sdk/lifetime-management-and-thread-safety-guarantees-of-azure-sdk-net-clients/)
<!-- CLIENT COMMON BAR -->

Many of the examples and concepts in these sections are not relevant to the messaging libraries due to the references to the Azure.Core pipeline and HTTP specifics, so they haven't been added to Event Hubs and Service Bus (discussion here).

Goal: include these sections in the READMEs of the Event Hubs and Service Bus libraries with the content that's applicable to them.

@kinelski kinelski added Service Bus Event Hubs Client This issue points to a problem in the data-plane of the library. Docs labels Feb 8, 2021
@kinelski kinelski added this to the Backlog milestone Feb 8, 2021
@jsquire jsquire self-assigned this Feb 8, 2021
@jsquire jsquire modified the milestones: Backlog, [2021] March Feb 8, 2021
@jsquire jsquire closed this as completed Feb 17, 2021
@github-actions github-actions bot locked and limited conversation to collaborators Mar 28, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Client This issue points to a problem in the data-plane of the library. Docs Event Hubs Service Bus
Projects
None yet
Development

No branches or pull requests

2 participants