Module Funix

Fiber friendly Unix functions.

Clients of these functions need to be run in a Fiber.run function called with Funix.unblock.

Fiber unblocking

val unblock : Fiber.unblock

unblock is the function to unblock fibers blocked by the function of this module. You must use this function with Fiber.run.

Signals

module Signal : sig ... end

Signals

Sleeping

val sleep_s : float -> unit

sleep_s dur suspends the fiber for dur seconds.

File descriptors operations

If the file descriptor is in non-blocking mode, these functions block the fiber, not the domain thread.

val read : Unix.file_descr -> bytes -> start:int -> len:int -> bool

read fd b ~start ~len reads len bytes from fd into b starting at start and returns true. Returns false if len bytes could not be read (i.e. end of file/stream was hit). The function handles signal interruptions (EINTR) by retrying.

val write : Unix.file_descr -> bytes -> start:int -> len:int -> unit

write fd b ~start ~len writes len bytes starting at start from b on fd. The function handles signal interruptions (EINTR) by retrying.

val accept : ?cloexec:bool -> Unix.file_descr -> Unix.file_descr * Unix.sockaddr

accept fd is a fiber friendly Unix.accept which returns file descriptors is in non-blocking mode. The function handles signal interruptions (EINTR) by retrying.

val connect : Unix.file_descr -> Unix.sockaddr -> unit

connect fd addr is a fiber friendly Unix.connect. The function handles signal interruptions (EINTR) by retrying.

val close_noerr : Unix.file_descr -> unit

close_noerr fd closes fd and ignores any error. Useful for Fun.protect finally functions which must not raise.

Socket endpoints

type endpoint = [
  1. | `Host of string * int
    (*

    Hostname and port.

    *)
  2. | `Sockaddr of Unix.sockaddr
    (*

    Given socket address.

    *)
  3. | `Fd of Unix.file_descr
    (*

    Direct file descriptor.

    *)
]

The type for specifying a socket endpoint to connect to or to listen to on.

val endpoint_of_string : default_port:int -> string -> (endpoint, string) Stdlib.result

connection_of_string ~default_port s parses a connection specification from s. The format is ADDR[:PORT] or PATH for a Unix domain socket (detected by the the presence of a directory separator). default_port port is used if no PORT is specified.

val pp_endpoint : Stdlib.Format.formatter -> endpoint -> unit

pp_socket_endpoint formats an unspecified representation of endpoint values.

val socket_of_endpoint : endpoint -> Unix.socket_type -> (Unix.sockaddr option * Unix.file_descr * bool, string) Stdlib.result

socket_of_endpoint c is Ok (addr, fd, close) with:

  • addr, the address for the socket, if any.
  • fd, the file descriptor for the socket. If c is `Fd fd this fd untouched. Otherwise fd is a new file descriptor set to non-blocking mode and has close on exec set to true.
  • close is true if the caller is in charge of closing it. This is false iff c is `Fd _.