Skip to content

Commit 698d7f7

Browse files
[Service Bus] Clarify what retry options govern (Azure#38146)
* [Service Bus] Clarify what retry options govern The focus of these changes is to add text to clarify what the `ServiceBusClientOptions.RetryOptions` govern and explicitly mention that developers are responsible for handling failures and performing retries for message processing done by the application. * Update sdk/servicebus/Azure.Messaging.ServiceBus/src/Client/ServiceBusClientOptions.cs Co-authored-by: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com> * Reword to incorporate feedback * Remove trailing whitespace * Trailing whitespace (again) --------- Co-authored-by: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com>
1 parent f738f6a commit 698d7f7

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

sdk/servicebus/Azure.Messaging.ServiceBus/src/Client/ServiceBusClientOptions.cs

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,10 +86,15 @@ public TimeSpan ConnectionIdleTimeout
8686
}
8787

8888
/// <summary>
89-
/// The set of options to use for determining whether a failed operation should be retried and,
89+
/// The set of options to use for determining whether a failed service operation should be retried and,
9090
/// if so, the amount of time to wait between retry attempts. These options also control the
91-
/// amount of time allowed for receiving messages and other interactions with the Service Bus service.
91+
/// amount of time allowed for the individual network operations used for interactions with the Service Bus service.
9292
/// </summary>
93+
/// <remarks>
94+
/// The retry options are only considered for interactions with the Service Bus service. They do not apply to failures in the
95+
/// <see cref="ServiceBusProcessor.ProcessMessageAsync" /> handler. Developers are responsible for error handling and retries
96+
/// as part of their event handler.
97+
///</remarks>
9398
public ServiceBusRetryOptions RetryOptions
9499
{
95100
get => _retryOptions;

0 commit comments

Comments
 (0)