package sihl

  1. Overview
  2. Docs
The Sihl web framework

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (35)

Authors

  1. J
    Josef Erben
  2. A
    Aron Erben
  3. M
    Miko Nieminen

Maintainers

  1. J
    josef@oxidizing.io

Sources

2.0.1.tar.gz
md5=52b28d3faac0a2243735285aa3f962aa
sha512=e7ff89bdba9f1afa3b115a056ae3d403f602685187a968485ea64a7cd1a18791f66b7480b682bf66acd3564dd89139162779d58a43c2389d785c98e246094a18

doc/sihl/Sihl/Container/index.html

Module Sihl.ContainerSource

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. *

Sourcetype lifecycle = {
  1. type_name : string;
  2. implementation_name : string;
  3. id : int;
  4. dependencies : unit -> lifecycle list;
  5. start : unit -> unit Lwt.t;
  6. stop : unit -> unit Lwt.t;
}
Sourceval 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. *

Sourcemodule Service : sig ... end
Sourceval 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)

Sourceval 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)

Sourcemodule Map : sig ... end
Sourceval collect_all_lifecycles : lifecycle list -> lifecycle Map.t
Sourceval top_sort_lifecycles : lifecycle list -> lifecycle list