package sihl

  1. Overview
  2. Docs
package sihl
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module QueueSource

This module provides a job queue. This is typically used for long-running or resource intensive tasks.

Sourcemodule Job : sig ... end

This is the description of a job. A job dispatch is a job description and some arguments/input.

Sourcemodule JobInstance : sig ... end

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.

Sourcemodule WorkableJob : sig ... end

A workable job can process a job instance that is persisted. We can not store the job directly because of the polymorphic type ('a Job.t).

module Sig : sig ... end
Sourceval create_job : name:string -> ?with_context:(Core.Ctx.t -> Core.Ctx.t) -> input_to_string:('a -> string option) -> string_to_input:(string option -> ('a, string) Result.t) -> handle:(Core.Ctx.t -> input:'a -> (unit, string) Result.t Lwt.t) -> ?failed:(Core.Ctx.t -> (unit, string) Result.t Lwt.t) -> unit -> 'a Queue__.Model.Job.t
Sourceval set_max_tries : int -> 'a Queue__.Model.Job.t -> 'a Queue__.Model.Job.t
Sourceval set_retry_delay : Utils.Time.duration -> 'a Queue__.Model.Job.t -> 'a Queue__.Model.Job.t
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct