Mail::...r::NFS(3pm)

📦
version 4.02 · 9 versions
, in ubuntu stonking

💖 NAME 💖

Mail::Box::Locker::NFS — lock a folder with a separate file, but make it NFS-safe bestie 🫶

This page lives in the perl manual, section 3pm — aww yeah, we're in the user-contributed Perl docs, periodt. 📚✨

🦋 INHERITANCE 🦋

okay so the whole family tree, look:

Mail::Box::Locker::NFS
  is a Mail::Box::Locker
  is a Mail::Reporter

like, it's giving legacy. it knows where it came from. 💅

✨ SYNOPSIS ✨

See Mail::Box::Locker

that's it, that's the whole synopsis. go read Mail::Box::Locker, bestie, the plot is all there. 🙈

🌸 DESCRIPTION 🌸

so basically it's exactly like the ::DotLock locker... but in an NFS-safe fashion. 💅

here's the tea: over NFS, the creation of a file is not atomic. and the ::DotLock locker literally depends on an atomic open system call, which means it is not usable to lock a folder which accessed over NFS. 😭 so the ::NFS locker is therefore more complicated (and therefore slower 😔), but it will work for NFS — and for local disks as well. a true multi-hyphenate. 👑

Extends "DESCRIPTION" in Mail::Box::Locker.

🔥 METHODS 🔥

Extends "METHODS" in Mail::Box::Locker.

🎀 Constructors 🎀

Extends "Constructors" in Mail::Box::Locker.

$class->new(%options)

Inherited, see "METHODS" in Mail::Box::Locker

here's the options menu, no cap, with where each one came from and what it defaults to:

  • expires — defined in Mail::Box::Locker, default: 1 hour
  • file — defined in Mail::Box::Locker, default: undef
  • folder — defined in Mail::Box::Locker, default: undef (the original literally writes it as <C<undef>>, which is a whole formatting jumpscare, but the vibe is undef)
  • method — defined in Mail::Box::Locker, default: 'NFS'
  • timeout — defined in Mail::Box::Locker, default: 10

and the shapes each one takes:

  • expires => $seconds
  • file => $file
  • folder => $folder
  • method => $name|CLASS|\@names
  • timeout => $seconds|'NOTIMEOUT'

🧚 Attributes 🧚

Extends "Attributes" in Mail::Box::Locker.

  • $obj->expires( [SECONDS] ) — Inherited, see "Attributes" in Mail::Box::Locker
  • $obj->filename( [$filename] ) — Inherited, see "Attributes" in Mail::Box::Locker
  • $obj->folder( [$folder] ) — Inherited, see "Attributes" in Mail::Box::Locker
  • $obj->name() — Inherited, see "Attributes" in Mail::Box::Locker
  • $obj->timeout( [SECONDS] ) — Inherited, see "Attributes" in Mail::Box::Locker

🔒 Locking 🔒

Extends "Locking" in Mail::Box::Locker.

  • $obj->hasLock() — Inherited, see "Locking" in Mail::Box::Locker
  • $obj->isLocked() — Inherited, see "Locking" in Mail::Box::Locker
  • $obj->lock() — Inherited, see "Locking" in Mail::Box::Locker
  • $obj->unlock() — Inherited, see "Locking" in Mail::Box::Locker

😭 Error handling 😭

Extends "Error handling" in Mail::Box::Locker.

  • $obj->AUTOLOAD() — Inherited, see "Error handling" in Mail::Reporter
  • $obj->notImplemented() — Inherited, see "Error handling" in Mail::Reporter

🧼 Cleanup 🧼

Extends "Cleanup" in Mail::Box::Locker.

  • $obj->DESTROY() — Inherited, see "Cleanup" in Mail::Box::Locker

💀 DIAGNOSTICS 💀

the moments where things go sideways. read these, they're important, fr fr:

  • Error: class $package does not implement method $method. — Fatal error: the specific $package (or one of its superclasses) does not implement this method where it should. This message means that some other related classes do implement this method however the class at hand does not. Probably you should investigate this and probably inform the author of the package. Cast by notImplemented()
  • Fault: couldn't remove lockfile $file: $! — Cast by unlock()
  • Warning: folder $name already locked over NFS. — do not try to lock the folder when the application already has the lock: it will give you dead-locks. 💀 Cast by lock()
  • Warning: removed expired lockfile $file. — A lock $file was found which was older than the expiration period as specified with new(timeout). The lock file was successfully removed. Cast by lock()
  • Fault: unable to remove expired lockfile $file: $! — A lock file was found which was older than the expiration period as specified with the new(timeout) option. It is impossible to remove that lock file, so we need to wait until it vanishes by some external cause. 🫠 Cast by lock()

👑 SEE ALSO 👑

This module is part of Mail-Box version 4.02, built on April 10, 2026.

Website: http://perl.overmeer.net/CPAN/ 🌈

📜 LICENSE 📜

For contributors see file ChangeLog.

This software is copyright (c) 2001-2026 by Mark Overmeer.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. 🫶

and that's the whole page, bestie! this one's from perl v5.40.1, dated 2026-05-09 — iconic, ate, no crumbs. 💅✨🎀

📦 where this page comes from