package eio

You can search for identifiers within the package.

in-package search v0.2.0

package eio

eio
- Eio
  - Buf_read
    
    Syntax
  - Buf_write
    
    BE
    
    LE
  - Cancel
  - Condition
  - Debug
  - Domain_manager
    
    t
  - Exn
  - Fiber
    
    List
  - File
    
    ro
    
    rw
  - Flow
    
    close
    
    sink
    
    source
    
    two_way
  - Fs
    
    Unix_perm
    
    dir
    
    dir_with_close
  - Generic
    
    t
  - Mutex
  - Net
    
    Ipaddr
    
    V4
    
    V6
    
    Sockaddr
    
    datagram_socket
    
    listening_socket
    
    socket
    
    stream_socket
    
    t
  - Path
  - Private
    
    Ctf
    
    Control
    
    Debug
    
    Effects
    
    Fiber_context
    
    Suspend
    
    Waiters
  - Promise
  - Semaphore
  - Std
  - Stdenv
  - Stream
  - Switch
  - Time
    
    Timeout
    
    clock
eio.mock
- Eio_mock
  - Action
  - Backend
  - Clock
  - Flow
  - Handler
  - Net
eio.unix
- Eio_unix
  - Ctf
  - FD
  - Ipaddr
  - Private
eio.utils
- Eio_utils
  - Lf_queue
  - Suspended
  - Zzz
    
    Key

Legend:
Library
Module
Module type
Parameter
Class
Class type

A set of timers.

module Key : sig ... end

A handle to a registered timer.

type t

A set of timers (implemented as a priority queue).

val create : unit -> t

create () is a fresh empty queue.

val add : t -> float -> unit Suspended.t -> Key.t

add t time thread adds a new event, due at time, and returns its ID. You must use Eio.Private.Fiber_context.set_cancel_fn on thread before calling pop. Your cancel function should call remove (in addition to resuming thread).

val remove : t -> Key.t -> unit

remove t key removes an event previously added with add.

val pop : 
  t ->
  now:float ->
  [ `Due of unit Suspended.t | `Wait_until of float | `Nothing ]

pop ~now t removes and returns the earliest thread due by now. It also clears the thread's cancel function. If no thread is due yet, it returns the time the earliest thread becomes due.