makelock: Make and remove (NFS safe) lock files

In jefferis/nat.utils: File System Utility Functions for 'NeuroAnatomy Toolbox'

Make and remove (NFS safe) lock files

Description

Creates a lock file on disk containing a message that should identify the current R session. Will return FALSE is someone else has already made a lockfile. In order to avoid race conditions typical on NFS mounted drives makelock appends a unique message to the lock file and then reads the file back in. Only if the unique message is the first line in the file will makelock return TRUE.

removelock displays a warning and returns false if lockfile cannot be removed. No error message is given if the file does not exist.

Usage

makelock(lockfile, lockmsg, CreateDirectories = TRUE)

removelock(lockfile)

Arguments

lockfile	Path to lockfile
lockmsg	Character vector with message to be written to lockfile
CreateDirectories	Recursively create directories implied by lockfile path

Value

logical indicating success

Author(s)

jefferis

Examples

makelock(lock<-tempfile())
stopifnot(!makelock(lock))
removelock(lock)

jefferis/nat.utils documentation built on July 6, 2023, 4:42 p.m.