Package async_unix v0.9.0

async_unix

Async_unix
Async_unix__Assign_try_with_log_exnThis module is internal to Async. It is included in std.ml so that any code that uses Async_unix.Std does the top-level side effect in this module to assign Async_kernel.Monitor0.try_with_log_exn.
Async_unix__Async_printNon-blocking, Async-friendly print functions
Async_unix__Async_sysThis module overrides everything in the Sys module that might block. Functions do the same thing as their counterparts in Sys, but instead return deferreds. For a description of their semantics see the documentation for the Sys module.
Async_unix__Busy_pollersA set of busy-poll functions.
Async_unix__Clock
Async_unix__Config
Async_unix__Dump_core_on_job_delayDump core if jobs are delayed, to get additional debug information when running on UNIX systems that support core dumps.
Async_unix__Epoll_file_descr_watcher
Async_unix__FdAn 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. Since Async uses multiple threads to make read/write and other system calls on file descriptors, and Unix reuses descriptors after they are closed, Async has to be very careful that the file descriptor passed to a system call is referring to the file it intends, and not some other completely unrelated file that Unix has decided to assign to the same descriptor.
Async_unix__Fd_by_descrFd_by_descr is a table of the open Fd.ts, indexed by file descriptor number.
Async_unix__Fd_tests
Async_unix__File_descr_watcher_intfFile_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.
Async_unix__Import
Async_unix__In_threadThe In_thread module has functions for interaction between the Async world and other (kernel) threads. The name is to remind us to think about threads and race conditions.
Async_unix__InterruptorAn interruptor provides a file descriptor that can be used to cause a file-descr-watcher to detect the file descriptor is ready for reading. We use an interruptor when a thread needs the Async scheduler to service a request.
Async_unix__Io_stats
Async_unix__Log
Async_unix__Process
Async_unix__Raw_fd
Async_unix__Raw_scheduler
Async_unix__Raw_signal_manager
Async_unix__Read_writeRead_write is like Dirpair, except "buy/sell" has been changed to "read/write".
Async_unix__ReaderReader is Async's main API for buffered input from a file descriptor. It is the analog of Core.In_channel.
Async_unix__Reader0
Async_unix__Require_explicit_time_source
Async_unix__Require_explicit_time_source_intfDeprecates functions that use wall-clock time, so that code must be explicit about what time source is used. Idiomatic usage is:
Async_unix__SchedulerThreading model:
Async_unix__Select_file_descr_watcher
Async_unix__Shutdown
Async_unix__Signal
Async_unix__Signal_managerA signal manager keeps track of a set of signals to be managed and the signal handlers for them. When a signal manager is managing a signal, it installs its own OCaml handler for that signal that records delivery of the signal. It then later, upon request, will deliver the signal to all its handlers.
Async_unix__Std
Async_unix__SyscallAutomatically retrying system calls that may be interrupted with EINTR.
Async_unix__Thread_poolA thread pool is a set of OCaml threads used to do work, where each piece of work is simply a thunk. One creates a thread pool, and then uses add_work to submit work to it. Work is done first-come-first-served by available threads in the pool. Any of the available threads in the pool could be used to do work submitted to the pool (except helper threads, see below).
Async_unix__Thread_safeThe Thread_safe module has functions that are safe to call from threads outside Async.
Async_unix__Thread_safe_ivarA simple thread-safe ivar implementation.
Async_unix__Thread_safe_pipeA thread-safe pipe is a thread-safe interface to the write end of a normal Async.Pipe. All operations except for create must be called from threads outside Async. create can be called from inside or outside Async.
Async_unix__Time_source_tests
Async_unix__Unix_syscallsUnix_syscalls provides an interface to many of the functions in OCaml's standard Unix module. It uses a deferred in the return type of functions that would block. The idea is that in an Async program one does not use the standard Unix module, since in doing so one could accidentally block the whole program.
Async_unix__Unix_syscalls_tests
Async_unix__Writer
Async_unix__Writer0

Info

authors
  • Jane Street Group, LLC <opensource@janestreet.com>
change log
deps
homepage
issues
licenses
  • Apache-2.0
licenses
maintainers
  • opensource@janestreet.com
versionv0.9.0