LockFile Class Reference

Gets an exclusive lock on a file. More...

#include <LockFile.h>

Public Member Functions
	LockFile (const std::string &filename, bool do_lock=true)
	~LockFile ()

Protected Attributes
const bool	_do_lock
int	_fd
const std::string	_filename

Detailed Description

Gets an exclusive lock on a file.

This uses RAII to obtain the lock in the constructor and release the lock in the destructor. Additionally, to allow for easier use as a stack variable, an optional bool is allowed to specify that no locking is actually done. This is useful for the case where only certain processors need to obtain the lock.

Definition at line 22 of file LockFile.h.

Constructor & Destructor Documentation

LockFile()

LockFile::LockFile	(	const std::string &	filename,
		bool	do_lock = true
	)

Definition at line 16 of file LockFile.C.

  : _do_lock(do_lock), _fd(-1), _filename(filename)
{
// for now just do not do any locking on Windows
#ifndef __WIN32__
  if (_do_lock)
  {
    _fd = open(filename.c_str(), O_RDWR | O_CREAT, 0666);
    if (_fd == -1)
      mooseError("Failed to open file", filename);
    if (flock(_fd, LOCK_EX) != 0)
      mooseWarning("Failed to lock file ", filename);
  }
#endif
}

~LockFile()

LockFile::~LockFile

(

)

Definition at line 32 of file LockFile.C.

{
#ifndef __WIN32__
  if (_do_lock)
  {
    if (flock(_fd, LOCK_UN) != 0)
      mooseWarning("Failed to unlock file ", _filename);
    close(_fd);
  }
#endif
}

Member Data Documentation

_do_lock

const bool LockFile::_do_lock

protected

Definition at line 29 of file LockFile.h.

Referenced by LockFile(), and ~LockFile().

_fd

int LockFile::_fd

protected

Definition at line 30 of file LockFile.h.

Referenced by LockFile(), and ~LockFile().

_filename

const std::string LockFile::_filename

protected

Definition at line 31 of file LockFile.h.

Referenced by ~LockFile().

---

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

• include/utils/LockFile.h
• src/utils/LockFile.C