package sihl

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type

This is the actual job instance that is derived from the job description 'a Job.t and some input. This needs to be serialized and persisted for persistent job queues.

module Status : sig ... end
type t = {
  1. id : Sihl_database.Id.t;
  2. name : string;
  3. input : string option;
  4. tries : int;
  5. next_run_at : Ptime.t;
  6. max_tries : int;
  7. status : Status.t;
}
val pp : Ppx_deriving_runtime.Format.formatter -> t -> Ppx_deriving_runtime.unit
val equal : t -> t -> Ppx_deriving_runtime.bool
val make : id:Sihl_database.Id.t -> name:string -> ?input:string -> tries:int -> next_run_at:Ptime.t -> max_tries:int -> status:Status.t -> unit -> t
val status : t -> Status.t
val max_tries : t -> int
val next_run_at : t -> Ptime.t
val tries : t -> int
val input : t -> string option
val name : t -> string
val id : t -> Sihl_database.Id.t
module Fields : sig ... end
val create : input:'a -> delay:Sihl_utils.Time.duration option -> now:Ptime.t -> 'b Sihl_queue_core__.Model.Job.t -> t
val is_pending : t -> Ppx_deriving_runtime.bool
val incr_tries : t -> t
val update_next_run_at : Sihl_queue_core__.Model.WorkableJob.t -> t -> t
val set_failed : t -> t
val set_succeeded : t -> t
val should_run : job_instance:t -> now:Ptime.t -> bool