helm/ocaml/thread/threadSafe.mli

   1 (*
   2  * Copyright (C) 2003-2004:
   3  *    Stefano Zacchiroli <zack@cs.unibo.it>
   4  *    for the HELM Team http://helm.cs.unibo.it/
   5  *
   6  *  This file is part of HELM, an Hypertextual, Electronic
   7  *  Library of Mathematics, developed at the Computer Science
   8  *  Department, University of Bologna, Italy.
   9  *
  10  *  HELM is free software; you can redistribute it and/or
  11  *  modify it under the terms of the GNU General Public License
  12  *  as published by the Free Software Foundation; either version 2
  13  *  of the License, or (at your option) any later version.
  14  *
  15  *  HELM is distributed in the hope that it will be useful,
  16  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  *  GNU General Public License for more details.
  19  *
  20  *  You should have received a copy of the GNU General Public License
  21  *  along with HELM; if not, write to the Free Software
  22  *  Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  23  *  MA  02111-1307, USA.
  24  *
  25  *  For details, see the HELM World-Wide-Web page,
  26  *  http://helm.cs.unibo.it/
  27  *)
  28
  29 class threadSafe:
  30   object
  31
  32       (** execute 'action' in mutual exclusion between all other threads *)
  33     method private doCritical: 'a. 'a lazy_t -> 'a
  34
  35       (** execute 'action' acting as a 'reader' i.e.: multiple readers can act
  36       at the same time but no writer can act until no readers are acting *)
  37     method private doReader: 'a. 'a lazy_t -> 'a
  38
  39       (** execute 'action' acting as a 'writer' i.e.: when a writer is acting,
  40       no readers or writer can act, beware that writers can starve *)
  41     method private doWriter: 'a. 'a lazy_t -> 'a
  42
  43   end
  44