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  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>

. 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 Mail::Box::Locker/"The Locker"

$obj->folder

See Mail::Box::Locker/"The Locker"

$obj->lockers

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

$obj->name

See Mail::Box::Locker/"The Locker"

Locking

$obj->hasLock

See Mail::Box::Locker/"Locking"

$obj->isLocked

See Mail::Box::Locker/"Locking"

$obj->lock(FOLDER)

See Mail::Box::Locker/"Locking"

$obj->unlock

See Mail::Box::Locker/"Locking"

Error handling

$obj->AUTOLOAD

See Mail::Reporter/"Error handling"

$obj->addReport(OBJECT)

See Mail::Reporter/"Error handling"

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

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

See Mail::Reporter/"Error handling"

$obj->errors

See Mail::Reporter/"Error handling"

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

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

See Mail::Reporter/"Error handling"

$obj->logPriority(LEVEL)

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

See Mail::Reporter/"Error handling"

$obj->logSettings

See Mail::Reporter/"Error handling"

$obj->notImplemented

See Mail::Reporter/"Error handling"

$obj->report([LEVEL])

See Mail::Reporter/"Error handling"

$obj->reportAll([LEVEL])

See Mail::Reporter/"Error handling"

$obj->trace([LEVEL])

See Mail::Reporter/"Error handling"

$obj->warnings

See Mail::Reporter/"Error handling"

Cleanup

$obj->DESTROY

See Mail::Box::Locker/"Cleanup"

$obj->inGlobalDestruction

See Mail::Reporter/"Cleanup"

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.

LICENSE

Copyrights 2001-2008 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