Mail::Box::Locker::Multi - lock a folder in all ways which work
Mail::Box::Locker::Multi is a Mail::Box::Locker is a Mail::Reporter
See Mail::Box::Locker
The ::Multi locker locks a folder in each way it can. This way, the chance is highest that any other program will leave the folder alone during our access to it.
::Multi
NFS-lock and Flock are tried. More may be added when the ways to lock are extended. DotLock overlaps with NFS-lock, but NFS-lock is safer, so that version is preferred.
Mail::Box::Locker::Multi->new(OPTIONS)
-Option --Defined in --Default expires Mail::Box::Locker 1 hour file Mail::Box::Locker undef folder Mail::Box::Locker <required> log Mail::Reporter 'WARNINGS' method Mail::Box::Locker 'MULTI' timeout Mail::Box::Locker 10 seconds trace Mail::Reporter 'WARNINGS' use <all possible>
'WARNINGS'
'MULTI'
. expires SECONDS
. file FILENAME
. folder FOLDER
. log LEVEL
. method STRING|CLASS|ARRAY
. timeout SECONDS|'NOTIMEOUT'
. trace LEVEL
. use ARRAY
Array of locker types and locker objects to be used to lock one folder. The type names are converted into objects.
Some locking types are not available on some platforms, so they will not be excluded from the default list (NFS POSIX Flock).
Example: using a subset of multi-lockers
my $locker = Mail::Box::Locker::Multy->new(use => ['DOTLOCK','FLOCK']);
$obj->filename([FILENAME])
See "The Locker" in Mail::Box::Locker
$obj->folder
$obj->lockers
Returns a list with all locker objects used by this object.
$obj->name
$obj->hasLock
See "Locking" in Mail::Box::Locker
$obj->isLocked
$obj->lock(FOLDER)
$obj->unlock
$obj->AUTOLOAD
See "Error handling" in Mail::Reporter
$obj->addReport(OBJECT)
$obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
Mail::Box::Locker::Multi->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
$obj->errors
$obj->log([LEVEL [,STRINGS]])
Mail::Box::Locker::Multi->log([LEVEL [,STRINGS]])
$obj->logPriority(LEVEL)
Mail::Box::Locker::Multi->logPriority(LEVEL)
$obj->logSettings
$obj->notImplemented
$obj->report([LEVEL])
$obj->reportAll([LEVEL])
$obj->trace([LEVEL])
$obj->warnings
$obj->DESTROY
See "Cleanup" in Mail::Box::Locker
$obj->inGlobalDestruction
See "Cleanup" in Mail::Reporter
Error: Package $package does not implement $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.
See the MailBox website at http://perl.overmeer.net/mailbox/ for more details.
Distribution version 2.066. Written by Mark Overmeer (mark@overmeer.net). See the ChangeLog for other contributors.
Copyright (c) 2001-2003 by the author(s). All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
To install Mail::Box, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Mail::Box
CPAN shell
perl -MCPAN -e shell install Mail::Box
For more information on module installation, please visit the detailed CPAN module installation guide.