Skip to content

Commit dc35567

Browse files
authored
[Service Bus] Retry Options Docs (Azure#21653)
The focus of these changes is to document the default value used for each property of the `ServiceBusRetryOptions`.
1 parent 45177ce commit dc35567

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

sdk/servicebus/Azure.Messaging.ServiceBus/src/Primitives/ServiceBusRetryOptions.cs

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,9 @@ public class ServiceBusRetryOptions
3636
/// to have failed.
3737
/// </summary>
3838
///
39+
///
40+
/// <value>The default retry limit is 3.</value>
41+
///
3942
public int MaxRetries
4043
{
4144
get => _maxRetries;
@@ -52,6 +55,9 @@ public int MaxRetries
5255
/// on which to base calculations for a backoff-based approach.
5356
/// </summary>
5457
///
58+
///
59+
/// <value>The default delay is 0.8 seconds.</value>
60+
///
5561
public TimeSpan Delay
5662
{
5763
get => _delay;
@@ -67,6 +73,9 @@ public TimeSpan Delay
6773
/// The maximum permissible delay between retry attempts.
6874
/// </summary>
6975
///
76+
///
77+
/// <value>The default maximum delay is 60 seconds.</value>
78+
///
7079
public TimeSpan MaxDelay
7180
{
7281
get => _maxDelay;
@@ -83,6 +92,9 @@ public TimeSpan MaxDelay
8392
/// attempt or a retry.
8493
/// </summary>
8594
///
95+
///
96+
/// <value>The default timeout is 60 seconds.</value>
97+
///
8698
public TimeSpan TryTimeout
8799
{
88100
get => _tryTimeout;

0 commit comments

Comments
 (0)