src/ReverseProxy/Forwarder/IHttpForwarderExtensions.cs - main - aprogrammer/reverse-proxy-ms-yarp

src/ReverseProxy/Forwarder/IHttpForwarderExtensions.cs
85 строк4 KB
Kahbazi
File Scoped Namespaces (#1352)
12 ноя 2021, 21:53
12 ноя 2021, 21:5344f13d9
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

using System;
using System.Net.Http;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Http;

namespace Yarp.ReverseProxy.Forwarder;

/// <summary>
/// Extensions methods for <see cref="IHttpForwarder"/>.
/// </summary>
public static class IHttpForwarderExtensions
{
    /// <summary>
    /// Forwards the incoming request to the destination server, and the response back to the client.
    /// </summary>
    /// <param name="forwarder">The forwarder instance.</param>
    /// <param name="context">The HttpContext to forward.</param>
    /// <param name="destinationPrefix">The url prefix for where to forward the request to.</param>
    /// <param name="httpClient">The HTTP client used to forward the request.</param>
    /// <returns>The status of a forwarding operation.</returns>
    public static ValueTask<ForwarderError> SendAsync(this IHttpForwarder forwarder, HttpContext context, string destinationPrefix,
        HttpMessageInvoker httpClient)
    {
        if (forwarder is null)
        {
            throw new ArgumentNullException(nameof(forwarder));
        }

        return forwarder.SendAsync(context, destinationPrefix, httpClient, ForwarderRequestConfig.Empty, HttpTransformer.Default);
    }

    /// <summary>
    /// Forwards the incoming request to the destination server, and the response back to the client.
    /// </summary>
    /// <param name="forwarder">The forwarder instance.</param>
    /// <param name="context">The HttpContext to forward.</param>
    /// <param name="destinationPrefix">The url prefix for where to forward the request to.</param>
    /// <param name="httpClient">The HTTP client used to forward the request.</param>
    /// <param name="requestConfig">Config for the outgoing request.</param>
    /// <returns>The status of a forwarding operation.</returns>
    public static ValueTask<ForwarderError> SendAsync(this IHttpForwarder forwarder, HttpContext context, string destinationPrefix,
        HttpMessageInvoker httpClient, ForwarderRequestConfig requestConfig)
    {
        if (forwarder is null)
        {
            throw new ArgumentNullException(nameof(forwarder));
        }

        return forwarder.SendAsync(context, destinationPrefix, httpClient, requestConfig, HttpTransformer.Default);
    }

    /// <summary>
    /// Forwards the incoming request to the destination server, and the response back to the client.
    /// </summary>
    /// <param name="forwarder">The forwarder instance.</param>
    /// <param name="context">The HttpContext to forward.</param>
    /// <param name="destinationPrefix">The url prefix for where to forward the request to.</param>
    /// <param name="httpClient">The HTTP client used to forward the request.</param>
    /// <param name="requestTransform">Transform function to apply to the forwarded request.</param>
    /// <returns>The status of a forwarding operation.</returns>
    public static ValueTask<ForwarderError> SendAsync(this IHttpForwarder forwarder, HttpContext context, string destinationPrefix,
        HttpMessageInvoker httpClient, Func<HttpContext, HttpRequestMessage, ValueTask> requestTransform)
    {
        return forwarder.SendAsync(context, destinationPrefix, httpClient, ForwarderRequestConfig.Empty, requestTransform);
    }

    /// <summary>
    /// Forwards the incoming request to the destination server, and the response back to the client.
    /// </summary>
    /// <param name="forwarder">The forwarder instance.</param>
    /// <param name="context">The HttpContext to forward.</param>
    /// <param name="destinationPrefix">The url prefix for where to forward the request to.</param>
    /// <param name="httpClient">The HTTP client used to forward the request.</param>
    /// <param name="requestConfig">Config for the outgoing request.</param>
    /// <param name="requestTransform">Transform function to apply to the forwarded request.</param>
    /// <returns>The status of a forwarding operation.</returns>
    public static ValueTask<ForwarderError> SendAsync(this IHttpForwarder forwarder, HttpContext context, string destinationPrefix,
        HttpMessageInvoker httpClient, ForwarderRequestConfig requestConfig, Func<HttpContext, HttpRequestMessage, ValueTask> requestTransform)
    {
        return forwarder.SendAsync(context, destinationPrefix, httpClient, requestConfig, new RequestTransformer(requestTransform));
    }
}