CryptoExchange.Net/CryptoExchange.Net/RateLimiting/Guards/RetryAfterGuard.cs

using CryptoExchange.Net.Objects;
using CryptoExchange.Net.RateLimiting.Interfaces;
using System;

namespace CryptoExchange.Net.RateLimiting.Guards
{
    /// <summary>
    /// Retry after guard
    /// </summary>
    public class RetryAfterGuard : IRateLimitGuard
    {
        /// <summary>
        /// Additional wait time to apply to account for time offset between server and client
        /// </summary>
        private static readonly TimeSpan _windowBuffer = TimeSpan.FromMilliseconds(1000);

        /// <inheritdoc />
        public string Name => "RetryAfterGuard";

        /// <inheritdoc />
        public string Description => $"Pause {Type} until after {After}";

        /// <summary>
        /// The timestamp after which requests are allowed again
        /// </summary>
        public DateTime After { get; private set; }

        /// <summary>
        /// The type of rate limit item this guard is for
        /// </summary>
        public RateLimitItemType Type { get; private set; }

        /// <summary>
        /// ctor
        /// </summary>
        /// <param name="after"></param>
        /// <param name="type"></param>
        public RetryAfterGuard(DateTime after, RateLimitItemType type)
        {
            After = after;
            Type = type;
        }

        /// <inheritdoc />
        public LimitCheck Check(RateLimitItemType type, RequestDefinition definition, string? apiKey, int requestWeight, string? keySuffix)
        {
            if (type != Type)
                return LimitCheck.NotApplicable;

            var dif = (After + _windowBuffer) - DateTime.UtcNow;
            if (dif <= TimeSpan.Zero)
                return LimitCheck.NotApplicable;

            return LimitCheck.Needed(dif, default, default, default);
        }

        /// <inheritdoc />
        public RateLimitState ApplyWeight(RateLimitItemType type, RequestDefinition definition, string? apiKey, int requestWeight, string? keySuffix)
        {
            return RateLimitState.NotApplied;
        }

        /// <summary>
        /// Update the 'after' time
        /// </summary>
        /// <param name="after"></param>
        public void UpdateAfter(DateTime after) => After = after;

        /// <inheritdoc />
        public void Reset(RateLimitItemType type, RequestDefinition definition, string? apiKey, string? keySuffix, int? amount)
        {
            After = DateTime.UtcNow;
        }
    }
}