t.i.d.DeferredLock(_ConcurrencyPrimitive) : class documentation

Part of twisted.internet.defer View Source View In Hierarchy

A lock for event driven systems.

Instance Variables locked True when this Lock has been acquired, false at all other times. Do not change this value, but it is useful to examine for the equivalent of a "non-blocking" acquisition.

Method	acquire	Attempt to acquire the lock. Returns a `Deferred` that fires on
Method	release	Release the lock. If there is a waiting list, then the first

Inherited from _ConcurrencyPrimitive:

Method	__init__	Undocumented
Method	run	Acquire, run, release.
Method	_releaseAndReturn	Undocumented

def acquire(self): (source)

Attempt to acquire the lock. Returns a Deferred that fires on lock acquisition with the DeferredLock as the value. If the lock is locked, then the Deferred is placed at the end of a waiting list.

Returns a Deferred which fires on lock acquisition. (type: a Deferred )

def release(self): (source)

Release the lock. If there is a waiting list, then the first Deferred in that waiting list will be called back.

Should be called by whomever did the acquire() when the shared resource is free.

API Documentation for Twisted, generated by pydoctor at 2010-03-06 12:41:43.