Skip to content

Commit e42d8fe

Browse files
committed
Update documentation
Signed-off-by: Gabriele Santomaggio <[email protected]>
1 parent 0230751 commit e42d8fe

File tree

3 files changed

+11
-2
lines changed

3 files changed

+11
-2
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The RabbitMQ Stream .NET Client is a .NET library to communicate with the [Rabbi
1616

1717
The client is distributed via [NuGet](https://www.nuget.org/packages/RabbitMQ.Stream.Client/).
1818

19-
Please refer to the [documentation](https://rabbitmq.github.io/rabbitmq-stream-dotnet-client/stable/htmlsingle/index.html) ([PDF](https://rabbitmq.github.io/rabbitmq-stream-dotnet-client/stable/documentation.pdf)) to find out more.
19+
Please refer to the [documentation](https://rabbitmq.github.io/rabbitmq-stream-dotnet-client/stable/htmlsingle/index.html) ([PDF](https://rabbitmq.github.io/rabbitmq-stream-dotnet-client/stable/dotnet-stream-client.pdf)) to find out more.
2020

2121

2222
### Support

RabbitMQ.Stream.Client/Reliable/Producer.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ public class Producer : ProducerFactory
133133

134134
protected override ILogger BaseLogger => _logger;
135135

136-
private protected Producer(ProducerConfig producerConfig, ILogger<Producer> logger = null)
136+
private Producer(ProducerConfig producerConfig, ILogger<Producer> logger = null)
137137
{
138138
_producerConfig = producerConfig;
139139
_confirmationPipe = new ConfirmationPipe(

docs/asciidoc/api.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -978,6 +978,15 @@ Like the `RawProducer` class, the `Raw*` classes have the same events to handle
978978

979979
It is up to the user to handle the disconnection and metadata update events.
980980

981+
[WARNING]
982+
.Be careful when using the `Raw*` classes.
983+
====
984+
They are low-level classes and you need to handle the disconnection and metadata update events. If you don't handle them, you will end up with a disconnected client and you will not be able to reconnect to the server.
985+
986+
"RawProducer:send" is not thread-safe. You need to synchronize access to it.
987+
"RawProducer" does not handle the timeout/error confirmation messages. You need to handle it yourself.
988+
====
989+
981990
===== High-level classes
982991

983992
** <<creating-a-producer, `Producer`>> - High-level producer class

0 commit comments

Comments
 (0)