From deba4ce8ec431b5dd5a0bbced2c3fa8994ae4d45 Mon Sep 17 00:00:00 2001 From: Martin Tomka Date: Thu, 17 Aug 2023 11:26:40 +0200 Subject: [PATCH] docs --- src/Polly.Core/Registry/ResiliencePipelineProvider.cs | 4 ++++ src/Polly.Core/Registry/ResiliencePipelineRegistry.cs | 6 ++++++ 2 files changed, 10 insertions(+) diff --git a/src/Polly.Core/Registry/ResiliencePipelineProvider.cs b/src/Polly.Core/Registry/ResiliencePipelineProvider.cs index e6bdfb3679c..1cd26d653c7 100644 --- a/src/Polly.Core/Registry/ResiliencePipelineProvider.cs +++ b/src/Polly.Core/Registry/ResiliencePipelineProvider.cs @@ -17,6 +17,7 @@ public abstract class ResiliencePipelineProvider /// The key used to identify the resilience pipeline. /// The resilience pipeline associated with the specified key. /// Thrown when no resilience pipeline is found for the specified key. + /// Thrown when the provider is already disposed. public virtual ResiliencePipeline GetPipeline(TKey key) { if (TryGetPipeline(key, out var pipeline)) @@ -35,6 +36,7 @@ public virtual ResiliencePipeline GetPipeline(TKey key) /// The key used to identify the resilience pipeline. /// The resilience pipeline associated with the specified key. /// Thrown when no resilience pipeline is found for the specified key. + /// Thrown when the provider is already disposed. public virtual ResiliencePipeline GetPipeline(TKey key) { if (TryGetPipeline(key, out var pipeline)) @@ -52,6 +54,7 @@ public virtual ResiliencePipeline GetPipeline(TKey key) /// The key used to identify the resilience pipeline. /// The output resilience pipeline if found, otherwise. /// if the pipeline was found, otherwise. + /// Thrown when the provider is already disposed. public abstract bool TryGetPipeline(TKey key, [NotNullWhen(true)] out ResiliencePipeline? pipeline); /// @@ -61,5 +64,6 @@ public virtual ResiliencePipeline GetPipeline(TKey key) /// The key used to identify the resilience pipeline. /// The output resilience pipeline if found, otherwise. /// if the pipeline was found, otherwise. + /// Thrown when the provider is already disposed. public abstract bool TryGetPipeline(TKey key, [NotNullWhen(true)] out ResiliencePipeline? pipeline); } diff --git a/src/Polly.Core/Registry/ResiliencePipelineRegistry.cs b/src/Polly.Core/Registry/ResiliencePipelineRegistry.cs index 40931608a57..82d51617713 100644 --- a/src/Polly.Core/Registry/ResiliencePipelineRegistry.cs +++ b/src/Polly.Core/Registry/ResiliencePipelineRegistry.cs @@ -95,6 +95,7 @@ public override bool TryGetPipeline(TKey key, [NotNullWhen(true)] out Resilience /// The key used to identify the resilience pipeline. /// The callback that configures the pipeline builder. /// An instance of pipeline. + /// Thrown when the registry is already disposed. public ResiliencePipeline GetOrAddPipeline(TKey key, Action configure) { Guard.NotNull(configure); @@ -110,6 +111,7 @@ public ResiliencePipeline GetOrAddPipeline(TKey key, ActionThe key used to identify the resilience pipeline. /// The callback that configures the pipeline builder. /// An instance of pipeline. + /// Thrown when the registry is already disposed. public ResiliencePipeline GetOrAddPipeline(TKey key, Action> configure) { Guard.NotNull(configure); @@ -141,6 +143,7 @@ public ResiliencePipeline GetOrAddPipeline(TKey key, ActionThe key used to identify the resilience pipeline. /// The callback that configures the pipeline builder. /// An instance of pipeline. + /// Thrown when the registry is already disposed. public ResiliencePipeline GetOrAddPipeline(TKey key, Action> configure) { Guard.NotNull(configure); @@ -157,6 +160,7 @@ public ResiliencePipeline GetOrAddPipeline(TKey key, ActionThe key used to identify the resilience pipeline. /// The callback that configures the pipeline builder. /// An instance of pipeline. + /// Thrown when the registry is already disposed. public ResiliencePipeline GetOrAddPipeline(TKey key, Action, ConfigureBuilderContext> configure) { Guard.NotNull(configure); @@ -176,6 +180,7 @@ public ResiliencePipeline GetOrAddPipeline(TKey key, Action /// Thrown when is . + /// Thrown when the registry is already disposed. public bool TryAddBuilder(TKey key, Action> configure) { Guard.NotNull(configure); @@ -196,6 +201,7 @@ public bool TryAddBuilder(TKey key, Action /// Thrown when is . + /// Thrown when the registry is already disposed. public bool TryAddBuilder(TKey key, Action, ConfigureBuilderContext> configure) { Guard.NotNull(configure);