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

SYNOPSIS

 See Mail::Box::Locker

DESCRIPTION

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)

Name of the file to lock. By default, the folder's name is extended with .lock.

 -Option      --Defined in     --Default
  dotlock_file                   undef
  expires       Mail::Box::Locker  1 hour
  file          Mail::Box::Locker  <folderfile>.lock
  folder        Mail::Box::Locker  <undef>
  log           Mail::Reporter   'WARNINGS'
  method        Mail::Box::Locker  'DOTLOCK'
  timeout       Mail::Box::Locker  10 seconds
  trace         Mail::Reporter   'WARNINGS'

dotlock_file => <undef>: Alternative name for file, especially useful to confusion when the multi locker is used.
expires => SECONDS
file => FILENAME
folder => FOLDER
log => LEVEL
method => STRING|CLASS|ARRAY
timeout => SECONDS|'NOTIMEOUT'
trace => LEVEL

The Locker

$obj->filename([FILENAME]): See "The Locker" in Mail::Box::Locker
$obj->folder([FOLDER]): See "The Locker" in Mail::Box::Locker
$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
$obj->unlock

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::DotLock->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::DotLock->log([LEVEL [,STRINGS]]): See "Error handling" in Mail::Reporter
$obj->logPriority(LEVEL)
Mail::Box::Locker::DotLock->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

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

LICENSE

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