package uring

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

License

package uring

uring
- CHANGES
- LICENSE
- README
- Library uring
  - Uring
    
    Region
    
    FLAGS
    
    Open_flags
    
    Resolve
    
    Poll_mask
    
    Sockaddr
    
    Private
    
    Heap
- Sources
  - uring
    
    config.ml
    
    heap.ml
    
    region.ml
    
    uring.ml
    
    uring__.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

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.