package luv

  1. Overview
  2. Docs
package luv
Legend:
Library
Module
Module type
Parameter
Class
Class type
val uptime : unit -> (float, Error.t) Result.result

Evaluates to the current uptime.

Binds uv_uptime. See sysinfo(2).

val loadavg : unit -> float * float * float

Evaluates to the load average.

Binds uv_loadavg. See sysinfo(2).

val free_memory : unit -> Unsigned.uint64

Evaluates to the amount of free memory, in bytes.

Binds uv_get_free_memory. See sysinfo(2).

val total_memory : unit -> Unsigned.uint64

Evaluates to the total amount of memory, in bytes.

Binds uv_get_total_memory. See sysinfo(2).

val constrained_memory : unit -> Unsigned.uint64 option

Binds http://docs.libuv.org/en/v1.x/misc.html#c.uv_get_constrained_memory.

Requires libuv 1.29.0.

Feature check: Luv.Require.(has get_constrained_memory)

module Priority : sig ... end

Priority constants.

val getpriority : int -> (int, Error.t) Result.result

Evaluates to the priority of the process with the given pid.

Binds uv_os_getpriority. See getpriority(3p).

Requires libuv 1.23.0.

Feature check: Luv.Require.(has os_priority)

val setpriority : int -> int -> (unit, Error.t) Result.result

Sets the priority of the process with the given pid.

Binds uv_os_setpriority. See setpriority(3p).

Requires libuv 1.23.0.

Feature check: Luv.Require.(has os_priority)

val resident_set_memory : unit -> (Unsigned.size_t, Error.t) Result.result

Evaluates to the resident set size for the current process.

Binds uv_resident_set_memory.

type timeval = {
  1. sec : Signed.Long.t;
  2. usec : Signed.Long.t;
}

Binds uv_timeval_t.

type rusage = {
  1. utime : timeval;
  2. stime : timeval;
  3. maxrss : Unsigned.uint64;
  4. ixrss : Unsigned.uint64;
  5. idrss : Unsigned.uint64;
  6. isrss : Unsigned.uint64;
  7. minflt : Unsigned.uint64;
  8. majflt : Unsigned.uint64;
  9. nswap : Unsigned.uint64;
  10. inblock : Unsigned.uint64;
  11. oublock : Unsigned.uint64;
  12. msgsnd : Unsigned.uint64;
  13. msgrcv : Unsigned.uint64;
  14. nsignals : Unsigned.uint64;
  15. nvcsw : Unsigned.uint64;
  16. nivcsw : Unsigned.uint64;
}

Binds uv_rusage_t.

See getrusage(2).

val getrusage : unit -> (rusage, Error.t) Result.result

Binds uv_getrusage.

See getrusage(3p).