Class CephalonRateLimitingEndpointConventionBuilderExtensions
Namespace: Cephalon.AspNetCore.Hosting
Assembly: Cephalon.AspNetCore.dll
Applies Cephalon ASP.NET Core rate-limiting conventions to endpoint builders by consulting the host’s effective rate-limiting policy catalog.
public static class CephalonRateLimitingEndpointConventionBuilderExtensionsInheritance
Section titled “Inheritance”object ← CephalonRateLimitingEndpointConventionBuilderExtensions
Inherited Members
Section titled “Inherited Members”object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()
Methods
Section titled “Methods”ApplyCephalonRateLimiting<TBuilder>(TBuilder, IServiceProvider, string, string?)
Section titled “ ApplyCephalonRateLimiting<TBuilder>(TBuilder, IServiceProvider, string, string?)”Applies the effective Cephalon rate-limiting policy for the supplied transport and optional behavior identifier onto the endpoint builder.
public static TBuilder ApplyCephalonRateLimiting<TBuilder>(this TBuilder builder, IServiceProvider services, string transportId, string? behaviorId = null) where TBuilder : IEndpointConventionBuilderParameters
Section titled “Parameters”builder TBuilder
The endpoint builder to configure.
services IServiceProvider
The application service provider.
transportId string
The transport identifier used by the endpoint.
behaviorId string?
The optional behavior identifier when the endpoint maps a single behavior.
Returns
Section titled “Returns”TBuilder
The same builder instance for fluent composition.
Type Parameters
Section titled “Type Parameters”TBuilder
The endpoint convention builder type.
HasCephalonRateLimiting(IServiceProvider, string, string?)
Section titled “ HasCephalonRateLimiting(IServiceProvider, string, string?)”Determines whether the effective Cephalon rate-limiting policy for the supplied transport and optional behavior identifier actively enforces a limiter.
public static bool HasCephalonRateLimiting(this IServiceProvider services, string transportId, string? behaviorId = null)Parameters
Section titled “Parameters”services IServiceProvider
The application service provider.
transportId string
The transport identifier used by the endpoint.
behaviorId string?
The optional behavior identifier when the endpoint maps a single behavior.
Returns
Section titled “Returns”true when the endpoint will require a limiter; otherwise false.