RateLimit

object RateLimit

Implements the ability wo work with GitHub's rate limit, recognize blocks from previous attempts, wait and retry.

Functions

equals

open operator fun equals(other: Any?): Boolean

getWaitLength

private fun getWaitLength(): Long

calculate required wait in ms

hashCode

open fun hashCode(): Int

isLimitReached

private fun isLimitReached(): Boolean

Maintain and check a rate-limit

notifyHttpResponse

fun notifyHttpResponse(response: HttpURLConnection)

http responses should be passed to this so the actual rate limit window can be evaluated and used. The very first response and all 403 ones are good candidates if they can be expected to contain GitHub's rate limit headers.

toString

open fun toString(): String

waitForLimit

fun waitForLimit(): Boolean

If rate limit in effect, sleep long enough to allow next request.

Properties

account

private var account: Int = 0

firstRequest

private var firstRequest: Long = 0L

intervalInMilliSeconds

const val intervalInMilliSeconds: Long = 60000L

maxRequestsPerInterval

const val maxRequestsPerInterval: Int = 10

maxWaitLoop

private const val maxWaitLoop: Int = 3

millis

private val millis: Long

Sources

jvm source