package sihl

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Lifecycle
Service

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
  - Test
    
    Session
    
    StrMap
  - Time
    
    Span
  - Web
    
    Csrf
    
    Crypto
    
    Decrypted_token
    
    Encrypted_token
    
    Secret
    
    Flash
    
    Htmx
    
    Http
    
    Id
    
    Middleware
    
    Request
    
    Rest
    
    CONTROLLER
    
    SERVICE
    
    VIEW
    
    Session

Legend:
Library
Module
Module type
Parameter
Class
Class type

A module to manage the service container and service lifecycles.

The service container knows how to start services in the right order by respecting the defined dependencies. Use it to implement your own services.

Lifecycle

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

type lifecycle = {

type_name : string;
implementation_name : string;
id : int;
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) ->
  ?implementation_name:string ->
  string ->
  lifecycle

Service

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

module Service : sig ... end

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

start_services services starts a list of services. 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 services 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