Class DestinationState

Representation of a cluster's destination for use at runtime.

Inheritance

System.Object

DestinationState

Namespace: Yarp.ReverseProxy.Model

Assembly: Yarp.ReverseProxy.dll

Syntax

public sealed class DestinationState : IReadOnlyList<DestinationState>

Constructors

DestinationState(String)

Creates a new instance. This constructor is for tests and infrastructure, this type is normally constructed by the configuration loading infrastructure.

Declaration

public DestinationState(string destinationId)

Parameters

Type	Name	Description
System.String	destinationId

DestinationState(String, DestinationModel)

Constructor overload to additionally initialize the DestinationModel for tests and infrastructure, such as updating the ReverseProxyFeature via HttpContextFeaturesExtensions

Declaration

public DestinationState(string destinationId, DestinationModel model)

Parameters

Type	Name	Description
System.String	destinationId
DestinationModel	model

Properties

ConcurrentRequestCount

Keeps track of the total number of concurrent requests on this endpoint. The setter should only be used for testing purposes.

Declaration

public int ConcurrentRequestCount { get; set; }

Property Value

Type	Description
System.Int32

DestinationId

The destination's unique id.

Declaration

public string DestinationId { get; }

Property Value

Type	Description
System.String

Health

Mutable health state for this destination.

Declaration

public DestinationHealthState Health { get; }

Property Value

Type	Description
DestinationHealthState

Model

A snapshot of the current configuration

Declaration

public DestinationModel Model { get; }

Property Value

Type	Description
DestinationModel