logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

ost::Lockfile - This class is used to create a 'named' lock entity that can be used to control access to

Author

       Generated automatically by Doxygen for GNU CommonC++ from the source code.

GNU CommonC++                                    Sun Dec 27 2020                                ost::Lockfile(3)

Constructor & Destructor Documentation

ost::Lockfile::Lockfile(constchar*name)
       Create a lock under a known name.

       Parametersname of system-wide lock to create.

   ost::Lockfile::Lockfile()
       Create a new lock object that can be used to make locks.

   ost::Lockfile::~Lockfile()[inline]
       Destroy the current lock and release it.

Detailed Description

       This class is used to create a 'named' lock entity that can be used to control access to a resource
       between multiple processes.

       The posix implimentation uses a pidfile and the win32 version uses a globally visible mutex.

       Author
           David Sugar dyfet@ostel.com

       System-wide named lock

Member Function Documentation

boolost::Lockfile::isLocked(void)
       Flag if the current process has aqcuired a lock.

       Returns
           true if we have the lock.

   boolost::Lockfile::lock(constchar*name)
       Lock a system-wide name for this process. If the lock is successful, return true. If an existing lock was
       already acquired, release it first.

       Returns
           true if lock successful.

       Parametersname system-wide lock to use.

   voidost::Lockfile::unlock(void)
       Release an acquired lock.

Name

       ost::Lockfile - This class is used to create a 'named' lock entity that can be used to control access to
       a resource between multiple processes.

Synopsis

       #include <process.h>

   PublicMemberFunctionsLockfile (const char *name)
           Create a lock under a known name.
       Lockfile ()
           Create a new lock object that can be used to make locks.
       ~Lockfile ()
           Destroy the current lock and release it.
       bool lock (const char *name)
           Lock a system-wide name for this process.
       void unlock (void)
           Release an acquired lock.
       bool isLocked (void)
           Flag if the current process has aqcuired a lock.

See Also