Class PollyTransportCircuitBreakerRegistry
- Namespace
- Excalibur.Dispatch.Resilience.Polly
- Assembly
- Excalibur.Dispatch.Resilience.Polly.dll
Polly-based implementation of ITransportCircuitBreakerRegistry that manages per-transport circuit breakers using Polly's resilience pipeline.
public sealed class PollyTransportCircuitBreakerRegistry : ITransportCircuitBreakerRegistry, ITransportCircuitBreakerDiagnostics, IDisposable
- Inheritance
-
PollyTransportCircuitBreakerRegistry
- Implements
- Inherited Members
- Extension Methods
Remarks
This registry creates and manages PollyCircuitBreakerPolicyAdapter instances for each transport, ensuring transport-level isolation of failures. When one transport experiences issues, other transports continue operating normally.
The registry is thread-safe and lazily creates circuit breakers on first access.
Constructors
PollyTransportCircuitBreakerRegistry()
Initializes a new instance of the PollyTransportCircuitBreakerRegistry class with default options.
public PollyTransportCircuitBreakerRegistry()
PollyTransportCircuitBreakerRegistry(CircuitBreakerOptions, ILogger<PollyTransportCircuitBreakerRegistry>?)
Initializes a new instance of the PollyTransportCircuitBreakerRegistry class.
public PollyTransportCircuitBreakerRegistry(CircuitBreakerOptions defaultOptions, ILogger<PollyTransportCircuitBreakerRegistry>? logger)
Parameters
defaultOptionsCircuitBreakerOptionsThe default circuit breaker options for new registrations.
loggerILogger<PollyTransportCircuitBreakerRegistry>Optional logger instance.
PollyTransportCircuitBreakerRegistry(IOptions<CircuitBreakerOptions>, ILogger<PollyTransportCircuitBreakerRegistry>?)
Initializes a new instance of the PollyTransportCircuitBreakerRegistry class using options from dependency injection.
public PollyTransportCircuitBreakerRegistry(IOptions<CircuitBreakerOptions> options, ILogger<PollyTransportCircuitBreakerRegistry>? logger = null)
Parameters
optionsIOptions<CircuitBreakerOptions>The circuit breaker options accessor.
loggerILogger<PollyTransportCircuitBreakerRegistry>Optional logger instance.
Properties
Count
Gets the number of registered circuit breakers.
public int Count { get; }
Property Value
Methods
Dispose()
Disposes all managed circuit breakers and clears the registry.
public void Dispose()
GetAllStates()
Gets the current states of all registered circuit breakers.
public IReadOnlyDictionary<string, CircuitState> GetAllStates()
Returns
- IReadOnlyDictionary<string, CircuitState>
A dictionary mapping transport names to their circuit states.
GetOrCreate(string)
Gets or creates a circuit breaker for the specified transport using default options.
public ICircuitBreakerPolicy GetOrCreate(string transportName)
Parameters
transportNamestringThe name of the transport (e.g., "RabbitMQ", "AzureServiceBus").
Returns
- ICircuitBreakerPolicy
The circuit breaker policy for the transport.
Exceptions
- ArgumentNullException
transportNameis null.- ArgumentException
transportNameis empty or consists only of white-space characters.
GetOrCreate(string, CircuitBreakerOptions)
Gets or creates a circuit breaker for the specified transport with custom options.
public ICircuitBreakerPolicy GetOrCreate(string transportName, CircuitBreakerOptions options)
Parameters
transportNamestringThe name of the transport.
optionsCircuitBreakerOptionsThe circuit breaker configuration options.
Returns
- ICircuitBreakerPolicy
The circuit breaker policy for the transport.
Exceptions
- ArgumentNullException
transportNameoroptionsis null.- ArgumentException
transportNameis empty or consists only of white-space characters.
GetTransportNames()
Gets the names of all registered transports.
public IEnumerable<string> GetTransportNames()
Returns
- IEnumerable<string>
A collection of transport names.
Remove(string)
Removes a circuit breaker for the specified transport.
public bool Remove(string transportName)
Parameters
transportNamestringThe name of the transport.
Returns
- bool
True if the circuit breaker was removed; otherwise, false.
Exceptions
- ArgumentNullException
transportNameis null.- ArgumentException
transportNameis empty or consists only of white-space characters.
ResetAllAsync(CancellationToken)
Returns every registered circuit breaker to the closed state.
public Task ResetAllAsync(CancellationToken cancellationToken)
Parameters
cancellationTokenCancellationTokenCancellation token.
Returns
- Task
A task that completes once every circuit is closed.
Remarks
When the returned task completes, every circuit this registry holds reports Closed. The individual resets are awaited rather than started, so a caller that needs the whole registry back in service can wait for exactly that.
TryGet(string)
Tries to get an existing circuit breaker for the specified transport.
public ICircuitBreakerPolicy? TryGet(string transportName)
Parameters
transportNamestringThe name of the transport.
Returns
- ICircuitBreakerPolicy
The circuit breaker policy if found; otherwise, null.
Exceptions
- ArgumentNullException
transportNameis null.- ArgumentException
transportNameis empty or consists only of white-space characters.