Index of modules

Non-blocking, Async-friendly print functions

This module overrides everything in the Sys module that might block.

thread_safe_check t pre ~timeout checks the file descriptors for their status and returns when at least one is available, or the timeout passes.

Returns the underlying epoll value.

An Fd.t is a wrapper around a Unix file descriptor, with additional information about the kind of file descriptor and logic to ensure that we don't use a file descriptor that has been closed, or close a file descriptor that is in use.

Fd_by_descr is a table of the open Fd.ts, indexed by file descriptor number.

File_descr_watcher_intf.S provides an API for for watching a set of file descriptors to see if they are ready for reading or writing.

Structure of entries in the groups database.

The In_thread module has functions for interaction between the Async world and other (kernel) threads.

An interruptor provides a file descriptor that can be used to cause a file-descr-watcher to detect the file descriptor is ready for reading.

wait t closes stdin t and then begins collecting the output produced on t's stdout and stderr, continuing to collect output until t terminates.

Structure of entries in the passwd database.

pre_check t does whatever non-thread-safe work is necessary to prepare for the system call that checks file descriptors being ready for read or write.

Async.Process is for creating child processes of the current process, and communicating with children via their stdin, stdout, and stderr.

Read_write is like Dirpair, except "buy/sell" has been changed to "read/write".

Reader is Async's main API for buffered input from a file descriptor.

Threading model:

shutdown ?force status initiates shutdown, which runs all the at_shutdown functions, waits for them to finish, and then exits with the supplied status.

We override values from Core.Std.Signal that we don't want people to use with Async.

A signal manager keeps track of a set of signals to be managed and the signal handlers for them.

A thread pool is a set of OCaml threads used to do work, where each piece of work is simply a thunk.

The Thread_safe module has functions that are safe to call from threads outside async.

A thread-safe pipe is a thread-safe interface to the write end of a normal Async.Pipe.

Unix_syscalls provides an interface to many of the functions in OCaml's standard Unix module.

Writer is Async's main API for output to a file descriptor.