Language

PartitionedRateLimiter.CreateChained Method

Definition

Namespace:
System.Threading.RateLimiting
Assembly:
System.Threading.RateLimiting.dll
Package:
System.Threading.RateLimiting v11.0.0-rc.1.26425.128
Source:
PartitionedRateLimiter.cs

Creates a single PartitionedRateLimiter that wraps the passed in PartitionedRateLimiters.

public:
generic 
 static System::Threading::RateLimiting::PartitionedRateLimiter ^ CreateChained(... cli::array  ^> ^ limiters);
public static System.Threading.RateLimiting.PartitionedRateLimiter CreateChained(params System.Threading.RateLimiting.PartitionedRateLimiter[] limiters);
static member CreateChained : System.Threading.RateLimiting.PartitionedRateLimiter<'Resource>[] -> System.Threading.RateLimiting.PartitionedRateLimiter<'Resource>
Public Shared Function CreateChained(Of TResource) (ParamArray limiters As PartitionedRateLimiter(Of TResource)()) As PartitionedRateLimiter(Of TResource)

Type Parameters

TResource

The resource type that is being rate limited.

Parameters

limiters
PartitionedRateLimiter[]

The PartitionedRateLimiters that will be called in order when acquiring resources.

Returns

PartitionedRateLimiter

Exceptions

ArgumentNullException

limiters is a null parameter.

ArgumentException

limiters is an empty array.

Remarks

Methods on the returned PartitionedRateLimiter will iterate over the passed in limiters in the order given.

GetStatistics(TResource) will return the lowest value for CurrentAvailablePermits, the inner-most limiter's TotalSuccessfulLeases, and the aggregate values for the rest of the properties from the limiters.

RateLimitLeases returned will aggregate metadata and for duplicates use the value of the first lease with the same metadata name.

Disposing the returned PartitionedRateLimiter does not dispose the inner limiters. Callers are expected to dispose the inner limiters themselves once they are no longer in use.

Applies to