Interface IForwarderHttpClientFactory

Provides a method to create instances of for forwarding requests to an upstream server.

Namespace: Yarp.ReverseProxy.Forwarder

Assembly: Yarp.ReverseProxy.dll

Syntax

public interface IForwarderHttpClientFactory

Remarks

This is somewhat similarly to System.Net.Http.IHttpClientFactory, except that this factory class is meant for direct use, which the forwarder requires in order to keep separate pools for each cluster.

Methods

| Improve this Doc View Source

CreateClient(ForwarderHttpClientContext)

Creates and configures an instance that can be used for forwarding requests to an upstream server.

Declaration

HttpMessageInvoker CreateClient(ForwarderHttpClientContext context)

Parameters

Type	Name	Description
ForwarderHttpClientContext	context	An ForwarderHttpClientContext carrying old and new cluster configurations.

Returns

Type	Description
HttpMessageInvoker

Remarks

A call to CreateClient(ForwarderHttpClientContext) can return either a new instance or an old one if the configuration has not changed. If the old configuration is null, a new is always created. The returned instance MUST NOT be disposed because it can be used concurrently by several in-flight requests.