package lwt

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Event loop methods
Backend methods

package lwt

lwt
- Lwt
  - Infix
    
    Let_syntax
    
    Open_on_rhs
- Lwt_condition
- Lwt_list
- Lwt_mutex
- Lwt_mvar
- Lwt_pool
- Lwt_pqueue
  - Make
    
    Ord
  - OrderedType
  - S
- Lwt_result
  - Infix
- Lwt_sequence
- Lwt_stream
  - bounded_push
- Lwt_switch
lwt.unix
- Lwt_bytes
- Lwt_config
- Lwt_engine
  - Ev_backend
  - Versioned
    
    libev_1
    
    libev_2
  - abstract
  - libev
  - poll_based
  - select
  - select_based
  - t
- Lwt_features
- Lwt_fmt
- Lwt_gc
- Lwt_io
  - BE
  - LE
  - NumberIO
  - Versioned
- Lwt_main
- Lwt_preemptive
- Lwt_process
- Lwt_sys
- Lwt_throttle
  - Make
    
    H
  - S
- Lwt_timeout
- Lwt_unix

Legend:
Library
Module
Module type
Parameter
Class
Class type

Abstract class for engines.

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 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

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