Removing breaking changes made between 2.5.6 and 2.5.8 (#214)

Azure · Jan 7, 2022 · a30adac · a30adac
1 parent a720fcf
commit a30adac
Showing 1 changed file with 21 additions and 1 deletion.
diff --git a/Microsoft.Azure.Amqp/Singleton.cs b/Microsoft.Azure.Amqp/Singleton.cs
@@ -4,6 +4,7 @@
 namespace Microsoft.Azure.Amqp
 {
     using System;
+    using System.ComponentModel;
     using System.Globalization;
     using System.Threading;
     using System.Threading.Tasks;
@@ -45,6 +46,15 @@ public Task OpenAsync()
             return this.OpenAsync(CancellationToken.None);
         }
 
+        // Deprecated, but needs to stay available to avoid
+        // breaking changes. The attribute removes it from
+        // any code completion listings and doc generation.
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        public Task OpenAsync(TimeSpan timeout)
+        {
+            return this.GetOrCreateAsync(timeout);
+        }
+
         public Task OpenAsync(CancellationToken cancellationToken)
         {
             return this.GetOrCreateAsync(cancellationToken);
@@ -123,6 +133,12 @@ protected virtual bool IsValid(TValue value)
             return true;
         }
 
+        // Deprecated, but needs to stay available to avoid
+        // breaking changes. The attribute removes it from
+        // any code completion listings and doc generation.
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        protected virtual Task<TValue> OnCreateAsync(TimeSpan timeout) => OnCreateAsync(timeout, CancellationToken.None);
+
         protected abstract Task<TValue> OnCreateAsync(TimeSpan timeout, CancellationToken cancellationToken);
 
         protected abstract void OnSafeClose(TValue value);
@@ -143,7 +159,11 @@ internal bool TryGet(out TValue value, Func<TValue, bool> condition)
             return false;
         }
 
-        internal async Task<TValue> GetOrCreateAsync(TimeSpan timeout, CancellationToken cancellationToken)
+        // Deprecated, but needs to stay available to avoid
+        // breaking changes. The attribute removes it from
+        // any code completion listings and doc generation.
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        public async Task<TValue> GetOrCreateAsync(TimeSpan timeout, CancellationToken cancellationToken)
         {
             var timeoutHelper = new TimeoutHelper(timeout);