Class ConfigurableMiddleware<T, TOptions>

Provides an base-class for configurable middleware implementation in ASP.NET Core that supports the options pattern with a dependency injected parameter.

Inheritance

System.Object

MiddlewareCore

ConfigurableMiddlewareCore<TOptions>

ConfigurableMiddleware<T, TOptions>

HostingEnvironmentMiddleware

ThrottlingSentinelMiddleware

Implements

IConfigurable<TOptions>

Inherited Members

ConfigurableMiddlewareCore<TOptions>.Options

MiddlewareCore.Next

Namespace: Cuemon.AspNetCore

Assembly: Cuemon.AspNetCore.dll

Syntax

public abstract class ConfigurableMiddleware<T, TOptions> : ConfigurableMiddlewareCore<TOptions>, IConfigurable<TOptions> where TOptions : class, new()

Type Parameters

Name	Description
T	The type of the dependency injected parameter of InvokeAsync(HttpContext, T).
TOptions	The type of the options to setup.

Constructors

ConfigurableMiddleware(RequestDelegate, IOptions<TOptions>)

Initializes a new instance of the ConfigurableMiddleware<TOptions> class.

Declaration

protected ConfigurableMiddleware(RequestDelegate next, IOptions<TOptions> setup)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Http.RequestDelegate	next	The delegate of the request pipeline to invoke.
Microsoft.Extensions.Options.IOptions<TOptions>	setup	The Microsoft.Extensions.Options.IOptions<TOptions> which need to be configured.

ConfigurableMiddleware(RequestDelegate, Action<TOptions>)

Initializes a new instance of the ConfigurableMiddleware<TOptions> class.

Declaration

protected ConfigurableMiddleware(RequestDelegate next, Action<TOptions> setup)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Http.RequestDelegate	next	The delegate of the request pipeline to invoke.
System.Action<TOptions>	setup	The System.Action<T> which need to be configured.

Methods

InvokeAsync(HttpContext, T)

Executes the ConfigurableMiddleware<T, TOptions>.

Declaration

public abstract Task InvokeAsync(HttpContext context, T di)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Http.HttpContext	context	The context of the current request.
T	di	The dependency injected parameter of InvokeAsync(HttpContext, T).

Returns

Type	Description
System.Threading.Tasks.Task	A task that represents the execution of this middleware.

Implements

IConfigurable<TOptions>

Extension Methods

CacheableObjectResultExtensions.ToCacheableObjectResult<T>(T, DateTime, Action<TimeBasedOptions>)

CacheableObjectResultExtensions.ToCacheableObjectResult<T>(T, Func<T, DateTime>, Action<TimeBasedOptions>)

CacheableObjectResultExtensions.ToCacheableObjectResult<T>(T, Byte[], Action<ContentBasedOptions>)

CacheableObjectResultExtensions.ToCacheableObjectResult<T>(T, Func<T, Byte[]>, Action<ContentBasedOptions>)

CacheableObjectResultExtensions.ToCacheableObjectResult<T>(T, DateTime, Byte[], Action<ContentTimeBasedOptions>)

CacheableObjectResultExtensions.ToCacheableObjectResult<T>(T, Func<T, DateTime>, Func<T, Byte[]>, Action<ContentTimeBasedOptions>)

CacheableObjectResultExtensions.ToCacheableObjectResult<T>(T, DateTime, Func<T, Byte[]>, Action<ContentTimeBasedOptions>)

CacheableObjectResultExtensions.ToCacheableObjectResult<T>(T, Func<T, DateTime>, Byte[], Action<ContentTimeBasedOptions>)

See Also

Middleware<T>