Skip to content

Commit a6fe61c

Browse files
authored
add abandonment remarks to AutoCompleteMessages docs (Azure#23528)
1 parent aca2b75 commit a6fe61c

File tree

3 files changed

+12
-0
lines changed

3 files changed

+12
-0
lines changed

sdk/servicebus/Azure.Messaging.ServiceBus/src/Processor/ServiceBusProcessor.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,10 @@ public class ServiceBusProcessor : IAsyncDisposable
133133
/// message handler triggers an exception, the message will not be automatically
134134
/// completed.
135135
/// </summary>
136+
/// <remarks>
137+
/// If the message handler triggers an exception and did not settle the message,
138+
/// then the message will be automatically abandoned, irrespective of <see cref= "AutoCompleteMessages" />.
139+
/// </remarks>
136140
///
137141
/// <value>true to complete the message processing automatically on
138142
/// successful execution of the operation; otherwise, false.</value>

sdk/servicebus/Azure.Messaging.ServiceBus/src/Processor/ServiceBusProcessorOptions.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,10 @@ public int PrefetchCount
5050
/// should automatically complete messages after the <see cref="ServiceBusProcessor.ProcessMessageAsync"/> handler has
5151
/// completed processing. If the message handler triggers an exception, the message will not be automatically completed.
5252
/// </summary>
53+
/// <remarks>
54+
/// If the message handler triggers an exception and did not settle the message,
55+
/// then the message will be automatically abandoned, irrespective of <see cref= "AutoCompleteMessages" />.
56+
/// </remarks>
5357
///
5458
/// <value><c>true</c> to complete the message automatically on successful execution of the message handler; otherwise, <c>false</c>.
5559
/// The default value is <c>true</c>.</value>

sdk/servicebus/Azure.Messaging.ServiceBus/src/Processor/ServiceBusSessionProcessorOptions.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,10 @@ public int PrefetchCount
3737
/// handler has completed processing. If the message handler triggers an exception,
3838
/// the message will not be automatically completed.
3939
/// </summary>
40+
/// <remarks>
41+
/// If the message handler triggers an exception and did not settle the message,
42+
/// then the message will be automatically abandoned, irrespective of <see cref= "AutoCompleteMessages" />.
43+
/// </remarks>
4044
///
4145
/// <value><c>true</c> to complete the message automatically on successful execution of the message handler; otherwise, <c>false</c>.
4246
/// The default value is <c>true</c>.</value>

0 commit comments

Comments
 (0)