mirror of
https://github.com/logos-storage/nim-chronos.git
synced 2026-04-02 17:23:06 +00:00
33 lines
1.2 KiB
Markdown
33 lines
1.2 KiB
Markdown
|
# Introduction
|
||
|
|
|
||
|
|
Chronos implements the [async/await](https://en.wikipedia.org/wiki/Async/await)
|
||
|
|
paradigm in a self-contained library using macro and closure iterator
|
||
|
|
transformation features provided by 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
|
||
|
|
* Exception [effect support](./guide.md#error-handling)
|
||
|
|
|
||
|
|
## Platform support
|
||
|
|
|
||
|
|
Several platforms are supported, with different backend [options](./concepts.md#compile-time-configuration):
|
||
|
|
|
||
|
|
* Windows: [`IOCP`](https://learn.microsoft.com/en-us/windows/win32/fileio/i-o-completion-ports)
|
||
|
|
* Linux: [`epoll`](https://en.wikipedia.org/wiki/Epoll) / `poll`
|
||
|
|
* OSX / BSD: [`kqueue`](https://en.wikipedia.org/wiki/Kqueue) / `poll`
|
||
|
|
* Android / Emscripten / posix: `poll`
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
Examples are available in the [`docs/examples/`](https://github.com/status-im/nim-chronos/docs/examples) folder.
|
||
|
|
|
||
|
|
## API documentation
|
||
|
|
|
||
|
|
This guide covers basic usage of chronos - for details, see the
|
||
|
|
[API reference](./api/chronos.html).
|