Struct Pidlock

pub struct Pidlock { /* private fields */ }

A pid-centered lock. A lock is considered “acquired” when a file exists on disk at the path specified, containing the process id of the locking process.

Implementations

impl Pidlock

pub fn new(path: &str) -> Self

Create a new Pidlock at the provided path.

pub fn acquire(&mut self) -> Result<(), PidlockError>

Acquire a lock.

pub fn locked(&self) -> bool

Returns true when the lock is in an acquired state.

pub fn release(&mut self) -> Result<(), PidlockError>

Release the lock.

pub fn get_owner(&self) -> Option<u32>

Gets the owner of this lockfile, returning the pid. If the lock file doesn’t exist, or the specified pid is not a valid process id on the system, it clears it.