twisted.python.lockfile.FilesystemLock(object) class documentation

Part of twisted.python.lockfile (View In Hierarchy)

Known subclasses: twisted.internet.defer.DeferredFilesystemLock

A mutex.

This relies on the filesystem property that creating a symlink is an atomic operation and that it will fail if the symlink already exists. Deleting the symlink will release the lock.

Instance Variable name The name of the file associated with this lock.
Instance Variable clean Indicates whether this lock was released cleanly by its last owner. Only meaningful after lock has been called and returns True.
Instance Variable locked Indicates whether the lock is currently held by this object.
Method __init__ Undocumented
Method lock Acquire this lock.
Method unlock Release this lock.
name =
The name of the file associated with this lock.
clean =
Indicates whether this lock was released cleanly by its last owner. Only meaningful after lock has been called and returns True.
locked =
Indicates whether the lock is currently held by this object.
def __init__(self, name):
overridden in twisted.internet.defer.DeferredFilesystemLock
Undocumented
def lock(self):

Acquire this lock.

ReturnsTrue if the lock is acquired, false otherwise. (type: bool)
RaisesAny exception os.symlink() may raise, other than EEXIST.
def unlock(self):

Release this lock.

This deletes the directory with the given name.

RaisesAny exception os.readlink() may raise, or ValueError if the lock is not owned by this process.
API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.