File: debug.mli

package info (click to toggle)
xen-api-libs 0.5.2-3
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 1,940 kB
  • sloc: ml: 13,925; sh: 2,930; ansic: 1,699; makefile: 1,240; python: 83
file content (61 lines) | stat: -rw-r--r-- 1,839 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
(*
 * Copyright (C) 2006-2009 Citrix Systems Inc.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation; version 2.1 only. with the special
 * exception on linking described in file LICENSE.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *)

(** Debug utilities *)

(** Throw away the cached hostname. The next log line will re-query the hostname *)
val invalidate_hostname_cache: unit -> unit

(** {2 Associate a task to the current actions} *)

(** Associate a task name to the current thread *)
val associate_thread_with_task : string -> unit

(** Dissociate a task name to the current thread *)
val dissociate_thread_from_task : unit -> unit

(** Do an action with a task name associated with the current thread *)
val with_thread_associated : string -> ('a -> 'b) -> 'a -> 'b

(** {2 Associate a name to the current thread} *)

val name_thread : string -> unit

val remove_thread_name : unit -> unit

val get_all_debug_keys : unit -> string list

module type BRAND = sig val name : string end

module Debugger : functor (Brand : BRAND) ->
sig

	(** Debug function *)
	val debug : ('a, unit, string, unit) format4 -> 'a

    (** Warn function *)
	val warn : ('a, unit, string, unit) format4 -> 'a

	(** Info function *)
    val info : ('a, unit, string, unit) format4 -> 'a
    
	(** Error function *)
	val error : ('a, unit, string, unit) format4 -> 'a

    (** Audit function *)
	val audit : ?raw:bool -> ('a, unit, string, string) format4 -> 'a
    
	val log_backtrace : unit -> unit
end