annotate mercurial/lock.py @ 1787:e431344e604c

add a timeout when a lock is held (default 1024 sec)

- change the wait keyword from lock.lock to timeout,
  a negative timeout of means "wait forever"
- refactor the two lock functions from localrepo.py
- make them use the timeout (default 1024, can be changed
  with ui.timeout in the config file
- update the doc

# lock.py - simple locking scheme for mercurial
#
# Copyright 2005 Matt Mackall <[e-mail]>
#
# This software may be used and distributed according to the terms
# of the GNU General Public License, incorporated herein by reference.

import errno, os, time
import util

class LockException(Exception):
    pass
class LockHeld(LockException):
    pass
class LockUnavailable(LockException):
    pass

class lock(object):
    def __init__(self, file, timeout=-1, releasefn=None):
        self.f = file
        self.held = 0
        self.timeout = timeout
        self.releasefn = releasefn
        self.lock()

    def __del__(self):
        self.release()

    def lock(self):
        timeout = self.timeout
        while 1:
            try:
                self.trylock()
                return 1
            except LockHeld, inst:
                if timeout != 0:
                    time.sleep(1)
                    if timeout > 0:
                        timeout -= 1
                    continue
                raise inst

    def trylock(self):
        pid = os.getpid()
        try:
            util.makelock(str(pid), self.f)
            self.held = 1
        except (OSError, IOError), why:
            if why.errno == errno.EEXIST:
                raise LockHeld(util.readlock(self.f))
            else:
                raise LockUnavailable(why)

    def release(self):
        if self.held:
            self.held = 0
            if self.releasefn:
                self.releasefn()
            try:
                os.unlink(self.f)
            except: pass