Updated ServerBusyException (#2069)

Azure · Jul 16, 2021 · ffd4a69 · ffd4a69
1 parent 3b571c1
commit ffd4a69
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/iothub/device/src/Common/Exceptions/ServerBusyException.cs b/iothub/device/src/Common/Exceptions/ServerBusyException.cs
@@ -9,6 +9,9 @@ namespace Microsoft.Azure.Devices.Client.Exceptions
     /// <summary>
     /// The exception that is thrown when the IoT Hub is busy.
     /// </summary>
+    /// <remarks>
+    /// This exception typically means the service is unavilable due to high load or an unexpected error and is usually transient. The best course of action is to retry your operation after some time. By default, the SDK will utilize the <see cref="ExponentialBackoff"/> retry strategy.
+    /// </remarks>
     [Serializable]
     public sealed class ServerBusyException : IotHubException
     {

diff --git a/iothub/service/src/Common/Exceptions/ServerBusyException.cs b/iothub/service/src/Common/Exceptions/ServerBusyException.cs
@@ -7,9 +7,11 @@
 namespace Microsoft.Azure.Devices.Common.Exceptions
 {
     /// <summary>
-    /// The exception that is thrown when IoT Hub is busy with previous requests.
-    /// Callers should wait a while and retry the operation.
+    /// The exception that is thrown when the IoT Hub is busy.
     /// </summary>
+    /// <remarks>
+    /// This exception typically means the service is unavilable due to high load or an unexpected error and is usually transient. The best course of action is to retry your operation after some time. By default, the SDK will utilize the <see cref="ExponentialBackoff"/> retry strategy.
+    /// </remarks>
     [Serializable]
     public sealed class ServerBusyException : IotHubException
     {