Events
Type of events. An event represent a callback registered to be called when some event occurs.
val stop_event : event -> unit
stop_event event
stops the given event.
val fake_event : event
Event which does nothing when stopped.
Event loop functions
iter block
performs one iteration of the main loop. If block
is true
the function must block until one event becomes available, otherwise it should just check for available events and return immediately.
val on_readable : Unix.file_descr -> (event -> unit) -> event
on_readable fd f
calls f
each time fd
becomes readable.
val on_writable : Unix.file_descr -> (event -> unit) -> event
on_readable fd f
calls f
each time fd
becomes writable.
on_timer delay repeat f
calls f
one time after delay
seconds. If repeat
is true
then f
is called each delay
seconds, otherwise it is called only one time.
Returns the number of events waiting for a file descriptor to become readable.
Returns the number of events waiting for a file descriptor to become writable.
val fake_io : Unix.file_descr -> unit
Simulates activity on the given file descriptor.
Engines
class virtual abstract : object ... end
Abstract class for engines.
class type tobject ... end
Type of engines.
Predefined engines
module Ev_backend : sig ... end
class libev : ?backend:Ev_backend.t -> unit -> object ... end
Engine based on libev. If not compiled with libev support, the creation of the class will raise Lwt_sys.Not_available
.
class virtual select_based : object ... end
Abstract class for engines based on a select-like function.
class virtual poll_based : object ... end
Abstract class for engines based on a poll-like function.
The current engine
val get : unit -> t
get ()
returns the engine currently in use.
set ?transfer ?destroy engine
replaces the current engine by the given one.
If transfer
is true
(the default) all events from the current engine are transferred to the new one.
If destroy
is true
(the default) then the current engine is destroyed before being replaced.
module Versioned : sig ... end