package sihl

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Lifecycle
Service

package sihl

sihl
- Sihl
  - App
  - Cleaner
  - Command
  - Configuration
  - Container
    
    Map
    
    Service
    
    Sig
  - Contract
    
    Cache
    
    Sig
    
    Database
    
    Sig
    
    Email
    
    Sig
    
    Email_template
    
    Sig
    
    Http
    
    Sig
    
    Migration
    
    Sig
    
    Password_reset
    
    Sig
    
    Queue
    
    Sig
    
    Random
    
    Sig
    
    Schedule
    
    Sig
    
    Storage
    
    Sig
    
    Token
    
    Sig
    
    User
    
    Hashing
    
    Sig
    
    Web
  - Database
    
    Migration
    
    Logs
    
    Make
    
    Repo
    
    Migration
    
    Fields
    
    Direct
    
    Map
    
    MariaDb
    
    PostgreSql
    
    Sig
  - Log
  - Random
  - Schedule
    
    Logs
  - Time
    
    Span
  - Web
    
    Csrf
    
    Flash
    
    Htmx
    
    Http
    
    Id
    
    Middleware
    
    Request
    
    Session

Legend:
Library
Module
Module type
Parameter
Class
Class type

Lifecycle

Every service has a lifecycle, meaning it can be started and stopped. *

type lifecycle = {

name : string;
dependencies : unit -> lifecycle list;
start : unit -> unit Lwt.t;
stop : unit -> unit Lwt.t;

}

val create_lifecycle : 
  ?dependencies:(unit -> lifecycle list) ->
  ?start:(unit -> unit Lwt.t) ->
  ?stop:(unit -> unit Lwt.t) ->
  string ->
  lifecycle

Service

A service has a start and stop functions and a lifecycle. *

module Service : sig ... end

val start_services : Service.t list -> lifecycle list Lwt.t

start_services lifecycles starts a list of service lifecycles. The order does not matter as the services are started in the order of their dependencies. (No service is started before its dependency)

val stop_services : Service.t list -> unit Lwt.t

stop_services ctx services stops a list of service lifecycles with a context ctx. The order does not matter as the services are stopped in the order of their dependencies. (No service is stopped after its dependency)

module Map : sig ... end

val collect_all_lifecycles : lifecycle list -> lifecycle Map.t

val top_sort_lifecycles : lifecycle list -> lifecycle list

val unpack : string -> ?default:'a -> 'a option ref -> 'a