mirror of
https://github.com/c-cube/nanoev.git
synced 2025-12-05 19:00:35 -05:00
add readme
This commit is contained in:
parent
6007cf9392
commit
3deea9e585
1 changed files with 31 additions and 0 deletions
31
README.md
Normal file
31
README.md
Normal file
|
|
@ -0,0 +1,31 @@
|
|||
# nanoev
|
||||
|
||||
A minimalistic but modular abstraction for IO event loops.
|
||||
|
||||
The goal of this library is to provide a uniform abstraction over multiple
|
||||
system event loops, in a way that plays well with Picos.
|
||||
|
||||
## Usage
|
||||
|
||||
Very basic usage would look like this:
|
||||
|
||||
```ocaml
|
||||
module EV = Nanoev_picos
|
||||
|
||||
|
||||
let () =
|
||||
(* use a backend, eg. select *)
|
||||
let ev = Nanoev_unix.create () in
|
||||
|
||||
(* install the backend *)
|
||||
Nanoev_picos.setup_bg_thread ev;
|
||||
|
||||
(* setup a picos scheduler and use EV.read, EV.write, etc. *)
|
||||
…
|
||||
```
|
||||
|
||||
|
||||
## Backends
|
||||
|
||||
- [x] select
|
||||
- [ ] uring
|
||||
Loading…
Add table
Reference in a new issue