(* $Id: netplex_log.mli 978 2006-08-26 19:41:24Z gerd $ *)

(** Loggers *)

open Netplex_types

val level_weight : level -> int

val level_of_string : string -> level

val channel_logger : out_channel -> logger

val stderr_logger_factory : logger_factory
  (** Reads a logging section like
    *
    * {[ logging {
    *       type = "stderr";
    *    }
    * ]}
   *)


val file_logger : string -> logger
  (** Writes messages to this file *)

val file_logger_factory : logger_factory
  (** Reads a logging section like
    *
    * {[ logging {
    *       type = "file";
    *       file = "/path/to/logfile";
    *    }
    * ]}
   *)

class type multi_file_config =
object
  method log_directory : string
  method log_files :
    (string * [ level | `All ] * string) list
    (** Triples [ (component, max_level, file) ]. Use [*] as wildcard in
      * component.
      *
      * Currently, [`All] is a synonym for [`Debug].
      *)
end

val multi_file_logger : multi_file_config -> logger

val multi_file_logger_factory : logger_factory
  (**  Reads a logging section like
    *
    * {[ logging {
    *       type = "multi_file";
    *       directory = "/path/to/logdir";
    *       file {
    *           component = "name_of_component";
    *           max_level = "max_level";
    *           file = "logfile";
    *       };
    *       file { ... }; ...
    *    }
    * ]}
    *
    * If [component] is missing it will default to "*". If [max_level]
    * is omitted it is assumed to be "all".
   *)

val logger_factories :  logger_factory list
  (** All built-in logger factories *)


val debug_scheduling : bool ref
  (** If set to true, the controller and a few other components output
    * a lot of debug messages, mostly scheduling-related.
   *)

val debug_containers : bool ref
  (** If set to true, the containers output when they are started and
    * stopped, and when new connections are accepted.
   *)