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)

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

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

$obj->folder

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

$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

$obj->unlock

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::DotLock->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::DotLock->log([LEVEL [,STRINGS]])

See Mail::Reporter/"Error handling"

$obj->logPriority(LEVEL)

Mail::Box::Locker::DotLock->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

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