lib/whenlock.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 (** Handle the locking that ensures only one instance of the
  20     daemon can run per user. *)
  21
  22 val create_lock : string -> unit
  23 (** [create_lock jobsdir] creates the lock file (called [daemon_pid])
  24     in the [jobsdir] directory.  The lock is automatically released
  25     when the process exits. *)
  26
  27 val update_pid : unit -> unit
  28 (** Call this if the PID of the program changes, ie. after fork. *)
  29
  30 val test_locked : string -> bool
  31 (** Test if there is a lock file and the lock is held by another process. *)
  32
  33 val kill_daemon : string -> unit
  34 (** If there is a daemon holding the lock, kill it. *)