Skip to content

Commit 3747041

Browse files
committed
Add documentation explaining that PublisherConfirmationTrackingEnabled adds a header to every message.
1 parent b32b300 commit 3747041

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

projects/RabbitMQ.Client/CreateChannelOptions.cs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@
3030
//---------------------------------------------------------------------------
3131

3232
using System.Threading.RateLimiting;
33-
using RabbitMQ.Client.Impl;
3433

3534
namespace RabbitMQ.Client
3635
{
@@ -46,6 +45,11 @@ public sealed class CreateChannelOptions
4645

4746
/// <summary>
4847
/// Should this library track publisher confirmations for you? Defaults to <c>false</c>
48+
///
49+
/// When enabled, the <see cref="Constants.PublishSequenceNumberHeader" /> header will be
50+
/// added to every published message, and will contain the message's publish sequence number.
51+
/// If the broker then sends a <c>basic.return</c> response for the message, this library can
52+
/// then correctly handle the message.
4953
/// </summary>
5054
public bool PublisherConfirmationTrackingEnabled { get; set; } = false;
5155

0 commit comments

Comments
 (0)