twisted.internet.defer.DeferredFilesystemLock : API documentation

A FilesystemLock that allows for a Deferred to be fired when the lock is acquired.

Instance Variables	_scheduler	The object in charge of scheduling retries. In this implementation this is parameterized for testing.
	_interval	The retry interval for an `IReactorTime` based scheduler.
	_tryLockCall	A `DelayedCall` based on `_interval` that will manage the next retry for aquiring the lock.
	_timeoutCall	A `DelayedCall` based on `deferUntilLocked`'s timeout argument. This is in charge of timing out our attempt to acquire the lock.

Method	__init__
Method	deferUntilLocked	Wait until we acquire this lock. This method is not safe for concurrent use.

Inherited from FilesystemLock:

Method	lock	Acquire this lock.
Method	unlock	Release this lock.

def __init__(self, name, scheduler=None): (source)

Parameters	name	The name of the lock to acquire
	scheduler	An object which provides `IReactorTime`

def deferUntilLocked(self, timeout=None): (source)

Wait until we acquire this lock. This method is not safe for concurrent use.

Parameters	timeout	the number of seconds after which to time out if the lock has not been acquired. (type: `float` or `int` )
Returns	a `Deferred` which will callback when the lock is acquired, or errback with a `TimeoutError` after timing out or an `AlreadyTryingToLockError` if the `deferUntilLocked` has already been called and not successfully locked the file.

t.i.d.DeferredFilesystemLock(lockfile.FilesystemLock) : class documentation