Feature/ratelimit refactor (#197)

2026-08-23 22:32:57 +00:00 · 2024-04-16 14:55:27 +02:00
parent 2dbd5be924
commit 1b1961db00
57 changed files with 2294 additions and 688 deletions
@@ -0,0 +1,80 @@
+using CryptoExchange.Net.Objects;
+using System;
+
+namespace CryptoExchange.Net.RateLimiting
+{
+    /// <summary>
+    /// Rate limit event
+    /// </summary>
+    public record RateLimitEvent
+    {
+        /// <summary>
+        /// Name of the API limit that is reached
+        /// </summary>
+        public string ApiLimit { get; set; } = string.Empty;
+        /// <summary>
+        /// Description of the limit that is reached
+        /// </summary>
+        public string LimitDescription { get; set; } = string.Empty;
+        /// <summary>
+        /// The request definition
+        /// </summary>
+        public RequestDefinition RequestDefinition { get; set; }
+        /// <summary>
+        /// The host the request is for
+        /// </summary>
+        public string Host { get; set; } = default!;
+        /// <summary>
+        /// The current counter value
+        /// </summary>
+        public int Current { get; set; }
+        /// <summary>
+        /// The weight of the limited request
+        /// </summary>
+        public int RequestWeight { get; set; }
+        /// <summary>
+        /// The limit per time period
+        /// </summary>
+        public int? Limit { get; set; }
+        /// <summary>
+        /// The time period the limit is for
+        /// </summary>
+        public TimeSpan? TimePeriod { get; set; }
+        /// <summary>
+        /// The time the request will be delayed for if the Behaviour is RateLimitingBehaviour.Wait
+        /// </summary>
+        public TimeSpan? DelayTime { get; set; }
+        /// <summary>
+        /// The handling behaviour for the rquest 
+        /// </summary>
+        public RateLimitingBehaviour Behaviour { get; set; }
+
+        /// <summary>
+        /// ctor
+        /// </summary>
+        /// <param name="apiLimit"></param>
+        /// <param name="limitDescription"></param>
+        /// <param name="definition"></param>
+        /// <param name="host"></param>
+        /// <param name="current"></param>
+        /// <param name="requestWeight"></param>
+        /// <param name="limit"></param>
+        /// <param name="timePeriod"></param>
+        /// <param name="delayTime"></param>
+        /// <param name="behaviour"></param>
+        public RateLimitEvent(string apiLimit, string limitDescription, RequestDefinition definition, string host, int current, int requestWeight, int? limit, TimeSpan? timePeriod, TimeSpan? delayTime, RateLimitingBehaviour behaviour)
+        {
+            ApiLimit = apiLimit;
+            LimitDescription = limitDescription;
+            RequestDefinition = definition;
+            Host = host;
+            Current = current;
+            RequestWeight = requestWeight;
+            Limit = limit;
+            TimePeriod = timePeriod;
+            DelayTime = delayTime;
+            Behaviour = behaviour;
+        }
+
+    }
+}