Lwt - API Reference

Core library

The core library (lwt package) contains the Lwt module, which definescooperative threads with all the primitives to manipulate them. Italso provides several general purpose modules, which do not depend onany external package.

Lwt	Module Lwt: cooperative light-weight threads.
Lwt_condition	Conditions
Lwt_list	List helpers
Lwt_mutex	Cooperative locks for mutual exclusion
Lwt_mvar	Mailbox variables
Lwt_pool	Creating pools (for example pools of connections to a database).
Lwt_sequence	Mutable sequence of elements
Lwt_stream	Data streams

Unix bindings

The lwt.unix package provides:

• the Lwt_unix module, which wrap system calls into cooperative ones
• the Lwt_io module, which defines cooperative byte channel, in replacement of ones of the standard library
• module helpers for logging, spawning processes, ...

This package depends on the core library and the unix package.

Reactive programming helpers

The lwt.react package provides helpers for functionnal reactiveprogramming with Lwt. It is based on the react package. BothLwt_event and Lwt_signal modules contains:

• Lwt specific primitives
• cooperative versions of react functions

This package depends on the core library and the react package.

Syntax extensions

Lwt is shipped with two syntax extensions. The first one, contained inthe lwt.syntax package, aims to make coding with Lwt easier, andto make code more readable. The second, contained in the package lwt.syntax.log, is a camlp4 filter which decreases the performancepenalty when using logging by inlining level tests.

Pa_lwt	Syntactic sugars for lwt
Pa_log	Logging facility

Terminal manipulation

The package lwt.text provides:

• terminal manipulation through the module Lwt_term
• text channels which behaves as byte channels but are aware of the text encoding
• a cooperative, fully customizable read-line facility

This package depends on the core library, and the lwt.react,lwt.unix, text packages.

Miscellaneous

The following modules are wrapper for integration of non-Lwtfunctions/packages into Lwt.

Lwt_glib	Glib integration
Lwt_lib	Cooperative unix system calls
Lwt_preemptive	This module allows to mix preemptive threads with Lwt cooperative threads.
Lwt_ssl	OCaml-SSL integration

Index

Index of types
Index of exceptions
Index of values
Index of class methods
Index of classes
Index of modules
Index of module types