robot.util.lock.LockFile

class documentation

class LockFile:

Constructor: LockFile(file)

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method acquire Acquire the lock file. 'who' is an object no matter what, but will represent the handler by an id
Method handled Return if the lock file has an handler
Method handler Return the handler id, or 0 if no handler, else -1 if handler is invalid
Method notify_release Notify that the lock file will be released soon
Method release Remove the lock file
Property lockfile Undocumented
Property present Undocumented
Instance Variable __lock_file Undocumented
def __init__(self, file: str):

Undocumented

def acquire(self, who: object):

Acquire the lock file. 'who' is an object no matter what, but will represent the handler by an id

def handled(self) -> bool:

Return if the lock file has an handler

def handler(self) -> int:

Return the handler id, or 0 if no handler, else -1 if handler is invalid

def notify_release(self):

Notify that the lock file will be released soon

def release(self):

Remove the lock file

@property
lockfile =

Undocumented

@property
present =

Undocumented

__lock_file =

Undocumented