Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kataras/chronos
NEW: Chronos provides an easy way to limit X operations per Y time in accuracy of nanoseconds
https://github.com/kataras/chronos
go golang rate-limits time
Last synced: 2 months ago
JSON representation
NEW: Chronos provides an easy way to limit X operations per Y time in accuracy of nanoseconds
- Host: GitHub
- URL: https://github.com/kataras/chronos
- Owner: kataras
- License: bsd-3-clause
- Created: 2017-10-20T18:05:29.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-02-24T01:38:41.000Z (almost 7 years ago)
- Last Synced: 2024-08-03T23:15:34.674Z (4 months ago)
- Topics: go, golang, rate-limits, time
- Language: Go
- Homepage:
- Size: 17.6 KB
- Stars: 14
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-golang-repositories - chronos
README
# chronos [](https://travis-ci.org/kataras/chronos)[](http://goreportcard.com/report/kataras/chronos)[](https://github.com/kataras/chronos/issues?q=is%3Aopen+is%3Aissue)[](https://github.com/kataras/chronos/issues?q=is%3Aissue+is%3Aclosed)[](https://github.com/kataras/chronos/releases)[](https://github.com/kataras/chronos/tree/master/_examples)[](https://godoc.org/github.com/kataras/chronos)
Chronos provides an easy way to limit X operations per Y time in accuracy of nanoseconds.
Chronos is a crucial tool when calling external, remote or even internal APIs with rate limits.
### 📑 Table Of Content
* [Installation](#-installation)
* [Latest changes](HISTORY.md)
* [Examples](#-learn)
* [Simple native](_examples/native-acquire)
* [Simple http client](_examples/http)
* [Community & Support](#-community)
* [Versioning](#-version)
* [People](#-people)
### 🚀 Installation
The only requirement is the [Go Programming Language](https://golang.org/dl/).
```bash
$ go get -u github.com/kataras/chronos
```
> `chronos` has zero third-party dependencies rathen than the Go's standard library.
`Chronos` is very simple to use tool, you just declare the maximum operations(max) and in every Y time
that those operations are allowed to be executed(per). `Chronos` has the accuracy of nanoseconds.
You can use `chronos#Acquire` anywhere you want, but be careful because it waits/blocks for
availability to be executed.
```go
import (
"time"
"github.com/kataras/chronos"
)
func main() {
// Allow maximum of 5 MyActions calls
// per 3 seconds.
c := chronos.New(5, 3 * time.Second)
// The below actions will execute immediately.
MyAction(c)
MyAction(c)
MyAction(c)
MyAction(c)
MyAction(c)
// The below action will execute after 3 seconds from the last call
// or when 3 seconds passed without any c.Acquire call.
MyAction(c)
}
func MyAction(c *chronos.C) {
<- c.Acquire()
// Do something here...
}
```
The `<- c.Acquire()` is blocking when needed, no any further actions neeeded by the end-developer.
### Helpers
The [ext](ext) package provides two subpackages; `function` and `http`. Navigate there to learn how they can help you.
### 📖 Learn
The awesome `chronos` community is always adding new content to learn from, [_examples](_examples/) is a great place to get started!
Read the [godocs](https://godoc.org/github.com/kataras/chronos) for a better understanding.
### 👥 Community
Join the welcoming community of fellow `chronos` developers in [rocket.chat](https://kataras.rocket.chat/channel/chronos)
- [Post](https://github.com/kataras/chronos/issues/new) a feature request or report a bug
- :star: and watch the public [repository](https://github.com/kataras/chronos/stargazers), will keep you up to date
- :earth_americas: publish [an article](https://medium.com/search?q=chronos) or share a [tweet](https://twitter.com/hashtag/golang) about your personal experience with `chronos`.
### 📌 Version
Current: [0.0.1](VERSION)
Read more about Semantic Versioning 2.0.0
- http://semver.org/
- https://en.wikipedia.org/wiki/Software_versioning
- https://wiki.debian.org/UpstreamGuide#Releases_and_Versions
### 🥇 People
The original author of `chronos` is [@kataras](https://github.com/kataras), you can reach him via;
- [Medium](https://medium.com/@kataras)
- [Twitter](https://twitter.com/makismaropoulos)
- [Dev.to](https://dev.to/@kataras)
- [Facebook](https://facebook.com/kataras.gopher)
- [Mail](mailto:[email protected]?subject=Chronos%20I%20need%20some%20help%20please)
[List of all Authors](AUTHORS)
[List of all Contributors](https://github.com/kataras/chronos/graphs/contributors)
## License
This software is licensed under the open source 3-Clause BSD License.
You can find the license file [here](LICENSE), for any questions regarding the license please [contact with me](mailto:mailto:[email protected]?subject=Chronos%20License).