NAME
Mail::Box::Locker::DotLock - lock a folder with a separate file
INHERITANCE
Mail::Box::Locker::DotLock
is a Mail::Box::Locker
is a Mail::ReporterSYNOPSIS
See Mail::Box::LockerDESCRIPTION
The ::DotLock object lock the folder by creating a file with the same name as the folder, extended by .lock.
METHODS
Constructors
Mail::Box::Locker::DotLock->new(OPTIONS)
Option --Defined in --Default
expires Mail::Box::Locker 1 hour
file <folderfile>.lock
folder Mail::Box::Locker <required>
log Mail::Reporter 'WARNINGS'
method Mail::Box::Locker 'DOTLOCK'
timeout Mail::Box::Locker 10 seconds
trace Mail::Reporter 'WARNINGS'. expires SECONDS
. file FILENAME
Name of the file to lock. By default, the folder's name is extended with .lock.
. folder FOLDER
. log LEVEL
. method STRING|CLASS|ARRAY
. timeout SECONDS|'NOTIMEOUT'
. trace LEVEL
The Locker
$obj->filename([FILENAME])
$obj->folder
$obj->name
Locking
$obj->hasLock
$obj->isLocked
$obj->lock
$obj->unlock
Error handling
$obj->AUTOLOAD
$obj->addReport(OBJECT)
$obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
Mail::Box::Locker::DotLock->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
$obj->errors
$obj->log([LEVEL [,STRINGS]])
Mail::Box::Locker::DotLock->log([LEVEL [,STRINGS]])
$obj->logPriority(LEVEL)
Mail::Box::Locker::DotLock->logPriority(LEVEL)
$obj->logSettings
$obj->notImplemented
$obj->report([LEVEL])
$obj->reportAll([LEVEL])
$obj->trace([LEVEL])
$obj->warnings
Cleanup
$obj->DESTROY
$obj->inGlobalDestruction
DIAGNOSTICS
Warning: Couldn't remove lockfile $lock: $!
Error: Failed to remove expired lockfile $lockfile: $!
Warning: Folder already locked with file $lockfile
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.
Warning: Removed expired lockfile $lockfile
REFERENCES
See the MailBox website at http://perl.overmeer.net/mailbox/ for more details.
COPYRIGHTS
Distribution version 2.068. Written by Mark Overmeer (mark@overmeer.net). See the ChangeLog for other contributors.
Copyright (c) 2001-2006 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.