package datakit-ci

You can search for identifiers within the package.

in-package search v0.2.0

datakit-ci
- CI_ACL
- CI_cache
  - Make
    
    B
    
    Key
  - Path
- CI_char_stream
- CI_config
- CI_docker
  - Image
- CI_engine
- CI_escape_parser
- CI_eval
  - Make
    
    C
    
    Infix
- CI_form
  - Html
  - State
  - Validator
- CI_git
  - Commit
- CI_history
  - State
- CI_live_log
- CI_log_reporter
- CI_main
- CI_monitored_pool
- CI_output
- CI_process
- CI_result
- CI_s
  - BUILDER
    
    Key
  - CONTEXT
  - TERM
    
    Infix
- CI_secrets
- CI_static
- CI_target
  - Branch_escape
  - Map
  - Set
- CI_term
  - Infix
- CI_utils
  - Client9p
    
    LowLevel
  - DK
    
    Branch
    
    Commit
    
    Infix
    
    Transaction
    
    Tree
  - Infix
  - Log
- CI_web
- CI_web_templates
  - Error
  - Settings
- CI_web_utils
  - Auth
  - Session_data
  - User
  - Wm
    
    resource
  - auth_intro
  - auth_setup
  - form_page
  - github_auth_settings
  - github_callback
  - html_page
  - login_page
  - logout_page
  - post_page
  - protected_page
  - resource
  - resource_with_session
  - static
  - static_crunch
- Datakit_ci
  - ACL
  - BUILDER
    
    Key
  - Cache
    
    Make
    
    B
    
    Key
    
    Path
  - Config
  - DK
    
    Branch
    
    Commit
    
    Infix
    
    Transaction
    
    Tree
  - Docker
    
    Image
  - Git
  - Live_log
  - Monitored_pool
  - Output
  - Private
    
    Client9p
    
    LowLevel
  - Process
  - Target
  - Term
    
    Infix
  - Utils
    
    Infix
  - Web

Legend:
Library
Module
Module type
Parameter
Class
Class type

type t

val pools : unit -> t Astring.String.Map.t

val create : string -> int -> t

val use : 
  t ->
  ?log:CI_live_log.t ->
  ?label:string ->
  CI_s.job_id ->
  (unit -> 'a Lwt.t) ->
  'a Lwt.t

use t job fn evaluates fn () with one pool resource held. job (and label) will be displayed as the reason why the resource is in use. If log is provided then a message will be logged if we have to wait, and if the log is cancellable then the user will be able to cancel the operation.

val active : t -> int

val capacity : t -> int

val qlen : t -> int

val users : t -> ((CI_s.job_id * string option) * CI_live_log.t option) list

users t is the list of reasons why resources are being used, one per resource, and (optionally) its log (through which it may be possible to cancel the job).