package orsetto

  1. Overview
  2. Docs
package orsetto
Legend:
Library
Module
Module type
Parameter
Class
Class type

The basic journaling agent. Derive a subclass to define an agent that can construct events derived from the basic event (which may also require archivers derived from the basic archiver that can format any additional required output). The class defines six public methods for output of diagnostic events, one for each basic priority level.

constraint 'level = [> Basic.level ]
constraint 'event = 'level Basic.event
constraint 'archiver = 'event Basic.archiver
inherit 'archiver Basic.agent
method invalid : 'a 'b. ('a, unit, string, string, string, 'b) format6 -> 'a

Use a#invalid msg ... to format message text to put to the archivers at the `Invalid level, and finally used to raise an Invalid_argument exception.

method fail : 'a 'b. ('a, unit, string, string, string, 'b) format6 -> 'a

Use a#fail msg ... to format message text to put to the archivers at the `Fail level, and finally used to raise an Failure exception.

method error : 'a. ('a, unit, string, string, string, unit) format6 -> 'a

Use a#error msg ... to format message text to put to the archivers at the `Error level.

method warn : 'a. ('a, unit, string, string, string, unit) format6 -> 'a

Use a#warn msg ... to format message text to put to the archivers at the `Warn level.

method notice : 'a. ('a, unit, string, string, string, unit) format6 -> 'a

Use a#notice msg ... to format message text to put to the archivers at the `Notice level.

method info : 'a. ('a, unit, string, string, string, unit) format6 -> 'a

Use a#info msg ... to format message text to put to the archivers at the `Info level.

method debug : 'a. ('a, unit, string, string, string, bool) format6 -> 'a

Use a#debug msg ... to format message text to put to the archivers at the `Debug level. The result of the formatting continuation is always true. This is to facilitate using the method inside assert blocks.