Module Ketrew.Engine

module Engine: sig .. end

The engine of the actual Workflow Engine.

type t

The contents of the application engine.

val with_engine : configuration:Ketrew.Configuration.engine ->
       (engine:t ->
        (unit,
         [> `Database of Trakeva.Error.t
          | `Database_unavailable of Ketrew_pure.Target.id
          | `Dyn_plugin of [> `Dynlink_error of Dynlink.error | `Findlib of exn ]
          | `Failure of string
          | `Fetching_node of Persistent_data.Error.fetching_node
          | `Target of [> `Deserilization of string ] ]
         as 'merge_error)
        Unix_io.Deferred_result.t) ->
       (unit, 'merge_error) Unix_io.Deferred_result.t

Create a engine.t, run the function passed as argument, and properly dispose of it.

val load : configuration:Ketrew.Configuration.engine ->
       (t,
        [> `Database of Trakeva.Error.t
         | `Database_unavailable of string
         | `Dyn_plugin of [> `Dynlink_error of Dynlink.error | `Findlib of exn ]
         | `Failure of string
         | `Fetching_node of Persistent_data.Error.fetching_node
         | `Target of [> `Deserilization of string ] ])
       Unix_io.Deferred_result.t

val unload : t ->
       (unit,
        [> `Database of Trakeva.Error.t
         | `Database_unavailable of Ketrew_pure.Target.id ])
       Unix_io.Deferred_result.t

val configuration : t -> Ketrew.Configuration.engine

Retrieve the configuration.

val add_targets : t ->
       Ketrew_pure.Target.t list ->
       (unit,
        [> `Database of Trakeva.Error.t
         | `Database_unavailable of Ketrew_pure.Target.id
         | `Fetching_node of Persistent_data.Error.fetching_node
         | `Target of [> `Deserilization of string ] ])
       Unix_io.Deferred_result.t

Add a list of targets to the engine.

val get_target : t ->
       Ketrew_pure.Internal_pervasives.Unique_id.t ->
       (Ketrew_pure.Target.t,
        [> `Database of Trakeva.Error.t
         | `Database_unavailable of string
         | `Fetching_node of Persistent_data.Error.fetching_node
         | `Target of [> `Deserilization of string ] ])
       Unix_io.Deferred_result.t

Get a target from its id.

val all_visible_targets : t ->
       (Ketrew_pure.Target.t list,
        [> `Database of Trakeva.Error.t
         | `Database_unavailable of string
         | `Fetching_node of Persistent_data.Error.fetching_node
         | `IO of
             [> `Read_file_exn of string * exn | `Write_file_exn of string * exn ]
         | `System of [> `File_info of string ] * [> `Exn of exn ]
         | `Target of [> `Deserilization of string ] ])
       Unix_io.Deferred_result.t

Get the list of targets currently handled.

val get_list_of_target_ids : t ->
       Ketrew_pure.Protocol.Up_message.target_query ->
       (Ketrew_pure.Target.id list,
        [> `Database of Trakeva.Error.t
         | `Database_unavailable of string
         | `Fetching_node of Persistent_data.Error.fetching_node
         | `Target of [> `Deserilization of string ] ])
       Unix_io.Deferred_result.t

Get only the Ids of the targets for a given “query”:

`All for all the targets visible to the engine.
`Not_finished_before _ for the targets that were not finished at a given date.

val next_changes : t ->
       (Persistent_data.Change.t list, 'a) Unix_io.Deferred_result.t

Block until the next batch of changes happening at the persistence-level, this stream is itself rate-limited.

module Run_automaton: sig .. end

val get_status : t ->
       Ketrew_pure.Target.id ->
       (Ketrew_pure.Target.State.t,
        [> `Database of Trakeva.Error.t
         | `Database_unavailable of string
         | `Fetching_node of Persistent_data.Error.fetching_node
         | `IO of
             [> `Read_file_exn of string * exn | `Write_file_exn of string * exn ]
         | `System of [> `File_info of string ] * [> `Exn of exn ]
         | `Target of [> `Deserilization of string ] ])
       Unix_io.Deferred_result.t

Get the state description of a given target (by “id”).

val kill : t ->
       id:Ketrew_pure.Internal_pervasives.Unique_id.t ->
       (unit,
        [> `Database of [> `Act of Trakeva.Action.t | `Load of string ] * string
         | `Database_unavailable of string ])
       Unix_io.Deferred_result.t

Kill a target

val restart_target : t ->
       Ketrew_pure.Target.id ->
       (Ketrew_pure.Target.id,
        [> `Database of Trakeva.Error.t
         | `Database_unavailable of Ketrew_pure.Target.id
         | `Fetching_node of Persistent_data.Error.fetching_node
         | `Target of [> `Deserilization of string ] ])
       Unix_io.Deferred_result.t

Make new activated targets out of a given target and its “transitive reverse dependencies”

val host_io : t -> Host_io.t