package lwt

  1. Overview
  2. Docs
Promises and event-driven I/O

Install 

dune-project
 Dependency

github.com Readme MIT License Edit opam file Versions (34)

Authors

  1. J
    Jérôme Vouillon
  2. J
    Jérémie Dimino

Maintainers

  1. R
    Raphaël Proust <code@bnwr.net>
  2. Anton Bachin

Sources

5.10.0.tar.gz
md5=dba3f8d8db1b9bed9f3a24385cc48e2b
sha512=6d25ebc6d011e75ff6ce6d1b0821be1aacbdebc2fbb26130edd43f20c0d1874bbcb6618003600fc80006a898434118795f691322a2455de11dfa23a868d6a110

doc/lwt.unix/Lwt_engine/class-abstract/index.html

Class Lwt_engine.abstractSource

Abstract class for engines.

method id : engine_id
method destroy : unit

Destroy the engine, remove all its events and free its associated resources.

method transfer : abstract -> unit

transfer engine moves all events from the current engine to engine. Note that timers are reset in the destination engine, i.e. if a timer with a delay of 2 seconds was registered 1 second ago it will occur in 2 seconds in the destination engine.

Event loop methods

method virtual iter : bool -> unit
method fork : unit
method on_readable : Unix.file_descr -> (event -> unit) -> event
method on_writable : Unix.file_descr -> (event -> unit) -> event
method on_timer : float -> bool -> (event -> unit) -> event
method fake_io : Unix.file_descr -> unit
method readable_count : int
method writable_count : int
method timer_count : int
method forwards_signal : int -> bool

Backend methods

Notes:

  • the callback passed to register methods is of type unit -> unit and not event -> unit
  • register methods return a lazy value which unregisters the event when forced
method private virtual cleanup : unit

Cleanup resources associated with the engine.

method private virtual register_readable : Unix.file_descr -> (unit -> unit) -> unit Lazy.t
method private virtual register_writable : Unix.file_descr -> (unit -> unit) -> unit Lazy.t
method private virtual register_timer : float -> bool -> (unit -> unit) -> unit Lazy.t