Struct FileLockManager 

pub struct FileLockManager { /* private fields */ }

File-based lock manager for cross-process locking.

Locks are represented as files in a directory. File existence indicates allocation state, and flock(2) is used for actual locking.

Directory Structure

lock_dir/
├── 0     # Lock file for ID 0
├── 1     # Lock file for ID 1
└── ...

Example

let manager = FileLockManager::new("/var/run/boxlite/locks")?;
let lock_id = manager.allocate()?;
let lock = manager.retrieve(lock_id)?;

lock.lock();  // Uses flock(LOCK_EX)
// ... critical section ...
lock.unlock();  // Uses flock(LOCK_UN)

Implementations

impl FileLockManager

pub fn new<P: AsRef<Path>>(lock_dir: P) -> BoxliteResult<Self>

Create a new file lock manager at the given directory.

The directory will be created if it doesn’t exist.

Errors

Returns an error if the directory cannot be created.

pub fn open<P: AsRef<Path>>(lock_dir: P) -> BoxliteResult<Self>

Open an existing lock manager directory.

Errors

Returns an error if the directory doesn’t exist.

Trait Implementations

impl LockManager for FileLockManager

fn allocate(&self) -> BoxliteResult<LockId>

Allocate a new lock and return its unique ID.

fn retrieve(&self, id: LockId) -> BoxliteResult<Arc<dyn Locker>>

Retrieve a lock by its ID.

fn allocate_and_retrieve(&self, id: LockId) -> BoxliteResult<Arc<dyn Locker>>

Mark a lock with the given ID as allocated and return it.

fn free(&self, id: LockId) -> BoxliteResult<()>

Free a lock, allowing it to be reallocated.

fn free_all(&self) -> BoxliteResult<()>

Free all locks.

fn available(&self) -> BoxliteResult<Option<u32>>

Get the number of available (unallocated) locks.

fn allocated_count(&self) -> BoxliteResult<u32>

Get the number of currently allocated locks.

fn clear_all_locks(&self) -> BoxliteResult<()>

Clear all allocated locks.