Class ForwarderHttpClientFactory

Default implementation of IForwarderHttpClientFactory.

Inheritance
System.Object
ForwarderHttpClientFactory
Implements
Namespace: Yarp.ReverseProxy.Forwarder
Assembly: Yarp.ReverseProxy.dll
Syntax
public class ForwarderHttpClientFactory : object, IForwarderHttpClientFactory

Constructors

| Improve this Doc View Source

ForwarderHttpClientFactory()

Initializes a new instance of the ForwarderHttpClientFactory class.

Declaration
public ForwarderHttpClientFactory()
| Improve this Doc View Source

ForwarderHttpClientFactory(ILogger<ForwarderHttpClientFactory>)

Initializes a new instance of the ForwarderHttpClientFactory class.

Declaration
public ForwarderHttpClientFactory(ILogger<ForwarderHttpClientFactory> logger)
Parameters
Type Name Description
ILogger<ForwarderHttpClientFactory> logger

Methods

| Improve this Doc View Source

CanReuseOldClient(ForwarderHttpClientContext)

Checks if the options have changed since the old client was created. If not then the old client will be re-used. Re-use can avoid the latency of creating new connections.

Declaration
protected virtual bool CanReuseOldClient(ForwarderHttpClientContext context)
Parameters
Type Name Description
ForwarderHttpClientContext context
Returns
Type Description
System.Boolean
| Improve this Doc View Source

ConfigureHandler(ForwarderHttpClientContext, SocketsHttpHandler)

Allows configuring the instance. The base implementation applies settings from NewConfig. , , , and are disabled prior to this call.

Declaration
protected virtual void ConfigureHandler(ForwarderHttpClientContext context, SocketsHttpHandler handler)
Parameters
Type Name Description
ForwarderHttpClientContext context
SocketsHttpHandler handler
| Improve this Doc View Source

CreateClient(ForwarderHttpClientContext)

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

Declaration
public 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.

| Improve this Doc View Source

WrapHandler(ForwarderHttpClientContext, HttpMessageHandler)

Adds any wrapping middleware around the .

Declaration
protected virtual HttpMessageHandler WrapHandler(ForwarderHttpClientContext context, HttpMessageHandler handler)
Parameters
Type Name Description
ForwarderHttpClientContext context
HttpMessageHandler handler
Returns
Type Description
HttpMessageHandler

Implements