package core_unix

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
type t

An Epoll.Flags.t is an immutable set of flags for which one can register interest in a file descriptor. It is implemented as a bitmask, and so all operations (+, -, etc.) are constant time with no allocation.

sexp_of_t produces a human-readable list of bits, e.g., "(in out)".

include Flags.S with type t := t
include Sexplib0.Sexpable.S with type t := t
val t_of_sexp : Sexplib0__.Sexp.t -> t
val sexp_of_t : t -> Sexplib0__.Sexp.t
include Typerep_lib.Typerepable.S with type t := t
val typename_of_t : t Typerep_lib.Typename.t

consistent with subset

include Core.Comparable.S with type t := t
include Base.Comparable.S with type t := t
val (>=) : t -> t -> bool
val (<=) : t -> t -> bool
val (=) : t -> t -> bool
val (>) : t -> t -> bool
val (<) : t -> t -> bool
val (<>) : t -> t -> bool
val equal : t -> t -> bool
val compare : t -> t -> int
val min : t -> t -> t
val max : t -> t -> t
val ascending : t -> t -> int
val descending : t -> t -> int
val between : t -> low:t -> high:t -> bool
val clamp_exn : t -> min:t -> max:t -> t
val clamp : t -> min:t -> max:t -> t Base__.Or_error.t
type comparator_witness
val comparator : (t, comparator_witness) Base__Comparator.comparator
val validate_lbound : min:t Core.Maybe_bound.t -> t Validate.check
val validate_ubound : max:t Core.Maybe_bound.t -> t Validate.check
val validate_bound : min:t Core.Maybe_bound.t -> max:t Core.Maybe_bound.t -> t Validate.check
module Replace_polymorphic_compare : sig ... end
val to_flag_list : t -> t * string list
val of_int : int -> t
val to_int_exn : t -> int
val empty : t
val (+) : t -> t -> t

set union, bitwise or

val (-) : t -> t -> t

set difference. Although we use operators + and -, they do not satisfy the usual arithmetic equations, e.g. x - y = x + (empty - y) does not hold.

val intersect : t -> t -> t

bitwise and

val complement : t -> t

bitwise not

val is_empty : t -> bool
val do_intersect : t -> t -> bool
val are_disjoint : t -> t -> bool
val is_subset : t -> of_:t -> bool

is_subset t ~of_ is t = intersect t of_

module Unstable : sig ... end

The names of the flags match the man pages. E.g. in_ = "EPOLLIN", out = "EPOLLOUT", etc.

val none : t

Associated fd is readable

val in_ : t

Associated fd is readable

val out : t

Associated fd is writable

val pri : t

Urgent data available

val err : t

Error condition (always on, no need to set it)

val hup : t

Hang up happened (always on)

val et : t

Edge-Triggered behavior (see man page)

val oneshot : t

One-shot behavior for the associated fd

OCaml

Innovation. Community. Security.