Skip to content

Commit

Permalink
Add documentation explaining that `PublisherConfirmationTrackingEnabl…
Browse files Browse the repository at this point in the history
…ed` adds a header to every message.
  • Loading branch information
lukebakken committed Oct 23, 2024
1 parent 413068a commit 4d7a1c7
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion projects/RabbitMQ.Client/CreateChannelOptions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@
//---------------------------------------------------------------------------

using System.Threading.RateLimiting;
using RabbitMQ.Client.Impl;

namespace RabbitMQ.Client
{
Expand All @@ -46,6 +45,11 @@ public sealed class CreateChannelOptions

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

Expand Down

0 comments on commit 4d7a1c7

Please sign in to comment.