mirror of
https://github.com/hanzoai/tasks.git
synced 2026-10-04 02:04:03 +00:00
Alex ShtinandGitHub
8e8f1b0f7c
## What changed?
<!-- Describe what has changed in this PR -->
Remove license header from every file. Because it is really hard to
follow in this PR here is the summary:
1. License header is removed from all `.go` and `.proto` files
:fireworks::fireworks:🎆.
2. `LICENSE` file in the root directory has only Temporal and Uber
copyrights.
3. 5 other `LICENSE` files added to the packages which have copyrights
different from Temporal and Uber: Datadog, Xargin, "Mat Ryer, Tyler
Bunnell and contributors".
4. `license_file` flag is removed from all code generation tools.
5. `copyright_file` flag is removed from `go:generate mockgen`
directive.
6. All copyright related targets are removed from `Makefile`.
7. Updated Temporal copyright year to 2025 everywhere.
## Why?
<!-- Tell your future self why have you made these changes -->
I double checked with legal department that it is not needed to have
license header in every file. One file per repo is enough. I put all
copyrights to the root `LICENSE` file and removed header from all other
files. Also updated tools and `Makefile`.
54 lines
1.7 KiB
Go
54 lines
1.7 KiB
Go
package quotas
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
)
|
|
|
|
//go:generate mockgen -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
|
|
|
|
// RecycleToken immediately unblocks another process that is waiting for a token, if
|
|
// a waiter exists. A token should be recycled when the action being rate limited was
|
|
// not completed for some reason (i.e. a task is not dispatched because it was invalid).
|
|
RecycleToken()
|
|
}
|
|
)
|