Mail::Box::Locker::Multi(3pm) User Contributed Perl Documentation Mail::Box::Locker::Multi(3pm)
NAME
Mail::Box::Locker::Multi - lock a folder in all ways which work
INHERITANCE
Mail::Box::Locker::Multi
is a Mail::Box::Locker
is a Mail::Reporter
SYNOPSIS
See Mail::Box::Locker
DESCRIPTION
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.
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.
METHODS
Constructors
Mail::Box::Locker::Multi->new(OPTIONS)
You may also pass all OPTIONS understood by the initiated lockers used by the multi 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 'MULTI'
timeout Mail::Box::Locker 10 seconds
trace Mail::Reporter 'WARNINGS'
use <all possible>
expires => SECONDS
file => FILENAME
folder => FOLDER
log => LEVEL
method => STRING|CLASS|ARRAY
timeout => SECONDS|'NOTIMEOUT'
trace => LEVEL
use => ARRAY-of-(NAMES|LOCKER)
Array of locker type NAMES or LOCKER objects to be used to lock one folder. The type NAMES are converted into objects. When you
create your own LOCKER objects, be sure to set the timeout very short (preferrably to 1).
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::Multi->new(use => ['DOTLOCK','FLOCK']);
The Locker
$obj->filename([FILENAME])
See "The Locker" in Mail::Box::Locker
$obj->folder([FOLDER])
See "The Locker" in Mail::Box::Locker
$obj->lockers()
Returns a list with all locker objects used by this object.
$obj->name()
See "The Locker" in Mail::Box::Locker
Locking
$obj->hasLock()
See "Locking" in Mail::Box::Locker
$obj->isLocked()
See "Locking" in Mail::Box::Locker
$obj->lock(FOLDER)
See "Locking" in Mail::Box::Locker
$obj->unlock()
See "Locking" in Mail::Box::Locker
Error handling
$obj->AUTOLOAD()
See "Error handling" in Mail::Reporter
$obj->addReport(OBJECT)
See "Error handling" in Mail::Reporter
$obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
Mail::Box::Locker::Multi->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
See "Error handling" in Mail::Reporter
$obj->errors()
See "Error handling" in Mail::Reporter
$obj->log([LEVEL [,STRINGS]])
Mail::Box::Locker::Multi->log([LEVEL [,STRINGS]])
See "Error handling" in Mail::Reporter
$obj->logPriority(LEVEL)
Mail::Box::Locker::Multi->logPriority(LEVEL)
See "Error handling" in Mail::Reporter
$obj->logSettings()
See "Error handling" in Mail::Reporter
$obj->notImplemented()
See "Error handling" in Mail::Reporter
$obj->report([LEVEL])
See "Error handling" in Mail::Reporter
$obj->reportAll([LEVEL])
See "Error handling" in Mail::Reporter
$obj->trace([LEVEL])
See "Error handling" in Mail::Reporter
$obj->warnings()
See "Error handling" in Mail::Reporter
Cleanup
$obj->DESTROY()
See "Cleanup" in Mail::Box::Locker
$obj->inGlobalDestruction()
See "Cleanup" in Mail::Reporter
DIAGNOSTICS
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 ALSO
This module is part of Mail-Box distribution version 2.105, built on May 07, 2012. Website: http://perl.overmeer.net/mailbox/
LICENSE
Copyrights 2001-2012 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
perl v5.14.2 2012-05-07 Mail::Box::Locker::Multi(3pm)