package uring
Install
dune-project
Dependency
Authors
Maintainers
Sources
sha256=4f1446664ae6091cb6e34688b6ddf384f2b26674ea7e6b6105018a12a2893a21
sha512=0658ce85cdd254aca8605f877ed321e004696943a58ecaba96cc923fee0024084b6cca541669bd4f879cbf1d05deecb01f12652dbce09235880a5de384233dd9
Description
Bindings to the Linux io_uring kernel IO interfaces. See https://github.com/ocaml-multicore/eio for a higher-level API using this.
Published: 02 Feb 2022
README
ocaml-uring -- bindings to Linux io_uring
These are OCaml bindings for the Linux io_uring stack (an alternative to using syscalls such as select
or epoll
).
The Eio library provides a higher-level effects-based API that uses this library to implement its Linux backend, but ocaml-uring may be useful with single-core non-effects versions of OCaml too.
To use the library directly:
Call
Uring.create
to initialise a ring.Add IO requests to the ring using functions such as
Uring.readv
.Call
Uring.submit
to notify the kernel of the new requests.Call
Uring.wait
to wait until an operation is complete.
The tests
directory contains some examples.
License
This library is released under the ISC license (see LICENSE.md), but note that the repository also vendors liburing - see vendor/liburing/README.