nim-chronos/README.md

89 lines
3.0 KiB
Markdown
Raw Normal View History

# Chronos - An efficient library for asynchronous programming
2019-02-06 15:43:27 +00:00
2023-09-05 10:48:09 +00:00
[![Github action](https://github.com/status-im/nim-chronos/workflows/CI/badge.svg)](https://github.com/status-im/nim-chronos/actions/workflows/ci.yml)
2018-09-05 03:36:14 +00:00
[![License: Apache](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
2018-09-05 03:27:01 +00:00
![Stability: experimental](https://img.shields.io/badge/stability-experimental-orange.svg)
2018-05-21 22:15:34 +00:00
## Introduction
2021-03-20 07:12:35 +00:00
Chronos is an efficient [async/await](https://en.wikipedia.org/wiki/Async/await) framework for Nim. Features include:
* Asynchronous socket and process I/O
2021-03-20 07:12:35 +00:00
* 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
2018-05-30 03:34:58 +00:00
## Getting started
2021-03-20 07:12:35 +00:00
Install `chronos` using `nimble`:
2018-05-28 23:35:15 +00:00
2021-03-20 07:12:35 +00:00
```text
nimble install chronos
2018-05-30 03:32:47 +00:00
```
2021-03-20 07:12:35 +00:00
or add a dependency to your `.nimble` file:
```text
requires "chronos"
2018-05-30 03:32:47 +00:00
```
2018-05-28 23:35:15 +00:00
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!
2018-05-30 03:32:47 +00:00
## 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.
2018-05-28 23:35:15 +00:00
2021-03-20 07:12:35 +00:00
`chronos` follows the [Status Nim Style Guide](https://status-im.github.io/nim-style-guide/).
2018-09-05 03:36:14 +00:00
## License
2018-09-05 18:45:22 +00:00
Licensed and distributed under either of
* MIT license: [LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT
2019-01-02 13:53:00 +00:00
or
* Apache License, Version 2.0, ([LICENSE-APACHEv2](LICENSE-APACHEv2) or http://www.apache.org/licenses/LICENSE-2.0)
2018-09-05 03:36:14 +00:00
at your option. These files may not be copied, modified, or distributed except according to those terms.