Mail::Box::Locker::Multi - lock a folder in all ways which work

DIAGNOSTICS
REFERENCES
COPYRIGHTS

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)

 Option   Defined in       Default       
 expires  L<Mail::Box::Locker>  1 hour        
 file     L<Mail::Box::Locker>  undef         
 folder   L<Mail::Box::Locker>  <required>    
 log      L<Mail::Reporter>  C<'WARNINGS'> 
 method   L<Mail::Box::Locker>  C<'MULTI'>    
 timeout  L<Mail::Box::Locker>  10 seconds    
 trace    L<Mail::Reporter>  C<'WARNINGS'> 
 use                       <all possible>

. 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']);

The Locker

$obj->filename([FILENAME])

See The Locker in the Mail::Box::Locker manpage

$obj->folder

See The Locker in the Mail::Box::Locker manpage

$obj->lockers

Returns a list with all locker objects used by this object.

$obj->name

See The Locker in the Mail::Box::Locker manpage

Locking

$obj->hasLock

See Locking in the Mail::Box::Locker manpage

$obj->isLocked

See Locking in the Mail::Box::Locker manpage

$obj->lock(FOLDER)

See Locking in the Mail::Box::Locker manpage

$obj->unlock

See Locking in the Mail::Box::Locker manpage

Error handling

$obj->AUTOLOAD

See Error handling in the Mail::Reporter manpage

$obj->addReport(OBJECT)

See Error handling in the Mail::Reporter manpage

$obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

Mail::Box::Locker::Multi->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

See Error handling in the Mail::Reporter manpage

$obj->errors

See Error handling in the Mail::Reporter manpage

$obj->log([LEVEL [,STRINGS]])

Mail::Box::Locker::Multi->log([LEVEL [,STRINGS]])

See Error handling in the Mail::Reporter manpage

$obj->logPriority(LEVEL)

Mail::Box::Locker::Multi->logPriority(LEVEL)

See Error handling in the Mail::Reporter manpage

$obj->logSettings

See Error handling in the Mail::Reporter manpage

$obj->notImplemented

See Error handling in the Mail::Reporter manpage

$obj->report([LEVEL])

See Error handling in the Mail::Reporter manpage

$obj->reportAll([LEVEL])

See Error handling in the Mail::Reporter manpage

$obj->trace([LEVEL])

See Error handling in the Mail::Reporter manpage

$obj->warnings

See Error handling in the Mail::Reporter manpage

Cleanup

$obj->DESTROY

See Cleanup in the Mail::Box::Locker manpage

$obj->inGlobalDestruction

See Cleanup in the Mail::Reporter manpage

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.

REFERENCES

See the MailBox website at http://perl.overmeer.net/mailbox/ for more details.

COPYRIGHTS

Distribution version 2.059. Written by Mark Overmeer (mark@overmeer.net) See the ChangeLog for other contributors.

Mail::Box::Locker::Multi - lock a folder in all ways which work