Ubuntu Manpages

Mail::Box::Locker::NFS

lock a folder with a separate file, NFS-safe

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


 See Mail::Box::Locker

Like the "::DotLock" locker, but then in an NFS-safe fashion. Over NFS, the creation of a file is not atomic. The "::DotLock" locker depends on an atomic "open" system call, hence in not usable to lock a folder which accessed over NFS. The "::NFS" locker is therefore more complicated (so therefore slower), but will work for NFS --and for local disks as well.

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

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

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

 -Option --Defined in       --Default
  expires  Mail::Box::Locker  1 hour
  file     Mail::Box::Locker  undef
  folder   Mail::Box::Locker  <undef>
  log      Mail::Reporter     'WARNINGS'
  method   Mail::Box::Locker  'NFS'
  timeout  Mail::Box::Locker  10 seconds
  trace    Mail::Reporter     'WARNINGS'

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

$obj->filename( [$filename] )
Inherited, see "The Locker" in Mail::Box::Locker
$obj->folder( [$folder] )
Inherited, see "The Locker" in Mail::Box::Locker
$obj->name()
Inherited, see "The Locker" in Mail::Box::Locker

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()
$obj->unlock()
Inherited, see "Locking" in Mail::Box::Locker

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

$obj->AUTOLOAD()
Inherited, see "Error handling" in Mail::Reporter
$obj->addReport($object)
Inherited, see "Error handling" in Mail::Reporter
$obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
Inherited, see "Error handling" in Mail::Reporter
$obj->errors()
Inherited, see "Error handling" in Mail::Reporter
$obj->log( [$level, [$strings]] )
Inherited, see "Error handling" in Mail::Reporter
$obj->logPriority($level)
Inherited, see "Error handling" in Mail::Reporter
$obj->logSettings()
Inherited, see "Error handling" in Mail::Reporter
$obj->notImplemented()
Inherited, see "Error handling" in Mail::Reporter
$obj->report( [$level] )
Inherited, see "Error handling" in Mail::Reporter
$obj->reportAll( [$level] )
Inherited, see "Error handling" in Mail::Reporter
$obj->trace( [$level] )
Inherited, see "Error handling" in Mail::Reporter
$obj->warnings()
Inherited, see "Error handling" in Mail::Reporter

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

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

Do not try to lock the folder when the application already has the lock: it will give you dead-locks.
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.
A lock file was found which was older than the expiration period as specified with new(timeout). The lock file was successfully removed.
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.

This module is part of Mail-Box distribution version 2.118, built on February 26, 2015. Website: http://perl.overmeer.net/mailbox/

Copyrights 2001-2015 by [Mark Overmeer]. For other contributors see ChangeLog.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See http://www.perl.com/perl/misc/Artistic.html