Index of modules


A
Array [Deferred]
Async_condition
Async.Condition is async's implementation of the standard notion of a "condition" variable, and is analogous to OCaml's Condition module.
Async_or_error
Async_stream
For most applications one should use Pipe instead of Stream.

B
Backpatched [Std]
Backpatched
A Backpatched value is either a simple value or a "hole", which may or may not have been filled.

C
Clock [Std]
Clock
Clock includes functions to create deferreds that become determined at a certain time.
Clock_event [Raw_scheduler]
Clock_event
Condition [Std]
Config
Config has various settings that globally affect the behavior of async.
Consumer [Pipe]

D
Debug
Deferred [Std]
Deferred [Ivar]
Deferred [Deferred_intf]
Deferred
A deferred is a value that will become determined asynchronously.
Deferred [Raw_stream]
Deferred [Raw_tail]
Deferred_intf
Deferred_std
Direct [Raw_scheduler.T.Fields]
Direct [Execution_context.Fields]

E
Event [Events]
Event [Clock]
Events provide a way to "abort" at and after requests.
Events
Events is for keeping a set of events that need to happen in the future.
Execution_context [Std]
Execution_context [Import.Basic_scheduler]
Execution_context
Execution_context [Raw_scheduler]
Exported_for_scheduler [Monitor]

F
Fields [Raw_scheduler.T]
Fields [Execution_context]
Fields [Raw_monitor]
File_descr_watcher [Config]
Flushed_result [Pipe]

H
Handler [Std]
Handler
A handler is a continuation that captures the current async execution context.
Handler [Raw_ivar]
Helper_thread [Thread_pool]
Hole [Backpatched]

I
Import
Infix [Deferred]
Inline_tests
Ivar [Std]
Ivar
An ivar is a write-once cell that can be empty or full (i.e.
Ivar [Raw_tail]
Ivar [Raw_scheduler]
Ivar [Raw_clock_event]

J
Job [Throttle]
Job
Jobs
A Jobs.t has a queue of jobs at each priority level.

L
Lazy_deferred [Std]
Lazy_deferred
A Lazy_deferred.t is a delayed computation that can produce a deferred.
List [Deferred]
List [Async_or_error]

M
Map [Deferred]
Monitor [Std]
Monitor
A monitor is a context that determines what to do when there is an unhandled exception.
Monitor [Execution_context]

O
Option [Deferred]
Or_error [Deferred]

P
Pipe [Std]
Pipe
A pipe is a buffered FIFO communication channel.
Pretty [Raw_monitor]
Print_debug_messages_for [Config]
Priority [Std]
Priority
Priority [Jobs]
A Jobs.t has a queue of jobs at each priority level.

Q
Queue [Deferred]

R
Raw_clock_event
Raw_deferred
Raw_handler
Raw_ivar
Raw_monitor
Raw_scheduler
Raw_stream
Raw_tail
Reader [Pipe]
Result [Deferred]

S
Scheduler
Scheduler [Clock_event]
Scheduler_dependent [Raw_deferred]
Scheduler_dependent [Raw_ivar]
Sequencer [Std]
Sequencer [Throttle]
A sequencer is a throttle that is:
Std
Stream [Tail]
Stream [Std]
Stream [Raw_tail]

T
T [Raw_handler]
T [Raw_scheduler]
T [Raw_clock_event]
Tail
A tail is a pointer to the end of a stream that can be used to extend the stream.
Tail [Std]
Tail [Raw_scheduler]
Test
Thread_pool
A thread pool is a set of OCaml threads used to do work, where each piece of work is simply a thunk.
Thread_pool [Std]
Throttle
Throttles for simultaneous computations.
Throttle [Std]

U
Unregister

W
Work_group
Work_group [Thread_pool]
Writer [Pipe]