class Gambit::Utils::FileLock

[No description available] More…

#include <file_lock.hpp>

Public Functions

	Name
	FileLock(const std::string & fname, const bool is_exhaustible =false, const bool harderrs =false) Constructor.
	~FileLock()
void	get_lock() Obtain lock (or wait if lock cannot be obtained, and then obtain lock)
void	release_lock() Release a lock (error if no lock held)
const std::string &	get_filename() const Getter for lockfile name.
bool	exhausted() Check if lock is exhausted.

class Gambit::Utils::FileLock;

Class to manage a file lock Lock will be automatically released if this object is destructed

FileLock(
    const std::string & fname,
    const bool is_exhaustible =false,
    const bool harderrs =false
)

Constructor.

Should check for errors opening the file. List of error codes is kind of long though, let people look it up themselves for now…

Error opening file!

~FileLock()

Destructor Closing the file descriptor will automatically release any lock we might have

Error closing file!

void get_lock()

Obtain lock (or wait if lock cannot be obtained, and then obtain lock)

Already have the lock!

Ok it seems there are some errors that we should handle, and then just try again to obtain the lock.

void release_lock()

Release a lock (error if no lock held)

Don’t have the lock!

Release the lock

const std::string & get_filename() const

Getter for lockfile name.

bool exhausted()

Check if lock is exhausted.

Don’t have the lock!

Updated on 2023-06-26 at 21:36:53 +0000