hphp/hack/src/remote/jobRunner_sig.ml

   1 (*
   2  * Copyright (c) Facebook, Inc. and its affiliates.
   3  *
   4  * This source code is licensed under the MIT license found in the
   5  * LICENSE file in the "hack" directory of this source tree.
   6  *
   7  *)
   8
   9 open Hh_prelude
  10
  11 module Types = struct
  12   type job_id = Job_id of Int64.t [@@deriving show, eq]
  13
  14   type nonce = Nonce of Int64.t [@@deriving show, eq]
  15 end
  16
  17 module type S = sig
  18   (* include module type of Types *)
  19
  20   type command
  21
  22   type status [@@deriving show]
  23
  24   (* Note on the nonce parameter: it is up to the caller to specify a nonce that
  25     results in the desired behavior, such as grouping multiple commands together.
  26     It can be used later in `begin_cancel` to cancel a group of commands, for example. *)
  27   val create_command :
  28     nonce:Int64.t ->
  29     key:string ->
  30     hash:string ->
  31     check_id:string ->
  32     transport_channel:string option ->
  33     file_system_mode:string ->
  34     recli_version:string ->
  35     max_cas_bytes:int ->
  36     max_inline_bytes:int ->
  37     root:string ->
  38     min_log_level:Hh_logger.Level.t ->
  39     version_specifier:string option ->
  40     eden:bool ->
  41     command Future.t
  42
  43   val is_alive : status -> bool
  44
  45   (* Cancels a group of running commands using the nonce they were created with. *)
  46   val begin_cancel_batch : Types.nonce -> (status list, string) result Future.t
  47
  48   val begin_cancel : Types.job_id -> (status, string) result Future.t
  49
  50   val begin_heartbeat : Types.job_id -> (status, string) result Future.t
  51
  52   val begin_run : command:command -> (Types.job_id, string) result Future.t
  53
  54   val run : command:command -> (Types.job_id, string) result
  55 end