Skip to content

Commit ea8193b

Browse files
authored
Update README (#430)
1 parent f3b131c commit ea8193b

File tree

1 file changed

+16
-9
lines changed

1 file changed

+16
-9
lines changed

docs/ReliableClient/README.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,24 @@
11
Best practices for reliable client
22
----------------------------------
33

4-
This is an example of hot to use the client in a reliable way. By following these best practices, you can ensure that your application will be able to recover from network failures and other issues.
4+
This is an example of how to use the client in a reliable way. By following these best practices, you can ensure
5+
that your application will be able to recover from network failures and other issues.
56

6-
the producer part is the most important, you need to block the sending of messages until the connection is established. This is done by using the `ManualResetEvent` method.
7+
The producer part is the most important: you need to block the sending of messages until the connection is established.
8+
This is done by using the [
9+
`ManualResetEvent`](https://github.com/rabbitmq/rabbitmq-stream-dotnet-client/blob/f3b131cf6688843f2d91854a9d35ebc91be54090/docs/ReliableClient/BestPracticesClient.cs#L251)
10+
class.
711

8-
you'd need also a list to store the messages that were not sent because the connection was not established.
9-
10-
Use the `Identify` method to identify the producer or consumer it the logs.
11-
12-
You should focus in how to deal with the entity `StatusChanged` events.
13-
14-
You can customize the setting using `appsetting.json` file.
12+
You'll also need a list to store any messages that were not sent because the connection was not yet established.
1513

14+
Use the [
15+
`Identifier`](https://github.com/rabbitmq/rabbitmq-stream-dotnet-client/blob/f3b131cf6688843f2d91854a9d35ebc91be54090/docs/ReliableClient/BestPracticesClient.cs#L193-L254)
16+
property to identify the producer or consumer in the logs.
1617

18+
Focus on how to handle the entity-level [
19+
`StatusChanged`](https://github.com/rabbitmq/rabbitmq-stream-dotnet-client/blob/f3b131cf6688843f2d91854a9d35ebc91be54090/docs/ReliableClient/BestPracticesClient.cs#L279-L309)
20+
events.
1721

22+
You can customize the settings by using the [
23+
`appsettings.json`](https://github.com/rabbitmq/rabbitmq-stream-dotnet-client/blob/f3b131cf6688843f2d91854a9d35ebc91be54090/docs/ReliableClient/appsettings.json)
24+
file.

0 commit comments

Comments
 (0)