HostingEnvironmentMiddleware Class

Definition

Namespace

Cuemon.AspNetCore.Hosting

Assemblies

Cuemon.AspNetCore.dll

Source

src/Cuemon.AspNetCore/Hosting/HostingEnvironmentMiddleware.cs

Provides a hosting environment middleware implementation for ASP.NET Core.

public class HostingEnvironmentMiddleware : ConfigurableMiddleware<IHostEnvironment, HostingEnvironmentOptions>, IConfigurable<HostingEnvironmentOptions>

Inheritance

object

MiddlewareCore

ConfigurableMiddlewareCore<HostingEnvironmentOptions>

ConfigurableMiddleware<IHostEnvironment, HostingEnvironmentOptions>

HostingEnvironmentMiddleware

Implements

IConfigurable<HostingEnvironmentOptions>

Inherited Members

ConfigurableMiddleware<IHostEnvironment, HostingEnvironmentOptions>.InvokeAsync(HttpContext, IHostEnvironment)

ConfigurableMiddlewareCore<HostingEnvironmentOptions>.Options

MiddlewareCore.Next

Examples

The following example demonstrates how to register and use HostingEnvironmentMiddleware in the ASP.NET Core pipeline.

using System;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.FileProviders;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Options;

        namespace Cuemon.AspNetCore.Hosting;

        public static class HostingEnvironmentMiddlewareExample
        {
            public static async Task DemonstrateAsync()
            {
                var context = new DefaultHttpContext();
        var middleware = new HostingEnvironmentMiddleware(
            httpContext => httpContext.Response.WriteAsync("Hello"),
            Options.Create(new HostingEnvironmentOptions
            {
                HeaderName = "X-Environment",
                SuppressHeaderPredicate = _ => false
            }));

        await middleware.InvokeAsync(context, new SampleHostEnvironment());
        Console.WriteLine(context.Response.Headers["X-Environment"].ToString());
            }
    private sealed class SampleHostEnvironment : IHostEnvironment
    {
        public string ApplicationName { get; set; } = "Docs";
        public IFileProvider ContentRootFileProvider { get; set; } = new NullFileProvider();
        public string ContentRootPath { get; set; } = ".";
        public string EnvironmentName { get; set; } = Environments.Staging;
    }
        }

Constructors

Name	Description
HostingEnvironmentMiddleware(RequestDelegate, IOptions<HostingEnvironmentOptions>)	Initializes a new instance of the HostingEnvironmentMiddleware class.
HostingEnvironmentMiddleware(RequestDelegate, Action<HostingEnvironmentOptions>)	Initializes a new instance of the HostingEnvironmentMiddleware class.

Methods

Name	Description
InvokeAsync(HttpContext, IHostEnvironment)	Executes the HostingEnvironmentMiddleware.