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.

Extends "DESCRIPTION" in Mail::Box::Locker.

METHODS

Extends "METHODS" in Mail::Box::Locker.

Constructors

Extends "Constructors" in Mail::Box::Locker.

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
 trace         Mail::Reporter     'WARNINGS'

dotlock_file => FILENAME

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

Attributes

Extends "Attributes" in Mail::Box::Locker.

$obj->expires( [SECONDS] )

Inherited, see "Attributes" in Mail::Box::Locker

$obj->timeout( [SECONDS] )

Inherited, see "Attributes" in Mail::Box::Locker

The Locker

Extends "The Locker" in Mail::Box::Locker.

$obj->filename( [$filename] )

Inherited, see "The Locker" in Mail::Box::Locker

$obj->folder( [$folder] )

Inherited, see "The Locker" in Mail::Box::Locker

$obj->name()

Inherited, see "The Locker" in Mail::Box::Locker

Locking

Extends "Locking" in Mail::Box::Locker.

$obj->hasLock()

Inherited, see "Locking" in Mail::Box::Locker

$obj->isLocked()

Inherited, see "Locking" in Mail::Box::Locker

$obj->lock()

$obj->unlock()

Error handling

Extends "Error handling" in Mail::Box::Locker.

$obj->AUTOLOAD()

Inherited, see "Error handling" in Mail::Reporter

$obj->addReport($object)

Inherited, see "Error handling" in Mail::Reporter

$obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )

Mail::Box::Locker::DotLock->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )

Inherited, see "Error handling" in Mail::Reporter

$obj->errors()

Inherited, see "Error handling" in Mail::Reporter

$obj->log( [$level, [$strings]] )

Mail::Box::Locker::DotLock->log( [$level, [$strings]] )

Inherited, see "Error handling" in Mail::Reporter

$obj->logPriority($level)

Mail::Box::Locker::DotLock->logPriority($level)

Inherited, see "Error handling" in Mail::Reporter

$obj->logSettings()

Inherited, see "Error handling" in Mail::Reporter

$obj->notImplemented()

Inherited, see "Error handling" in Mail::Reporter

$obj->report( [$level] )

Inherited, see "Error handling" in Mail::Reporter

$obj->reportAll( [$level] )

Inherited, see "Error handling" in Mail::Reporter

$obj->trace( [$level] )

Inherited, see "Error handling" in Mail::Reporter

$obj->warnings()

Inherited, see "Error handling" in Mail::Reporter

Cleanup

Extends "Cleanup" in Mail::Box::Locker.

$obj->DESTROY()

Inherited, see "Cleanup" in Mail::Box::Locker

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

SEE ALSO

This module is part of Mail-Box distribution version 3.010, built on July 18, 2023. Website: http://perl.overmeer.net/CPAN/

LICENSE

Copyrights 2001-2023 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://dev.perl.org/licenses/

cpanm Mail::Box

perl -MCPAN -e shell
install Mail::Box