Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/donatorsky/go-rate-limiter
A Go's rate limiting package for asynchronous jobs.
https://github.com/donatorsky/go-rate-limiter
async asynchronous go golang rate-limiter rate-limiting
Last synced: 30 days ago
JSON representation
A Go's rate limiting package for asynchronous jobs.
- Host: GitHub
- URL: https://github.com/donatorsky/go-rate-limiter
- Owner: donatorsky
- License: mit
- Created: 2022-02-07T14:03:56.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-04T08:15:31.000Z (9 months ago)
- Last Synced: 2024-08-03T23:29:52.450Z (4 months ago)
- Topics: async, asynchronous, go, golang, rate-limiter, rate-limiting
- Language: Go
- Homepage:
- Size: 60.5 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-golang-repositories - go-rate-limiter
README
# Go Rate Limiter
A Go's rate limiting package for asynchronous jobs.
[](https://github.com/donatorsky/go-rate-limiter/blob/main/LICENSE)
[](https://github.com/donatorsky/go-rate-limiter/actions?query=branch%3Amain)
[](https://codecov.io/gh/donatorsky/go-rate-limiter)
## What it does?
It allows for the execution of up to `n` jobs in `t` time. If not all jobs were completed in current `t`, during the next `t` period it will try to execute `n - unfinished jobs` jobs.
You can add as many jobs as You want. All jobs that exceed `n` limit will be queued and will run automatically, as soon as there is space for them.
## Installation
Install it using a package manager:
```shell
go get github.com/donatorsky/go-rate-limiter
```
And then use it in Your code:
```go
import "github.com/donatorsky/go-rate-limiter"
```
## Example usage
```go
// Execute up to 5 requests per 2 seconds
worker := ratelimiter.NewRateLimiter(time.Second*2, 5)
// Start jobs worker
worker.Begin()
// Stop jobs worker
defer worker.Finish()
// Queue and execute jobs
wg := sync.WaitGroup{}
log.Println("Start requesting")
for i := 0; i < 12; i++ {
wg.Add(1)
currentRequestId := i
worker.
Do(func() (interface{}, error) {
log.Printf("-> Request #%d has been started\n", currentRequestId)
// ...Your job execution definition...
// Return job result or error
return currentRequestId, nil
}).
Then(func(value interface{}) (result interface{}, err error) {
// In case Do() returned nil error
log.Printf("<- Request #%d: Then: %v\n", currentRequestId, v)
return nil, nil
}).
Catch(func(reason error) {
// In case Do() or Then() returned non-nil error
log.Printf("<- Request #%d: Catch: %v\n", currentRequestId, reason)
}).
Finally(func() {
// Always
//log.Printf("<- Request #%d: Finally: %v\n", currentRequestId, v)
wg.Done()
})
}
log.Println("Stop requesting")
wg.Wait()
log.Println("Processing finished")
```