mte/unikernel/duniverse/mirage-unix/lib/lifecycle.mli
2025-11-11 02:07:51 +01:00

26 lines
1.2 KiB
OCaml

(*
* Copyright (c) 2015 Thomas Leonard <talex5@gmail.com>
*
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*)
val await_shutdown_request :
?can_poweroff:bool ->
?can_reboot:bool ->
unit -> [`Poweroff | `Reboot] Lwt.t
(** [await_shutdown_request ()] is thread that resolves when the domain is
asked to shut down.
The optional [poweroff] (default:[true]) and [reboot] (default:[false])
arguments can be used to indicate which features the caller wants to
advertise (however, you can still get a request for a mode you didn't claim
to support). *)