Index of modules

anonymous argument specifications

argument types

add_channel b ic n reads exactly n character from the input channel ic and stores them at the end of buffer b.

String type based on Bigarray, for use in I/O and C-bindings

Utility functions for marshalling to and from bigstring

Blit copies between iobufs and advances neither src nor dst.

Blit_consume copies between iobufs and advances src but does not advance dst.

Blit_consume_and_fill copies between iobufs and advances both src and dst.

Blit_fill copies between iobufs and advances dst but does not advance src.

A calibrator contains a snapshot of machine-specific information that is used to convert between TSC values and clock time.

A representation of CIDR netmasks (e.g.

Clock used to mark the progress of a timer.

purely functional command line parsing

Consume.string t ~len reads len characters (all, by default) from t into a new string and advances the lower bound of the window accordingly.

timedwait cond mtx timeout waits on condition variable cond with mutex mtx until either the condition is signalled, or until timeout expires.

Warning! this library assumes we are in a POSIX compliant OS.

lock mtx locks mtx, possibly waiting for it to be released first by another thread.

System interface.

Lightweight threads.

File descriptor.

Crc functions

This module provides support for daemonizing a process.

This formats a date using the format patterns available in strftime.

converts a string to a date, in formats: m/d/y y-m-d (* valid iso8601_extended *) DD MMM YYYY DDMMMYYYY YYYYMMDD

am, ams, and amf output a source code position and backtrace to stderr.

Deprecated should be used only by Core_extended.Deprecated_command.

epoll() - a linux I/O multiplexer of the same family as select() or poll().

The termination status of a process.

The Expert module contains functions that novice users should avoid, due to their complexity.

expert operations

The Expert module is for building efficient out-of-module Iobuf abstractions.

Types of messages

File descriptor.

Fill.bin_prot X.bin_write_t t x writes x to t in bin-prot form, advancing past the bytes written.

flag specifications

Structure of entries in the groups database.

I/O-vectors for scatter/gather-operations

Module for simple closed intervals over arbitrary types that are ordered correctly using polymorphic compare.

Module for simple closed intervals over arbitrary types that are ordered correctly using polymorphic compare.

A non-moving (in the GC sense) contiguous range of bytes, useful for I/O operations.

We use module type of struct include Iobuf end rather than module type of Iobuf so that the debugging functions work on normal Iobufs.

no_seek and seek are phantom types used in a similar manner to read and read_write.

Intentionally empty.

Implements a token bucket based throttling rate limiter.

Interface to Linux-specific system calls

Mutual exclusion between processes using flock and lockf.

create like Mutex.create, but creates an error-checking mutex.

A nano-mutex is a lightweight mutex that can be used only within a single OCaml runtime.

An implementation neutral NFS lock file scheme that relies on the atomicity of link over NFS (see NFS Illustrated, atomicity for more information).

A time of day along with a time zone.

specification of command parameters

Similar to Time.Span.Parts, but adding ns.

Structure of entries in the passwd database

Peek and Poke functions access a value at pos from the lower bound of the window and do not advance.

Piece-wise linear interpolation from float-like types to float.

create enforces that x (key) values are non-decreasing.

Poke.bin_prot X.bin_write_t t x writes x to the beginning of t in binary form without advancing.

Similar to UnixLabels.open_process, but the second argument specifies the environment passed to the command.

Utility functions for dealing with the environment.

Resource limits

Resource usage -- For details, "man getrusage"

Wait until some input/output operations become possible on some channels.

of_system_int and to_system_int return and take respectively a signal number corresponding to those in the system's /usr/include/bits/signum.h (or equivalent).

Span indicates some integer number of cycles.

Basic operations on spans

older interface for command-line specifications

Thread-safe queue module, using locks.

Note that applications of the following functors are only as stable as Key and Value.

Representation of Unix system call results

This returns a preallocated object for all errors and at least a few ok_values, so can be used in many contexts where avoiding allocation is important.

Send log messages via the Unix Syslog interface.

This signature is deliberately empty.

Implements a basic throttle.

A Throttled_rate_limiter combines a Token_bucket and a Throttle.

A module for representing absolute points in time, independent of time zone.

Pause and don't allow events to interrupt.

An absolute point in time, more efficient and precise than the float-based Time, but representing a narrower range of times.

High-performance timing.

A timing wheel in which time is represented by Time.t, i.e.

Deliberately empty.

Implements a basic token bucket based rate limiter.

Unsafe has submodules that are like their corresponding module, except with no range checks.

A pair of unix username and primary unix group.

Implements universally unique identifiers based on version 3 of the UUID specification.

A hashtable that keeps a weak pointer to each key's data and uses a finalizer to detect when the data is no longer referenced (by any non-weak pointers).

Provides a sexp representation that is independent of the time zone of the machine writing it.

Time-zone handling.