package devkit

  1. Overview
  2. Docs
Development kit - general purpose library

Install 

dune-project
 Dependency

github.com Readme Edit opam file Versions (8)

Authors

  1. A
    Ahrefs <github@ahrefs.com>

Maintainers

  1. I
    igor@ahrefs.com

Sources

devkit-1.20240429.tbz
sha256=222f8ac131b1d970dab7eeb2714bfd6b9338b88b1082e6e01c136ae19e7eaef4
sha512=c9e6d93e3d21e5530c0f4d5baca51bf1f0a5d19248f8af7678d0665bb5cdf295d7aaaaa3e50eb2e44b8720e55097cc675af4dc8ec45acf9da39feb3eae1405d5

doc/devkit.core/Devkit_core/Async/index.html

Module Devkit_core.AsyncSource

Asynchronous IO helpers

module Ev = Libevent
Sourcemodule Internal : sig ... end
Sourceval simple_event : Ev.event_base -> ?ev:Ev.event -> ?timeout:float -> Unix.file_descr -> Ev.event_flags list -> (Ev.event -> Unix.file_descr -> Ev.event_flags -> unit) -> Ev.event

Create a new event or use the provided ev and make it persistent with the infinite timeout (or use the provided timeout). Schedule this event with provided callback f. Don't forget del to unschedule.

Sourceval setup_simple_event : Ev.event_base -> ?ev:Ev.event -> ?timeout:float -> Unix.file_descr -> Ev.event_flags list -> (Ev.event -> Unix.file_descr -> Ev.event_flags -> unit) -> unit
Sourcetype result =
  1. | End
  2. | Data of int
  3. | Block
  4. | Exn of exn
Sourceval read_some : Unix.file_descr -> bytes -> int -> int -> result
Sourceval write_some : Unix.file_descr -> string -> int -> int -> int
Sourceval read_available : limit:int -> Unix.file_descr -> [> `Chunk of string * bool | `Limit of string ]

Read out all immediately available input (no blocking)

  • returns

    `Limit when limit is exceeded, `Chunk (data,final) otherwise

Sourceval show_error : [< `Eof | `EofImm | `Exn of exn | `ExnImm of exn | `Timeout ] -> string
Sourceval read_buf : Ev.event_base -> ?ev:Ev.event -> ?timeout:float -> bytes -> Unix.file_descr -> ([> `Eof | `EofImm | `Exn of exn | `ExnImm of exn | `Timeout ] -> int -> unit) -> (bytes -> unit) -> unit

read_buf buf fd err k - asynchronously fill buf with data from fd and call k buf when done (buffer is full). fd should be nonblocking. Call err on error (EOF).

Sourceval read_n : Ev.event_base -> ?ev:Ev.event -> ?timeout:float -> int -> Unix.file_descr -> ([> `Eof | `EofImm | `Exn of exn | `ExnImm of exn | `Timeout ] -> int -> unit) -> (string -> unit) -> unit
Sourceval periodic_timer_0 : Ev.event_base -> bool ref -> float -> float -> ?name:string -> (unit -> unit) -> Ev.event

Call f with delay-second pauses between invocations. Set stop to true to stop the timer. NB do not Ev.del the event inside the f callback.

Sourceval periodic_timer_now : Ev.event_base -> ?stop:bool ref -> float -> ?name:string -> (unit -> unit) -> Ev.event
Sourceval periodic_timer_wait : Ev.event_base -> ?stop:bool ref -> float -> ?name:string -> (unit -> unit) -> Ev.event
Sourceval setup_periodic_timer_now : Ev.event_base -> ?stop:bool ref -> float -> ?name:string -> (unit -> unit) -> unit
Sourceval setup_periodic_timer_wait : Ev.event_base -> ?stop:bool ref -> float -> ?name:string -> (unit -> unit) -> unit
Sourcemodule Peer : sig ... end
Sourceval delay : Ev.event_base -> float -> ('a -> unit) -> 'a -> unit
Sourceval poll : Ev.event_base -> unit