hit throttle

Author: BFergerson

src/commonMain/kotlin/spp.protocol/instrument/HitThrottle.kt

@@ -0,0 +1,43 @@
+package spp.protocol.instrument
+
+import kotlinx.datetime.Clock
+import kotlin.jvm.Transient
+
+class HitThrottle(private val limit: Int, step: HitThrottleStep) {
+
+    private val step: HitThrottleStep
+
+    @Transient
+    private var lastReset: Long = -1
+
+    @Transient
+    private var hitCount = 0
+
+    @Transient
+    var totalHitCount = 0
+        private set
+
+    @Transient
+    var totalLimitedCount = 0
+        private set
+
+    init {
+        this.step = step
+    }
+
+    fun isRateLimited(): Boolean {
+        if (hitCount++ < limit) {
+            totalHitCount++
+            return false
+        }
+        return if (Clock.System.now().toEpochMilliseconds() - lastReset > step.toMillis(1)) {
+            hitCount = 1
+            totalHitCount++
+            lastReset = Clock.System.now().toEpochMilliseconds()
+            false
+        } else {
+            totalLimitedCount++
+            true
+        }
+    }
+}

src/commonMain/kotlin/spp.protocol/instrument/HitThrottleStep.kt

@@ -0,0 +1,12 @@
+package spp.protocol.instrument
+
+enum class HitThrottleStep(private val millis: Int) {
+    SECOND(1000),
+    MINUTE(1000 * 60),
+    HOUR(1000 * 60 * 60),
+    DAY(1000 * 60 * 60 * 24);
+
+    fun toMillis(duration: Long): Long {
+        return millis * duration
+    }
+}