On This Page
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
package mirage-runtime
Mirage run-time utilities.
Release v4.0.0_beta1
Log thresholds
type log_threshold = [ `All | `Src of string ] * Logs.levelThe type for log threshold.
val set_level : default:Logs.level -> log_threshold list -> unitset_level ~default l set the log levels needed to have all of the log sources appearing in l be used.
module Arg : sig ... endinclude module type of Functoria_runtime with module Arg := Arg
module Key : sig ... endKey defines values that can be set by runtime command-line arguments. This module is the runtime companion of Key.
val with_argv : unit Cmdliner.Term.t list -> string -> string array -> unitwith_argv keys name argv evaluates the keys terms on the command-line argv. name is the executable name. On evaluation error the application calls exit(3) with status 64. If `Help or `Version were evaluated, exit(3) is called with status 63.
Registering scheduler hooks
val at_exit : (unit -> unit Lwt.t) -> unitat_exit hook registers hook, which will be executed before the unikernel exits. The first hook registered will be executed last.
at_enter_iter hook registers hook to be executed at the beginning of each event loop iteration. The first hook registered will be executed last.
If hook calls at_enter_iter recursively, the new hook will run only on the next event loop iteration.
at_leave_iter hook registers hook to be executed at the end of each event loop iteration. See at_enter_iter for details.
Running hooks
This is mainly for for developers implementing new targets.
val run_exit_hooks : unit -> unit Lwt.trun_exit_hooks () calls the sequence of hooks registered with at_exit in sequence.
run_enter_iter_hooks () calls the sequence of hooks registered with at_enter_iter in sequence.
run_leave_iter_hooks () call the sequence of hooks registered with at_leave_iter in sequence.
On This Page