Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/status-im/nim-chronos
Chronos - An efficient library for asynchronous programming
https://github.com/status-im/nim-chronos
async async-await asynchronous-programming nim nim-language
Last synced: about 2 months ago
JSON representation
Chronos - An efficient library for asynchronous programming
- Host: GitHub
- URL: https://github.com/status-im/nim-chronos
- Owner: status-im
- License: apache-2.0
- Created: 2018-05-16T08:18:43.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-07-19T13:55:00.000Z (2 months ago)
- Last Synced: 2024-07-28T21:57:21.195Z (about 2 months ago)
- Topics: async, async-await, asynchronous-programming, nim, nim-language
- Language: Nim
- Homepage: https://status-im.github.io/nim-chronos/docs/chronos
- Size: 13.9 MB
- Stars: 353
- Watchers: 64
- Forks: 51
- Open Issues: 51
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHEv2
Awesome Lists containing this project
- awesome-nim - chronos - An efficient library for asynchronous programming. (Language Features / Async IO)
- best-of-crypto - GitHub - 37% open · ⏱️ 02.06.2024): (Web 3.0)
README
# Chronos - An efficient library for asynchronous programming
[](https://github.com/status-im/nim-chronos/actions/workflows/ci.yml)
[](https://opensource.org/licenses/Apache-2.0)
[](https://opensource.org/licenses/MIT)
## Introduction
Chronos is an efficient [async/await](https://en.wikipedia.org/wiki/Async/await) framework for Nim. Features include:
* Asynchronous socket and process I/O
* HTTP server with SSL/TLS support out of the box (no OpenSSL needed)
* Synchronization primitivies like queues, events and locks
* Cancellation
* Efficient dispatch pipeline with excellent multi-platform support
* Exceptional error handling features, including `raises` tracking
## Getting started
Install `chronos` using `nimble`:
```text
nimble install chronos
```
or add a dependency to your `.nimble` file:
```text
requires "chronos"
```
and start using it:
```nim
import chronos/apps/http/httpclient
proc retrievePage(uri: string): Future[string] {.async.} =
# Create a new HTTP session
let httpSession = HttpSessionRef.new()
try:
# Fetch page contents
let resp = await httpSession.fetch(parseUri(uri))
# Convert response to a string, assuming its encoding matches the terminal!
bytesToString(resp.data)
finally: # Close the session
await noCancel(httpSession.closeWait())
echo waitFor retrievePage(
"https://raw.githubusercontent.com/status-im/nim-chronos/master/README.md")
```
## Documentation
See the [user guide](https://status-im.github.io/nim-chronos/).
## Projects using `chronos`
* [libp2p](https://github.com/status-im/nim-libp2p) - Peer-to-Peer networking stack implemented in many languages
* [presto](https://github.com/status-im/nim-presto) - REST API framework
* [Scorper](https://github.com/bung87/scorper) - Web framework
* [2DeFi](https://github.com/gogolxdong/2DeFi) - Decentralised file system
* [websock](https://github.com/status-im/nim-websock/) - WebSocket library with lots of features
`chronos` is available in the [Nim Playground](https://play.nim-lang.org/#ix=2TpS)
Submit a PR to add yours!
## TODO
* Multithreading Stream/Datagram servers
## Contributing
When submitting pull requests, please add test cases for any new features or fixes and make sure `nimble test` is still able to execute the entire test suite successfully.
`chronos` follows the [Status Nim Style Guide](https://status-im.github.io/nim-style-guide/).
## License
Licensed and distributed under either of
* MIT license: [LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT
or
* Apache License, Version 2.0, ([LICENSE-APACHEv2](LICENSE-APACHEv2) or http://www.apache.org/licenses/LICENSE-2.0)
at your option. These files may not be copied, modified, or distributed except according to those terms.