package vlt

  1. Overview
  2. Docs

Module Vlt.ModeSource

This module defines the modes of event delivery.

Sourcetype error =
  1. | Invalid_condition_string of string
Sourceexception Exception of error
Sourceclass type t = object ... end

The type of modes of events delivery.

Sourceval direct : unit -> t

Returns a mode delivering events as soon as they are generated.

Sourceval memory : unit -> t

Returns a mode delivering all events at program termination.

Sourceval retained : string -> t

Returns a mode delivering events every time a condition, specified by the string parameter is made true. The condition can have one of the following form:

  • an integer followed by the letter 'e' (e. g. "10e") means that events are delivered when n have been accumulated;
  • an integer followed by the letter 'b' (e. g. "10b") means that events are delivered when a string representation of n bytes has been accumulated;
  • an integer followed by the letter 's' (e. g. "10s") means that events are delivered every n seconds.