package sihl

  1. Overview
  2. Docs
The Sihl web framework

Install

Dune Dependency

Authors

Maintainers

Sources

0.4.1.tar.gz
md5=b4d86577876e268da4219d29f0f3207e
sha512=e5ad0fffa52dc7dad72b84b49d375316342704e9414afe6da7a3be96cf9595cfbb5f792e9e20a7958f3fad1708f5005964daf29dc81e80923c86750441b82567

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. name : string;
  2. dependencies : unit -> lifecycle list;
  3. start : unit -> unit Lwt.t;
  4. stop : unit -> unit Lwt.t;
}
Sourceval 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. *

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

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

Sourcemodule Map : sig ... end
Sourceval collect_all_lifecycles : lifecycle list -> lifecycle Map.t
Sourceval top_sort_lifecycles : lifecycle list -> lifecycle list
Sourceval unpack : string -> ?default:'a -> 'a option ref -> 'a
OCaml

Innovation. Community. Security.