package current

You can search for identifiers within the package.

in-package search v0.2.0

package current

current
- CHANGES
- README
- Library current
  - Current
    
    Level
    
    Config
    
    actions
    
    Metadata
    
    Primitive
    
    Syntax
    
    Monitor
    
    Analysis
    
    Var
    
    String
    
    Unit
    
    Switch
    
    Pool
    
    Job
    
    Map
    
    Engine
    
    Step
    
    Process
    
    Db
    
    Log_matcher
- Library current.cache
  - Current_cache
    
    S
    
    WITH_DIGEST
    
    WITH_MARSHAL
    
    OPERATION
    
    Key
    
    BUILDER
    
    Key
    
    Value
    
    PUBLISHER
    
    Key
    
    Value
    
    Outcome
    
    GENERIC
    
    Key
    
    Value
    
    Outcome
    
    Schedule
    
    Make
    
    Output
    
    Generic
    
    Db
- Library current.fs
  - Current_fs
- Library current.term
  - Current_term
    
    S
    
    T
    
    ORDERED
    
    ANALYSIS
    
    TERM
    
    Syntax
    
    EXECUTOR
    
    Output
    
    Blockable
    
    Make
    
    Syntax
    
    Analysis
    
    Executor
- Sources
  - current
    
    config.ml
    
    current.ml
    
    current__.ml
    
    db.ml
    
    disk_store.ml
    
    job.ml
    
    level.ml
    
    log.ml
    
    log_matcher.ml
    
    pool.ml
    
    process.ml
    
    switch.ml
  - current.cache
    
    current_cache.ml
    
    current_cache__.ml
    
    db.ml
    
    log.ml
    
    s.ml
  - current.fs
    
    current_fs.ml
  - current.term
    
    analysis.ml
    
    current_term.ml
    
    current_term__.ml
    
    dot.ml
    
    dyn.ml
    
    id.ml
    
    node.ml
    
    output.ml
    
    s.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Current.Engine`Source

The main event loop.

Sourcetype t

Sourcetype results = {

value : unit Current_term.Output.t;
jobs : actions Job.Map.t;
(*
The jobs currently being used (whether running or finished).
*)

}

Source

val create : 
  ?config:Config.t ->
  ?trace:(next:unit Lwt.t -> results -> unit Lwt.t) ->
  (unit -> unit term) ->
  t

create pipeline is a new engine running pipeline. The engine will evaluate t's pipeline immediately, and again whenever one of its inputs changes.

Sourceval update : unit -> unit

Primitives should call this after using Current_incr.change to run another step of the engine loop. This will (asynchronously) call Current_incr.propagate and perform any end-of-propagation activities.

Sourceval state : t -> results

The most recent results from evaluating the pipeline.

Sourceval jobs : results -> actions Job.Map.t

Sourceval thread : t -> 'a Lwt.t

thread t is the engine's thread. Use this to monitor the engine (in case it crashes).

Sourceval config : t -> Config.t

Sourceval pipeline : t -> unit term

Sourceval update_metrics : t -> unit

update_metrics t reports how many pipeline stages are in each state via Prometheus. Call this on each metrics collection if you have exactly one pipeline. The default web UI does this automatically.

Sourceval on_disable : (unit -> unit) -> unit

on_disable fn schedules fn () to be called after the next evaluation. You can increment a ref-count when calling this and then check it when the callback is called. If it is then zero, the operation is no longer required and you can e.g. cancel the job.

Sourcemodule Step : sig ... end

package current

Module Current.EngineSource

Module `Current.Engine`Source