package async_unix

  1. Overview
  2. Docs
Module type
Class type
type t

A file-descr-watcher is essentially a map from File_descr.t to bool Read_write_pair.t, which defines the set of file descriptors being watched, and for each file descriptor, whether it is being watched for read, write, or both. If a file descriptor is not being watched for either, it is not in the map.

val sexp_of_t : t -> Sexplib0.Sexp.t
include Async_kernel.Invariant.S with type t := t
val invariant : t -> unit
type 'a additional_create_args = handle_fd_read_bad:(Core_unix.File_descr.t -> unit) -> handle_fd_write_bad:(Core_unix.File_descr.t -> unit) -> 'a

additional_create_args abstracts over the additional arguments to different file-descr-watcher's create function.

val create : (num_file_descrs:int -> handle_fd_read_ready:(Core_unix.File_descr.t -> unit) -> handle_fd_write_ready:(Core_unix.File_descr.t -> unit) -> t) additional_create_args

create ~num_file_descrs creates a new file-descr-watcher that is able to watch file descriptors in

[0, num_file_descrs) 


val set : t -> Core_unix.File_descr.t -> bool Read_write_pair.t -> [ `Ok | `Unsupported ]

set alters the map of file descriptors being watched. It will take effect on the next call to thread_safe_check. Calling set fd with { read = false, write = false } removes fd from the map. `Unsupported can be returned for file descriptors that do not support polling. This usually (always?) means that they are always ready for read or write.

val iter : t -> f:(Core_unix.File_descr.t -> Read_write_pair.Key.t -> unit) -> unit

iter t ~f iterates over every file descriptor in the map, apply f to it once for each of {`Read,`Write} that it is being watched for.

module Pre : sig ... end

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. pre_check does not side effect t.

val pre_check : t -> Pre.t
module Check_result : sig ... end

thread_safe_check t pre timeout span_or_unit checks the file descriptors for their status and returns when at least one is available, or the timeout, span_or_unit passes. thread_safe_check does not side effect t. Unlike the rest of the functions in this module, thread_safe_check is thread safe.

val thread_safe_check : t -> Pre.t -> 'a Async_unix__.File_descr_watcher_intf.Timeout.t -> 'a -> Check_result.t
val post_check : t -> Check_result.t -> unit

post_check t check_result calls the handle_fd* functions supplied to create:

1. for each file descriptor that is ready to be written to, then 2. for each file descriptor that is ready to be read from.

We handle writes before reads so that we get all the writes started going to the external world before we process all the reads. This will nicely batch together all the output based on the reads for the next writes.

It is guaranteed that it calls handle_fd_read* only on an fd that is watched for read as per set, and handle_fd_write* only on an fd that is watched for write as per set.

val reset_in_forked_process : t -> unit

Innovation. Community. Security.