Docs

App-vNext · Aug 17, 2023 · bdbcb02 · bdbcb02
1 parent 9f158f8
commit bdbcb02
Show file tree

Hide file tree

Showing 2 changed files with 320 additions and 298 deletions.
diff --git a/src/Polly.Core/Registry/ResiliencePipelineProvider.cs b/src/Polly.Core/Registry/ResiliencePipelineProvider.cs
@@ -17,6 +17,7 @@ public abstract class ResiliencePipelineProvider<TKey>
     /// <param name="key">The key used to identify the resilience pipeline.</param>
     /// <returns>The resilience pipeline associated with the specified key.</returns>
     /// <exception cref="KeyNotFoundException">Thrown when no resilience pipeline is found for the specified key.</exception>
+    /// <exception cref="ObjectDisposedException">Thrown when the provider is already disposed.</exception>
     public virtual ResiliencePipeline GetPipeline(TKey key)
     {
         if (TryGetPipeline(key, out var pipeline))
@@ -35,6 +36,7 @@ public virtual ResiliencePipeline GetPipeline(TKey key)
     /// <param name="key">The key used to identify the resilience pipeline.</param>
     /// <returns>The resilience pipeline associated with the specified key.</returns>
     /// <exception cref="KeyNotFoundException">Thrown when no resilience pipeline is found for the specified key.</exception>
+    /// <exception cref="ObjectDisposedException">Thrown when the provider is already disposed.</exception>
     public virtual ResiliencePipeline<TResult> GetPipeline<TResult>(TKey key)
     {
         if (TryGetPipeline<TResult>(key, out var pipeline))
@@ -52,6 +54,7 @@ public virtual ResiliencePipeline<TResult> GetPipeline<TResult>(TKey key)
     /// <param name="key">The key used to identify the resilience pipeline.</param>
     /// <param name="pipeline">The output resilience pipeline if found, <see langword="null"/> otherwise.</param>
     /// <returns><see langword="true"/> if the pipeline was found, <see langword="false"/> otherwise.</returns>
+    /// <exception cref="ObjectDisposedException">Thrown when the provider is already disposed.</exception>
     public abstract bool TryGetPipeline(TKey key, [NotNullWhen(true)] out ResiliencePipeline? pipeline);
 
     /// <summary>
@@ -61,5 +64,6 @@ public virtual ResiliencePipeline<TResult> GetPipeline<TResult>(TKey key)
     /// <param name="key">The key used to identify the resilience pipeline.</param>
     /// <param name="pipeline">The output resilience pipeline if found, <see langword="null"/> otherwise.</param>
     /// <returns><see langword="true"/> if the pipeline was found, <see langword="false"/> otherwise.</returns>
+    /// <exception cref="ObjectDisposedException">Thrown when the provider is already disposed.</exception>
     public abstract bool TryGetPipeline<TResult>(TKey key, [NotNullWhen(true)] out ResiliencePipeline<TResult>? pipeline);
 }