package eio

  1. Overview
  2. Docs
package eio
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module EioSource

Effects based parallel IO for OCaml.

Eio provides support for concurrency (juggling many tasks) and parallelism (using multiple CPU cores for performance).

It provides facilities for creating and coordinating fibers (light-weight threads) and domains (for parallel processing), as well as interfaces for interacting with resources provided by the operating system.

These features must be used within an event loop, provided by an Eio backend. Applications can use Eio_main.run to run a suitable loop.

See https://github.com/ocaml-multicore/eio for a tutorial.

Concurrency primitives

Sourcemodule Switch : sig ... end

Grouping fibers and other resources so they can be turned off together.

Sourcemodule Promise : sig ... end

A promise is a placeholder for result that will arrive in the future.

Sourcemodule Fiber : sig ... end

A fiber is a light-weight thread.

Sourcemodule Semaphore : sig ... end

A counting semaphore.

Sourcemodule Mutex : sig ... end

Mutual exclusion.

Sourcemodule Condition : sig ... end

Waiting for a condition to become true.

Sourcemodule Stream : sig ... end

A stream/queue.

Sourcemodule Cancel : sig ... end

Cancelling fibers.

Sourcemodule Std : sig ... end

Commonly used standard features. This module is intended to be opened.

Cross-platform OS API

The general pattern here is that each type of resource has a set of functions for using it, plus an object type to allow defining your own implementations. To use the resources, it is recommended that you use the functions rather than calling methods directly. Using the functions results in better error messages from the compiler, and may provide extra features or sanity checks.

The system resources are available from the Stdenv.t provided by your event loop (e.g. Eio_main.run).

Sourcemodule Generic : sig ... end

A base class for objects that can be queried at runtime for extra features.

Sourcemodule Flow : sig ... end

Byte streams.

Sourcemodule Buf_read : sig ... end

Buffered input and parsing

Sourcemodule Buf_write : sig ... end

Buffered output

Sourcemodule Net : sig ... end

Networking.

Sourcemodule Domain_manager : sig ... end

Parallel computation across multiple CPU cores.

Sourcemodule Time : sig ... end

Clocks, time, sleeping and timeouts.

Sourcemodule File : sig ... end

Operations on open files.

Sourcemodule Fs : sig ... end

File-system types.

Sourcemodule Path : sig ... end

Accessing paths on a file-system.

Sourcemodule Debug : sig ... end

Control over debugging.

Sourcemodule Stdenv : sig ... end

The standard environment of a process.

Errors and Debugging

Sourceexception Io of Exn.err * Exn.context
Sourceval traceln : ?__POS__:(string * int * int * int) -> ('a, Format.formatter, unit, unit) format4 -> 'a

traceln fmt outputs a debug message (typically to stderr).

Trace messages are printed by default and do not require logging to be configured first. The message is printed with a newline, and is flushed automatically. traceln is intended for quick debugging rather than for production code.

Unlike most Eio operations, traceln will never switch to another fiber; if the OS is not ready to accept the message then the whole domain waits.

It is safe to call traceln from multiple domains at the same time. Each line will be written atomically.

Examples:

  traceln "x = %d" x;
  traceln "x = %d" x ~__POS__;   (* With location information *)
  • parameter __POS__

    Display __POS__ as the location of the traceln call.

Sourcemodule Exn : sig ... end

Eio exceptions.

Provider API for OS schedulers

Sourcemodule Private : sig ... end

API for use by the scheduler implementation.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct