Interface IProxyStateLookup

Allows access to the proxy's current set of routes and clusters.

Namespace: Yarp.ReverseProxy
Assembly: Yarp.ReverseProxy.dll
Syntax
public interface IProxyStateLookup

Methods

| Improve this Doc View Source

GetClusters()

Enumerates all current clusters. This is thread safe but the collection may change mid-enumeration if the configuration is reloaded.

Declaration
IEnumerable<ClusterState> GetClusters()
Returns
Type Description
IEnumerable<ClusterState>
| Improve this Doc View Source

GetRoutes()

Enumerates all current routes. This is thread safe but the collection may change mid-enumeration if the configuration is reloaded.

Declaration
IEnumerable<RouteModel> GetRoutes()
Returns
Type Description
IEnumerable<RouteModel>
| Improve this Doc View Source

TryGetCluster(String, out ClusterState)

Retrieves a specific cluster by id, if present.

Declaration
bool TryGetCluster(string id, out ClusterState cluster)
Parameters
Type Name Description
System.String id
ClusterState cluster
Returns
Type Description
System.Boolean
| Improve this Doc View Source

TryGetRoute(String, out RouteModel)

Retrieves a specific route by id, if present.

Declaration
bool TryGetRoute(string id, out RouteModel route)
Parameters
Type Name Description
System.String id
RouteModel route
Returns
Type Description
System.Boolean