File: callback.mli

package info (click to toggle)
jocaml 3.12.1-1
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 16,740 kB
  • sloc: ml: 107,815; ansic: 36,537; sh: 5,467; asm: 5,359; lisp: 4,041; makefile: 2,527; perl: 45; fortran: 21; sed: 19; cs: 9; tcl: 2
file content (34 lines) | stat: -rw-r--r-- 1,787 bytes parent folder | download | duplicates (2)
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
(***********************************************************************)
(*                                                                     *)
(*                           Objective Caml                            *)
(*                                                                     *)
(*            Xavier Leroy, projet Cristal, INRIA Rocquencourt         *)
(*                                                                     *)
(*  Copyright 1996 Institut National de Recherche en Informatique et   *)
(*  en Automatique.  All rights reserved.  This file is distributed    *)
(*  under the terms of the GNU Library General Public License, with    *)
(*  the special exception on linking described in file ../LICENSE.     *)
(*                                                                     *)
(***********************************************************************)

(* $Id: callback.mli 7199 2005-10-27 11:38:58Z maranget $ *)

(** Registering Caml values with the C runtime.

   This module allows Caml values to be registered with the C runtime
   under a symbolic name, so that C code can later call back registered
   Caml functions, or raise registered Caml exceptions.
*)

val register : string -> 'a -> unit
(** [Callback.register n v] registers the value [v] under
   the name [n]. C code can later retrieve a handle to [v]
   by calling [caml_named_value(n)]. *)

val register_exception : string -> exn -> unit
(** [Callback.register_exception n exn] registers the
   exception contained in the exception value [exn]
   under the name [n]. C code can later retrieve a handle to
   the exception by calling [caml_named_value(n)]. The exception
   value thus obtained is suitable for passign as first argument
   to [raise_constant] or [raise_with_arg]. *)