CryptoExchange.Net/CryptoExchange.Net/Interfaces/IRateLimiter.cs

using CryptoExchange.Net.Objects;
using Microsoft.Extensions.Logging;
using System.Net.Http;
using System.Security;
using System.Threading;
using System.Threading.Tasks;

namespace CryptoExchange.Net.Interfaces
{
    /// <summary>
    /// Rate limiter interface
    /// </summary>
    public interface IRateLimiter
    {
        /// <summary>
        /// Limit a request based on previous requests made
        /// </summary>
        /// <param name="log">The logger</param>
        /// <param name="endpoint">The endpoint the request is for</param>
        /// <param name="method">The Http request method</param>
        /// <param name="signed">Whether the request is singed(private) or not</param>
        /// <param name="apiKey">The api key making this request</param>
        /// <param name="limitBehaviour">The limit behavior for when the limit is reached</param>
        /// <param name="requestWeight">The weight of the request</param>
        /// <param name="ct">Cancellation token to cancel waiting</param>
        /// <returns>The time in milliseconds spend waiting</returns>
        Task<CallResult<int>> LimitRequestAsync(ILogger log, string endpoint, HttpMethod method, bool signed, SecureString? apiKey, RateLimitingBehaviour limitBehaviour, int requestWeight, CancellationToken ct);
    }
}