MiKTeX::Core::LockFile Class Reference

An instance of this class provides an interface to a lock file. More...

#include <miktex/Core/LockFile.h>

Public Member Functions
virtual bool	TryLock (std::chrono::milliseconds timeout)=0
virtual void	Unlock ()=0
	Removes the lock file. More...

Static Public Member Functions
static std::unique_ptr< LockFile >	Create (const MiKTeX::Util::PathName &path)

Detailed Description

An instance of this class provides an interface to a lock file.

Member Function Documentation

Create()

static std::unique_ptr< LockFile > MiKTeX::Core::LockFile::Create ( const MiKTeX::Util::PathName &  path )

static

Creates a new LockFile object.

Parameters

path	The file system path to the lock file.

Returns

Returns a smart pointer to the new LockFile object.

TryLock()

virtual bool MiKTeX::Core::LockFile::TryLock ( std::chrono::milliseconds  timeout )

pure virtual

Tries to create the lock file.

Parameters

time	The maximum time waited for the operation to succeed.

Returns

Returns true, if the lock file has been created.

Unlock()

virtual void MiKTeX::Core::LockFile::Unlock ( )

pure virtual

Removes the lock file.

---

The documentation for this class was generated from the following file:

• Libraries/MiKTeX/Core/include/miktex/Core/LockFile.h