feat(device): add support for DisposeAsync

Azure · May 21, 2021 · b50d5eb · b50d5eb
1 parent 8eefef4
commit b50d5eb
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 2 deletions.
diff --git a/iothub/device/src/DeviceClient.cs b/iothub/device/src/DeviceClient.cs
@@ -3,6 +3,7 @@
 
 using System;
 using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 using System.IO;
 using System.Threading;
 using System.Threading.Tasks;
@@ -16,6 +17,9 @@ namespace Microsoft.Azure.Devices.Client
     /// </summary>
     /// <threadsafety static="true" instance="true" />
     public class DeviceClient : IDisposable
+#if !NET451 && !NET472 && !NETSTANDARD2_0
+        , IAsyncDisposable
+#endif
     {
         /// <summary>
         /// Default operation timeout.
@@ -613,12 +617,50 @@ public void SetConnectionStatusChangesHandler(ConnectionStatusChangesHandler sta
         /// <summary>
         /// Releases the unmanaged resources used by the DeviceClient and optionally disposes of the managed resources.
         /// </summary>
+        /// <remarks>
+        /// The method <see cref="CloseAsync()"/> should be called before disposing.
+        /// </remarks>
         public void Dispose()
         {
             Dispose(true);
             GC.SuppressFinalize(this);
         }
 
+#if !NET451 && !NET472 && !NETSTANDARD2_0
+        // IAsyncDisposable is available in .NET 5.0 and above
+
+        /// <summary>
+        /// Disposes the client in an async way. See <see cref="IAsyncDisposable"/> for more information.
+        /// </summary>
+        /// <remarks>
+        /// Includes a call to <see cref="CloseAsync()"/>.
+        /// </remarks>
+        /// <example>
+        /// <code>
+        /// await using var client = DeviceClient.CreateFromConnectionString(...);
+        /// </code>
+        /// or
+        /// <code>
+        /// var client = DeviceClient.CreateFromConnectionStirng(...);
+        /// try
+        /// {
+        ///     // do work
+        /// }
+        /// finally
+        /// {
+        ///     await client.DisposeAsync();
+        /// }
+        /// </code>
+        /// </example>
+        [SuppressMessage("Usage", "CA1816:Dispose methods should call SuppressFinalize", Justification = "SuppressFinalize is called by Dispose(), which this method calls.")]
+        public async ValueTask DisposeAsync()
+        {
+            await CloseAsync().ConfigureAwait(false);
+            Dispose();
+        }
+
+#endif
+
         /// <summary>
         /// Releases the unmanaged resources used by the DeviceClient and allows for any derived class to override and
         /// provide custom implementation.

diff --git a/iothub/service/src/Common/Security/SharedAccessSignature.cs b/iothub/service/src/Common/Security/SharedAccessSignature.cs
@@ -7,7 +7,6 @@
 using System.Net;
 using System.Security.Cryptography;
 using System.Text;
-using Microsoft.Azure.Devices.Common.Data;
 
 namespace Microsoft.Azure.Devices.Common.Security
 {
@@ -73,7 +72,7 @@ private SharedAccessSignature(
         public string Signature { get; private set; }
 
         /// <summary>
-        /// Parses a shared access signature string representation into a <see cref="SharedAccessSignature"/>./>
+        /// Parses a shared access signature string representation into a <see cref="SharedAccessSignature"/>.
         /// </summary>
         /// <param name="iotHubName">The IoT Hub name.</param>
         /// <param name="rawToken">The string representation of the SAS token to parse.</param>