Share via

IHttpContextAccessor Interface

  • Reference

Definition

Namespace:
Microsoft.AspNetCore.Http
Assembly:
Microsoft.AspNetCore.Http.Abstractions.dll
Package:
Microsoft.AspNetCore.Http.Abstractions v1.0.0
Package:
Microsoft.AspNetCore.Http.Abstractions v1.1.0
Package:
Microsoft.AspNetCore.Http.Abstractions v2.0.0
Package:
Microsoft.AspNetCore.Http.Abstractions v2.1.0
Package:
Microsoft.AspNetCore.Http.Abstractions v2.2.0
Package:
Microsoft.AspNetCore.App.Ref v3.0.1
Package:
Microsoft.AspNetCore.App.Ref v3.1.10
Package:
Microsoft.AspNetCore.App.Ref v5.0.0
Package:
Microsoft.AspNetCore.App.Ref v6.0.6
Package:
Microsoft.AspNetCore.App.Ref v7.0.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.0
Package:
Microsoft.AspNetCore.App.Ref v9.0.0-rc.2.24474.3
Source:
IHttpContextAccessor.cs

Provides access to the current HttpContext, if one is available.

public interface class IHttpContextAccessor
public interface IHttpContextAccessor
type IHttpContextAccessor = interface
Public Interface IHttpContextAccessor
Derived

Remarks

This interface should be used with caution. It relies on AsyncLocal<T> which can have a negative performance impact on async calls. It also creates a dependency on "ambient state" which can make testing more difficult.

Properties

HttpContext

Gets or sets the current HttpContext. Returns null if there is no active HttpContext.

Applies to