lib/whentools.mli

   1 (* whenjobs
   2  * Copyright (C) 2012 Red Hat Inc.
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  17  *)
  18
  19 (** [Whentools] contains helper functions that jobs can call as they
  20     are loading. *)
  21
  22 val set_variable : string -> string -> unit
  23 (** Set variable (just a wrapper around {!Whenfile.set_variable}). *)
  24
  25 val set_variable_bool : string -> bool -> unit
  26 (** Set variable (just a wrapper around {!Whenfile.set_variable}). *)
  27
  28 val set_variable_int : string -> int -> unit
  29 (** Set variable (just a wrapper around {!Whenfile.set_variable}). *)
  30
  31 val set_variable_string : string -> string -> unit
  32 (** Set variable (just a wrapper around {!Whenfile.set_variable}). *)
  33
  34 val set_variable_float : string -> float -> unit
  35 (** Set variable (just a wrapper around {!Whenfile.set_variable}). *)
  36
  37 type preinfo = Whenexpr.preinfo
  38
  39 val max : int -> preinfo -> bool
  40 val one : unit -> preinfo -> bool
  41 (** Pre functions to limit number of jobs running. *)
  42
  43 type result = Whenexpr.result
  44
  45 val mailto : ?only_on_failure:bool -> ?from:string -> string -> result -> unit
  46 (** Post function to send mail. *)