package octez-libs

You can search for identifiers within the package.

in-package search v0.2.0

A package that contains multiple base libraries used by the Octez suite

Install

Dune Dependency

www.tezos.com Readme Edit opam file Versions (5)

Authors

T

Tezos devteam

Maintainers

C

contact@tezos.com

Sources

tezos-octez-v20.1.tag.bz2

sha256=ddfb5076eeb0b32ac21c1eed44e8fc86a6743ef18ab23fff02d36e365bb73d61

sha512=d22a827df5146e0aa274df48bc2150b098177ff7e5eab52c6109e867eb0a1f0ec63e6bfbb0e3645a6c2112de3877c91a17df32ccbff301891ce4ba630c997a65

doc/octez-libs.event-logging-test-helpers/Tezos_event_logging_test_helpers/Tezt_sink/Sink/index.html

Module `Tezt_sink.Sink`Source

Sink is an Internal_event.SINK implementation logging through Tezt's Log.

Sourcetype t

A sink can store any required state, e.g. a database handle, in a value of the t type see configure.

Sourceval uri_scheme : string

Registered sinks are a distinguished by their URI scheme.

Sourceval configure : Uri.t -> t Tezos_error_monad.Error_monad.tzresult Lwt.t

When a registered sink is activated the configure function is called to initialize it. The parameters should be encoded or obtained from the URI (the scheme of the URI is already uri_scheme).

Source

val should_handle : 
  ?section:Tezos_event_logging.Internal_event.Section.t ->
  t ->
  _ Tezos_event_logging.Internal_event.event_definition ->
  bool

Predicate deciding whether a sink should handle the event or not.

Source

val handle : 
  t ->
  'a Tezos_event_logging.Internal_event.event_definition ->
  ?section:Tezos_event_logging.Internal_event.Section.t ->
  'a ->
  unit Tezos_error_monad.Error_monad.tzresult Lwt.t

A sink's main function is to handle incoming events from the code base.

Sourceval close : t -> unit Tezos_error_monad.Error_monad.tzresult Lwt.t

A function to be called on graceful termination of processes (e.g. to flush file-descriptors, etc.).