mirror of
https://github.com/hanzoai/tasks.git
synced 2026-10-30 14:56:19 +00:00
Prathyush PVandGitHub
db59cf9f6e
## What changed? Add TokensAt() method to quotas.RateLimiter interface. ## Why? This method is useful to get the number of tokens that will be available at a future time point. It is available in golang's rate.Limiter. We just have to expose it. ## How did you test it? Unit tests ## Potential risks None ## Documentation ## Is hotfix candidate? No
73 lines
2.6 KiB
Go
73 lines
2.6 KiB
Go
// The MIT License
|
|
//
|
|
// Copyright (c) 2020 Temporal Technologies Inc. All rights reserved.
|
|
//
|
|
// Copyright (c) 2020 Uber Technologies, Inc.
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
// of this software and associated documentation files (the "Software"), to deal
|
|
// in the Software without restriction, including without limitation the rights
|
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
// copies of the Software, and to permit persons to whom the Software is
|
|
// furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in
|
|
// all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
// THE SOFTWARE.
|
|
|
|
package quotas
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
)
|
|
|
|
//go:generate mockgen -copyright_file ../../LICENSE -package $GOPACKAGE -source $GOFILE -destination rate_limiter_mock.go
|
|
|
|
type (
|
|
// RateLimiter corresponds to basic rate limiting functionality.
|
|
RateLimiter interface {
|
|
// Allow attempts to allow a request to go through. The method returns
|
|
// immediately with a true or false indicating if the request can make
|
|
// progress
|
|
Allow() bool
|
|
|
|
// AllowN attempts to allow a request to go through. The method returns
|
|
// immediately with a true or false indicating if the request can make
|
|
// progress
|
|
AllowN(now time.Time, numToken int) bool
|
|
|
|
// Reserve returns a Reservation that indicates how long the caller
|
|
// must wait before event happen.
|
|
Reserve() Reservation
|
|
|
|
// ReserveN returns a Reservation that indicates how long the caller
|
|
// must wait before event happen.
|
|
ReserveN(now time.Time, numToken int) Reservation
|
|
|
|
// Wait waits till the deadline for a rate limit token to allow the request
|
|
// to go through.
|
|
Wait(ctx context.Context) error
|
|
|
|
// WaitN waits till the deadline for n rate limit token to allow the request
|
|
// to go through.
|
|
WaitN(ctx context.Context, numToken int) error
|
|
|
|
// Rate returns the rate per second for this rate limiter
|
|
Rate() float64
|
|
|
|
// Burst returns the burst for this rate limiter
|
|
Burst() int
|
|
|
|
// TokensAt returns the number of tokens that will be available at time t
|
|
TokensAt(t time.Time) int
|
|
}
|
|
)
|