worker_types.mli
(*****************************************************************************)
(* *)
(* Open Source License *)
(* Copyright (c) 2018 Dynamic Ledger Solutions, Inc. <contact@tezos.com> *)
(* *)
(* Permission is hereby granted, free of charge, to any person obtaining a *)
(* copy of this software and associated documentation files (the "Software"),*)
(* to deal in the Software without restriction, including without limitation *)
(* the rights to use, copy, modify, merge, publish, distribute, sublicense, *)
(* and/or sell copies of the Software, and to permit persons to whom the *)
(* Software is furnished to do so, subject to the following conditions: *)
(* *)
(* The above copyright notice and this permission notice shall be included *)
(* in all copies or substantial portions of the Software. *)
(* *)
(* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR*)
(* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *)
(* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL *)
(* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER*)
(* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING *)
(* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER *)
(* DEALINGS IN THE SOFTWARE. *)
(* *)
(*****************************************************************************)
open Error_monad
(** The error used when a worker has terminated *)
type error += Terminated
(** The running status of an individual worker. *)
type worker_status =
| Launching of Time.System.t
| Running of Time.System.t
| Closing of Time.System.t * Time.System.t
| Closed of Time.System.t * Time.System.t * error list option
(** Worker status serializer for RPCs. *)
val worker_status_encoding :
error list Data_encoding.t -> worker_status Data_encoding.t
type worker_information = {
instances_number : int;
wstatus : worker_status;
queue_length : int;
}
val worker_information_encoding :
error list Data_encoding.t -> worker_information Data_encoding.t
(** The running status of an individual request. *)
type request_status = {
pushed : Time.System.t;
treated : Time.System.t;
completed : Time.System.t;
}
(** Request status serializer for RPCs. *)
val request_status_encoding : request_status Data_encoding.t
(** The full status of an individual worker. *)
type 'req full_status = {
status : worker_status;
pending_requests : (Time.System.t * 'req) list;
current_request : (Time.System.t * Time.System.t * 'req) option;
}
(** Full worker status serializer for RPCs. *)
val full_status_encoding :
'req Data_encoding.t ->
error list Data_encoding.t ->
'req full_status Data_encoding.t
(** Exhaustive status pretty printer *)
val pp_status : Format.formatter -> request_status -> unit
(** Pretty-prints the completion time *)
val pp_status_completed : Format.formatter -> request_status -> unit