Class ForwarderRequestConfig

Namespace

Yarp.ReverseProxy.Forwarder

Assembly

Yarp.ReverseProxy.dll

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

public sealed record ForwarderRequestConfig : IEquatable<ForwarderRequestConfig>

Inheritance

object

ForwarderRequestConfig

Implements

IEquatable<ForwarderRequestConfig>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

ForwarderRequestConfig()

public ForwarderRequestConfig()

Properties

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-alives and HTTP/2 protocol pings will not reset the timeout, but WebSocket pings will.

public TimeSpan? ActivityTimeout { get; init; }

Property Value

TimeSpan?

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.

public bool? AllowResponseBuffering { get; init; }

Property Value

bool?

Empty

An empty instance of this type.

public static ForwarderRequestConfig Empty { get; }

Property Value

ForwarderRequestConfig

Version

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

public Version? Version { get; init; }

Property Value

Version

VersionPolicy

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

public HttpVersionPolicy? VersionPolicy { get; init; }

Property Value

HttpVersionPolicy?

Methods

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

Equals(ForwarderRequestConfig?)

public bool Equals(ForwarderRequestConfig? other)

Parameters

other ForwarderRequestConfig

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string

<Clone>$()

public ForwarderRequestConfig <Clone>$()

Returns

ForwarderRequestConfig

Operators

operator ==(ForwarderRequestConfig?, ForwarderRequestConfig?)

public static bool operator ==(ForwarderRequestConfig? left, ForwarderRequestConfig? right)

Parameters

left ForwarderRequestConfig

right ForwarderRequestConfig

Returns

bool

operator !=(ForwarderRequestConfig?, ForwarderRequestConfig?)

public static bool operator !=(ForwarderRequestConfig? left, ForwarderRequestConfig? right)

Parameters

left ForwarderRequestConfig

right ForwarderRequestConfig

Returns

bool