<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="Async_print" rel="Chapter" href="Async_print.html">
<link title="Async_sys" rel="Chapter" href="Async_sys.html">
<link title="Epoll_file_descr_watcher" rel="Chapter" href="Epoll_file_descr_watcher.html">
<link title="Fd" rel="Chapter" href="Fd.html">
<link title="Fd_by_descr" rel="Chapter" href="Fd_by_descr.html">
<link title="File_descr_watcher_intf" rel="Chapter" href="File_descr_watcher_intf.html">
<link title="Import" rel="Chapter" href="Import.html">
<link title="Interruptor" rel="Chapter" href="Interruptor.html">
<link title="In_thread" rel="Chapter" href="In_thread.html">
<link title="Io_stats" rel="Chapter" href="Io_stats.html">
<link title="Process" rel="Chapter" href="Process.html">
<link title="Raw_fd" rel="Chapter" href="Raw_fd.html">
<link title="Raw_scheduler" rel="Chapter" href="Raw_scheduler.html">
<link title="Raw_signal_manager" rel="Chapter" href="Raw_signal_manager.html">
<link title="Reader" rel="Chapter" href="Reader.html">
<link title="Read_write" rel="Chapter" href="Read_write.html">
<link title="Scheduler" rel="Chapter" href="Scheduler.html">
<link title="Select_file_descr_watcher" rel="Chapter" href="Select_file_descr_watcher.html">
<link title="Shutdown" rel="Chapter" href="Shutdown.html">
<link title="Signal" rel="Chapter" href="Signal.html">
<link title="Signal_manager" rel="Chapter" href="Signal_manager.html">
<link title="Std" rel="Chapter" href="Std.html">
<link title="Syscall" rel="Chapter" href="Syscall.html">
<link title="Thread_pool" rel="Chapter" href="Thread_pool.html">
<link title="Thread_safe" rel="Chapter" href="Thread_safe.html">
<link title="Thread_safe_pipe" rel="Chapter" href="Thread_safe_pipe.html">
<link title="Unix_syscalls" rel="Chapter" href="Unix_syscalls.html">
<link title="Writer" rel="Chapter" href="Writer.html"><title>Index of modules</title>
</head>
<body>
<div class="navbar"> <a class="up" href="index.html" title="Index">Up</a>
</div>
<h1>Index of modules</h1>
<table>
<tr><td align="left"><br>A</td></tr>
<tr><td><a href="Unix_syscalls.Socket.Address.html">Address</a> [<a href="Unix_syscalls.Socket.html">Unix_syscalls.Socket</a>]</td>
<td></td></tr>
<tr><td><a href="Async_print.html">Async_print</a> </td>
<td><div class="info">
Non-blocking, Async-friendly print functions
</div>
</td></tr>
<tr><td><a href="Async_sys.html">Async_sys</a> </td>
<td><div class="info">
This module overrides everything in the <code class="code">Sys</code> module that might block.
</div>
</td></tr>
<tr><td align="left"><br>C</td></tr>
<tr><td><a href="File_descr_watcher_intf.S.Check_result.html">Check_result</a> [<a href="File_descr_watcher_intf.S.html">File_descr_watcher_intf.S</a>]</td>
<td><div class="info">
<code class="code">thread_safe_check t pre ~timeout</code> checks the file descriptors for their status and
returns when at least one is available, or the <code class="code">timeout</code> passes.
</div>
</td></tr>
<tr><td><a href="Import.Config.html">Config</a> [<a href="Import.html">Import</a>]</td>
<td></td></tr>
<tr><td><a href="Raw_scheduler.Core_scheduler.html">Core_scheduler</a> [<a href="Raw_scheduler.html">Raw_scheduler</a>]</td>
<td></td></tr>
<tr><td align="left"><br>D</td></tr>
<tr><td><a href="Import.Debug.html">Debug</a> [<a href="Import.html">Import</a>]</td>
<td></td></tr>
<tr><td><a href="Unix_syscalls.Group.Fields.Direct.html">Direct</a> [<a href="Unix_syscalls.Group.Fields.html">Unix_syscalls.Group.Fields</a>]</td>
<td></td></tr>
<tr><td><a href="Unix_syscalls.Passwd.Fields.Direct.html">Direct</a> [<a href="Unix_syscalls.Passwd.Fields.html">Unix_syscalls.Passwd.Fields</a>]</td>
<td></td></tr>
<tr><td><a href="Unix_syscalls.Stats.Fields.Direct.html">Direct</a> [<a href="Unix_syscalls.Stats.Fields.html">Unix_syscalls.Stats.Fields</a>]</td>
<td></td></tr>
<tr><td><a href="Raw_scheduler.Fields.Direct.html">Direct</a> [<a href="Raw_scheduler.Fields.html">Raw_scheduler.Fields</a>]</td>
<td></td></tr>
<tr><td><a href="Raw_fd.T.Fields.Direct.html">Direct</a> [<a href="Raw_fd.T.Fields.html">Raw_fd.T.Fields</a>]</td>
<td></td></tr>
<tr><td align="left"><br>E</td></tr>
<tr><td><a href="Epoll_file_descr_watcher.html">Epoll_file_descr_watcher</a> </td>
<td><div class="info">
Returns the underlying epoll value.
</div>
</td></tr>
<tr><td><a href="Unix_syscalls.Exit.html">Exit</a> [<a href="Unix_syscalls.html">Unix_syscalls</a>]</td>
<td></td></tr>
<tr><td><a href="Unix_syscalls.Exit_or_signal.html">Exit_or_signal</a> [<a href="Unix_syscalls.html">Unix_syscalls</a>]</td>
<td></td></tr>
<tr><td><a href="Unix_syscalls.Exit_or_signal_or_stop.html">Exit_or_signal_or_stop</a> [<a href="Unix_syscalls.html">Unix_syscalls</a>]</td>
<td></td></tr>
<tr><td><a href="Read_write.Export.html">Export</a> [<a href="Read_write.html">Read_write</a>]</td>
<td></td></tr>
<tr><td align="left"><br>F</td></tr>
<tr><td><a href="Unix_syscalls.Socket.Family.html">Family</a> [<a href="Unix_syscalls.Socket.html">Unix_syscalls.Socket</a>]</td>
<td></td></tr>
<tr><td><a href="Std.Unix.Fd.html">Fd</a> [<a href="Std.Unix.html">Std.Unix</a>]</td>
<td></td></tr>
<tr><td><a href="Std.Fd.html">Fd</a> [<a href="Std.html">Std</a>]</td>
<td></td></tr>
<tr><td><a href="Raw_scheduler.Fd.html">Fd</a> [<a href="Raw_scheduler.html">Raw_scheduler</a>]</td>
<td></td></tr>
<tr><td><a href="Fd.html">Fd</a> </td>
<td><div class="info">
An <code class="code">Fd.t</code> 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.
</div>
</td></tr>
<tr><td><a href="Fd_by_descr.html">Fd_by_descr</a> </td>
<td><div class="info">
<code class="code">Fd_by_descr</code> is a table of the open <code class="code">Fd.t</code>s, indexed by file descriptor number.
</div>
</td></tr>
<tr><td><a href="Unix_syscalls.Group.Fields.html">Fields</a> [<a href="Unix_syscalls.Group.html">Unix_syscalls.Group</a>]</td>
<td></td></tr>
<tr><td><a href="Unix_syscalls.Passwd.Fields.html">Fields</a> [<a href="Unix_syscalls.Passwd.html">Unix_syscalls.Passwd</a>]</td>
<td></td></tr>
<tr><td><a href="Unix_syscalls.Stats.Fields.html">Fields</a> [<a href="Unix_syscalls.Stats.html">Unix_syscalls.Stats</a>]</td>
<td></td></tr>
<tr><td><a href="Raw_scheduler.Fields.html">Fields</a> [<a href="Raw_scheduler.html">Raw_scheduler</a>]</td>
<td></td></tr>
<tr><td><a href="Raw_fd.T.Fields.html">Fields</a> [<a href="Raw_fd.T.html">Raw_fd.T</a>]</td>
<td></td></tr>
<tr><td><a href="Raw_fd.File_descr.html">File_descr</a> [<a href="Raw_fd.html">Raw_fd</a>]</td>
<td></td></tr>
<tr><td><a href="Import.File_descr.html">File_descr</a> [<a href="Import.html">Import</a>]</td>
<td></td></tr>
<tr><td><a href="Raw_scheduler.File_descr_watcher.html">File_descr_watcher</a> [<a href="Raw_scheduler.html">Raw_scheduler</a>]</td>
<td></td></tr>
<tr><td><a href="File_descr_watcher_intf.html">File_descr_watcher_intf</a> </td>
<td><div class="info">
<code class="code">File_descr_watcher_intf.S</code> provides an API for for watching a set of file descriptors
to see if they are ready for reading or writing.
</div>
</td></tr>
<tr><td><a href="Unix_syscalls.File_kind.html">File_kind</a> [<a href="Unix_syscalls.html">Unix_syscalls</a>]</td>
<td></td></tr>
<tr><td align="left"><br>G</td></tr>
<tr><td><a href="Unix_syscalls.Group.html">Group</a> [<a href="Unix_syscalls.html">Unix_syscalls</a>]</td>
<td><div class="info">
Structure of entries in the <code class="code">groups</code> database.
</div>
</td></tr>
<tr><td align="left"><br>H</td></tr>
<tr><td><a href="Raw_signal_manager.Handler.html">Handler</a> [<a href="Raw_signal_manager.html">Raw_signal_manager</a>]</td>
<td></td></tr>
<tr><td><a href="Raw_signal_manager.Handlers.html">Handlers</a> [<a href="Raw_signal_manager.html">Raw_signal_manager</a>]</td>
<td></td></tr>
<tr><td><a href="Thread_pool.Helper_thread.html">Helper_thread</a> [<a href="Thread_pool.html">Thread_pool</a>]</td>
<td></td></tr>
<tr><td><a href="In_thread.Helper_thread.html">Helper_thread</a> [<a href="In_thread.html">In_thread</a>]</td>
<td></td></tr>
<tr><td><a href="Unix_syscalls.Host.html">Host</a> [<a href="Unix_syscalls.html">Unix_syscalls</a>]</td>
<td></td></tr>
<tr><td align="left"><br>I</td></tr>
<tr><td><a href="Writer.Id.html">Id</a> [<a href="Writer.html">Writer</a>]</td>
<td></td></tr>
<tr><td><a href="Reader.Id.html">Id</a> [<a href="Reader.html">Reader</a>]</td>
<td></td></tr>
<tr><td><a href="Read_write.Immutable.html">Immutable</a> [<a href="Read_write.html">Read_write</a>]</td>
<td></td></tr>
<tr><td><a href="Import.html">Import</a> </td>
<td></td></tr>
<tr><td><a href="Std.In_thread.html">In_thread</a> [<a href="Std.html">Std</a>]</td>
<td></td></tr>
<tr><td><a href="In_thread.html">In_thread</a> </td>
<td><div class="info">
The <code class="code">In_thread</code> module has functions for interaction between the Async world and other
(kernel) threads.
</div>
</td></tr>
<tr><td><a href="Unix_syscalls.Socket.Address.Inet.html">Inet</a> [<a href="Unix_syscalls.Socket.Address.html">Unix_syscalls.Socket.Address</a>]</td>
<td></td></tr>
<tr><td><a href="Unix_syscalls.Inet_addr.html">Inet_addr</a> [<a href="Unix_syscalls.html">Unix_syscalls</a>]</td>
<td></td></tr>
<tr><td><a href="Interruptor.html">Interruptor</a> </td>
<td><div class="info">
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.
</div>
</td></tr>
<tr><td><a href="Std.Io_stats.html">Io_stats</a> [<a href="Std.html">Std</a>]</td>
<td></td></tr>
<tr><td><a href="Io_stats.html">Io_stats</a> </td>
<td></td></tr>
<tr><td align="left"><br>K</td></tr>
<tr><td><a href="Read_write.Key.html">Key</a> [<a href="Read_write.html">Read_write</a>]</td>
<td></td></tr>
<tr><td><a href="Raw_fd.Kind.html">Kind</a> [<a href="Raw_fd.html">Raw_fd</a>]</td>
<td></td></tr>
<tr><td><a href="Fd.Kind.html">Kind</a> [<a href="Fd.html">Fd</a>]</td>
<td></td></tr>
<tr><td align="left"><br>M</td></tr>
<tr><td><a href="Read_write.Mutable.html">Mutable</a> [<a href="Read_write.html">Read_write</a>]</td>
<td></td></tr>
<tr><td align="left"><br>O</td></tr>
<tr><td><a href="Unix_syscalls.Open_flags.html">Open_flags</a> [<a href="Unix_syscalls.html">Unix_syscalls</a>]</td>
<td></td></tr>
<tr><td><a href="Unix_syscalls.Socket.Opt.html">Opt</a> [<a href="Unix_syscalls.Socket.html">Unix_syscalls.Socket</a>]</td>
<td></td></tr>
<tr><td><a href="Process.Output.html">Output</a> [<a href="Process.html">Process</a>]</td>
<td><div class="info">
<code class="code">wait t</code> closes <code class="code">stdin t</code> and then begins collecting the output produced on <code class="code">t</code>'s
<code class="code">stdout</code> and <code class="code">stderr</code>, continuing to collect output until <code class="code">t</code> terminates.
</div>
</td></tr>
<tr><td align="left"><br>P</td></tr>
<tr><td><a href="Unix_syscalls.Passwd.html">Passwd</a> [<a href="Unix_syscalls.html">Unix_syscalls</a>]</td>
<td><div class="info">
Structure of entries in the <code class="code">passwd</code> database.
</div>
</td></tr>
<tr><td><a href="File_descr_watcher_intf.Post.html">Post</a> [<a href="File_descr_watcher_intf.html">File_descr_watcher_intf</a>]</td>
<td></td></tr>
<tr><td><a href="File_descr_watcher_intf.S.Pre.html">Pre</a> [<a href="File_descr_watcher_intf.S.html">File_descr_watcher_intf.S</a>]</td>
<td><div class="info">
<code class="code">pre_check t</code> does whatever non-thread-safe work is necessary to prepare for the
system call that checks file descriptors being ready for read or write.
</div>
</td></tr>
<tr><td><a href="Std.Print.html">Print</a> [<a href="Std.html">Std</a>]</td>
<td></td></tr>
<tr><td><a href="Thread_pool.Priority.html">Priority</a> [<a href="Thread_pool.html">Thread_pool</a>]</td>
<td></td></tr>
<tr><td><a href="In_thread.Priority.html">Priority</a> [<a href="In_thread.html">In_thread</a>]</td>
<td></td></tr>
<tr><td><a href="Std.Process.html">Process</a> [<a href="Std.html">Std</a>]</td>
<td></td></tr>
<tr><td><a href="Process.html">Process</a> </td>
<td><div class="info">
<code class="code">Async.Process</code> is for creating child processes of the current process, and
communicating with children via their stdin, stdout, and stderr.
</div>
</td></tr>
<tr><td><a href="Unix_syscalls.Protocol_family.html">Protocol_family</a> [<a href="Unix_syscalls.html">Unix_syscalls</a>]</td>
<td></td></tr>
<tr><td align="left"><br>R</td></tr>
<tr><td><a href="Raw_fd.html">Raw_fd</a> </td>
<td></td></tr>
<tr><td><a href="Raw_scheduler.html">Raw_scheduler</a> </td>
<td></td></tr>
<tr><td><a href="Raw_signal_manager.html">Raw_signal_manager</a> </td>
<td></td></tr>
<tr><td><a href="Read_write.Read_only.html">Read_only</a> [<a href="Read_write.html">Read_write</a>]</td>
<td></td></tr>
<tr><td><a href="Reader.Read_result.html">Read_result</a> [<a href="Reader.html">Reader</a>]</td>
<td></td></tr>
<tr><td><a href="Read_write.html">Read_write</a> </td>
<td><div class="info">
<code class="code">Read_write</code> is like <code class="code">Dirpair</code>, except "buy/sell" has been changed to "read/write".
</div>
</td></tr>
<tr><td><a href="Std.Reader.html">Reader</a> [<a href="Std.html">Std</a>]</td>
<td></td></tr>
<tr><td><a href="Reader.html">Reader</a> </td>
<td><div class="info">
<code class="code">Reader</code> is Async's main API for buffered input from a file descriptor.
</div>
</td></tr>
<tr><td align="left"><br>S</td></tr>
<tr><td><a href="Std.Scheduler.html">Scheduler</a> [<a href="Std.html">Std</a>]</td>
<td></td></tr>
<tr><td><a href="Scheduler.html">Scheduler</a> </td>
<td><div class="info">
Threading model:
</div>
</td></tr>
<tr><td><a href="Select_file_descr_watcher.html">Select_file_descr_watcher</a> </td>
<td></td></tr>
<tr><td><a href="Std.Shutdown.html">Shutdown</a> [<a href="Std.html">Std</a>]</td>
<td></td></tr>
<tr><td><a href="Shutdown.html">Shutdown</a> </td>
<td><div class="info">
<code class="code">shutdown ?force status</code> initiates shutdown, which runs all the <code class="code">at_shutdown</code>
functions, waits for them to finish, and then exits with the supplied status.
</div>
</td></tr>
<tr><td><a href="Std.Signal.html">Signal</a> [<a href="Std.html">Std</a>]</td>
<td></td></tr>
<tr><td><a href="Signal.html">Signal</a> </td>
<td><div class="info">
We override values from <code class="code">Core.Std.Signal</code> that we don't want people to use with
Async.
</div>
</td></tr>
<tr><td><a href="Raw_signal_manager.Signal.html">Signal</a> [<a href="Raw_signal_manager.html">Raw_signal_manager</a>]</td>
<td></td></tr>
<tr><td><a href="Raw_scheduler.Signal.html">Signal</a> [<a href="Raw_scheduler.html">Raw_scheduler</a>]</td>
<td></td></tr>
<tr><td><a href="Signal_manager.html">Signal_manager</a> </td>
<td><div class="info">
A signal manager keeps track of a set of signals to be managed and the signal handlers
for them.
</div>
</td></tr>
<tr><td><a href="Unix_syscalls.Socket.html">Socket</a> [<a href="Unix_syscalls.html">Unix_syscalls</a>]</td>
<td></td></tr>
<tr><td><a href="Std.Socket.html">Socket</a> [<a href="Std.html">Std</a>]</td>
<td></td></tr>
<tr><td><a href="Raw_fd.State.html">State</a> [<a href="Raw_fd.html">Raw_fd</a>]</td>
<td></td></tr>
<tr><td><a href="Unix_syscalls.Stats.html">Stats</a> [<a href="Unix_syscalls.html">Unix_syscalls</a>]</td>
<td></td></tr>
<tr><td><a href="Std.html">Std</a> </td>
<td></td></tr>
<tr><td><a href="Std.Sys.html">Sys</a> [<a href="Std.html">Std</a>]</td>
<td></td></tr>
<tr><td><a href="Syscall.html">Syscall</a> </td>
<td></td></tr>
<tr><td align="left"><br>T</td></tr>
<tr><td><a href="Raw_fd.T.html">T</a> [<a href="Raw_fd.html">Raw_fd</a>]</td>
<td></td></tr>
<tr><td><a href="Unix_syscalls.Terminal_io.html">Terminal_io</a> [<a href="Unix_syscalls.html">Unix_syscalls</a>]</td>
<td></td></tr>
<tr><td><a href="Thread_pool.html">Thread_pool</a> </td>
<td><div class="info">
A thread pool is a set of OCaml threads used to do work, where each piece of work is
simply a thunk.
</div>
</td></tr>
<tr><td><a href="Thread_safe.html">Thread_safe</a> </td>
<td><div class="info">
The <code class="code">Thread_safe</code> module has functions that are safe to call from threads outside
async.
</div>
</td></tr>
<tr><td><a href="Std.Thread_safe.html">Thread_safe</a> [<a href="Std.html">Std</a>]</td>
<td></td></tr>
<tr><td><a href="Thread_safe_pipe.html">Thread_safe_pipe</a> </td>
<td><div class="info">
A thread-safe pipe is a thread-safe interface to the write end of a normal
<code class="code">Async.Pipe</code>.
</div>
</td></tr>
<tr><td><a href="Std.Thread_safe_pipe.html">Thread_safe_pipe</a> [<a href="Std.html">Std</a>]</td>
<td></td></tr>
<tr><td><a href="File_descr_watcher_intf.Timeout.html">Timeout</a> [<a href="File_descr_watcher_intf.html">File_descr_watcher_intf</a>]</td>
<td></td></tr>
<tr><td><a href="Raw_scheduler.Timerfd.html">Timerfd</a> [<a href="Raw_scheduler.html">Raw_scheduler</a>]</td>
<td></td></tr>
<tr><td><a href="Unix_syscalls.Socket.Type.html">Type</a> [<a href="Unix_syscalls.Socket.html">Unix_syscalls.Socket</a>]</td>
<td></td></tr>
<tr><td align="left"><br>U</td></tr>
<tr><td><a href="Std.Unix.html">Unix</a> [<a href="Std.html">Std</a>]</td>
<td></td></tr>
<tr><td><a href="Unix_syscalls.Socket.Address.Unix.html">Unix</a> [<a href="Unix_syscalls.Socket.Address.html">Unix_syscalls.Socket.Address</a>]</td>
<td></td></tr>
<tr><td><a href="Unix_syscalls.html">Unix_syscalls</a> </td>
<td><div class="info">
<code class="code">Unix_syscalls</code> provides an interface to many of the functions in OCaml's standard
Unix module.
</div>
</td></tr>
<tr><td align="left"><br>W</td></tr>
<tr><td><a href="Raw_scheduler.Watching.html">Watching</a> [<a href="Raw_scheduler.html">Raw_scheduler</a>]</td>
<td></td></tr>
<tr><td><a href="Raw_fd.Watching.html">Watching</a> [<a href="Raw_fd.html">Raw_fd</a>]</td>
<td></td></tr>
<tr><td><a href="Writer.html">Writer</a> </td>
<td><div class="info">
<code class="code">Writer</code> is Async's main API for output to a file descriptor.
</div>
</td></tr>
<tr><td><a href="Std.Writer.html">Writer</a> [<a href="Std.html">Std</a>]</td>
<td></td></tr>
</table>
</body>
</html>
