libmojave/unix/lm_notify.mli

   1 (*
   2  * File-change notification services.
   3  *
   4  * ----------------------------------------------------------------
   5  *
   6  * @begin[license]
   7  * Copyright (C) 2004 Mojave Group, Caltech
   8  *
   9  * This library is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public
  11  * License as published by the Free Software Foundation,
  12  * version 2.1 of the License.
  13  *
  14  * This library is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with this library; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  22  *
  23  * Additional permission is given to link this library with the
  24  * OpenSSL project's "OpenSSL" library, and with the OCaml runtime,
  25  * and you may distribute the linked executables.  See the file
  26  * LICENSE.libmojave for more details.
  27  *
  28  * Author: Jason Hickey
  29  * @email{jyh@cs.caltech.edu}
  30  * @end[license]
  31  *)
  32
  33 (*
  34  * Event manager.
  35  *)
  36 type t
  37
  38 (*
  39  * Events.
  40  *)
  41 type code =
  42    Changed
  43  | Deleted
  44  | StartExecuting
  45  | StopExecuting
  46  | Created
  47  | Moved
  48  | Acknowledge
  49  | Exists
  50  | EndExist
  51  | DirectoryChanged
  52
  53 type event =
  54    { notify_code : code;
  55      notify_name : string
  56    }
  57
  58 (*
  59  * Debugging.
  60  *)
  61 val debug_notify      : bool ref
  62 val string_of_code    : code -> string
  63
  64 (*
  65  * Methods.
  66  *)
  67 val enabled           : bool
  68 val create            : unit -> t
  69 val close             : t -> unit
  70 val file_descr        : t -> Unix.file_descr
  71 val monitor           : t -> string -> bool -> unit
  72 val pending           : t -> bool
  73 val next_event        : t -> event
  74
  75 val suspend           : t -> string -> unit
  76 val resume            : t -> string -> unit
  77 val cancel            : t -> string -> unit
  78
  79 val suspend_all       : t -> unit
  80 val resume_all        : t -> unit
  81 val cancel_all        : t -> unit
  82
  83 (*!
  84  * @docoff
  85  *
  86  * -*-
  87  * Local Variables:
  88  * Caml-master: "compile"
  89  * End:
  90  * -*-
  91  *)