Class ForwarderRequestConfig

Config for SendAsync(HttpContext, String, HttpMessageInvoker, ForwarderRequestConfig, HttpTransformer, CancellationToken)

Inheritance

System.Object

ForwarderRequestConfig

Implements

System.IEquatable<ForwarderRequestConfig>

Namespace: Yarp.ReverseProxy.Forwarder

Assembly: Yarp.ReverseProxy.dll

Syntax

public sealed class ForwarderRequestConfig : object

Properties

| Improve this Doc View Source

ActivityTimeout

How long a request is allowed to remain idle between any operation completing, after which it will be canceled. The default is 100 seconds. The timeout will reset when response headers are received or after successfully reading or writing any request, response, or streaming data like gRPC or WebSockets. TCP keep-alive packets and HTTP/2 protocol pings will not reset the timeout, but WebSocket pings will.

Declaration

public TimeSpan? ActivityTimeout { get; set; }

Property Value

Type	Description
System.Nullable<TimeSpan>

| Improve this Doc View Source

AllowResponseBuffering

Allows to use write buffering when sending a response back to the client, if the server hosting YARP (e.g. IIS) supports it. NOTE: enabling it can break SSE (server side event) scenarios.

Declaration

public bool? AllowResponseBuffering { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

| Improve this Doc View Source

Empty

An empty instance of this type.

Declaration

public static ForwarderRequestConfig Empty { get; }

Property Value

Type	Description
ForwarderRequestConfig

| Improve this Doc View Source

Version

Preferred version of the outgoing request. The default is HTTP/2.0.

Declaration

public Version? Version { get; set; }

Property Value

Type	Description
System.Nullable<Version>

| Improve this Doc View Source

VersionPolicy

The policy applied to version selection, e.g. whether to prefer downgrades, upgrades or request an exact version. The default is RequestVersionOrLower.

Declaration

public HttpVersionPolicy? VersionPolicy { get; set; }

Property Value

Type	Description
System.Nullable<HttpVersionPolicy>

Methods

| Improve this Doc View Source

Equals(ForwarderRequestConfig)

Declaration

public bool Equals(ForwarderRequestConfig other)

Parameters

Type	Name	Description
ForwarderRequestConfig	other

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Implements

System.IEquatable<>