/ 
Mail-Box-2.062
River stage one • 8 direct dependents • 8 total dependents
/ Mail::Box::Locker::DotLock

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  L<Mail::Box::Locker>  1 hour              
file                      <folderfile>C<.lock>
folder   L<Mail::Box::Locker>  <required>          
log      L<Mail::Reporter>  C<'WARNINGS'>       
method   L<Mail::Box::Locker>  C<'DOTLOCK'>        
timeout  L<Mail::Box::Locker>  10 seconds          
trace    L<Mail::Reporter>  C<'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 "The Locker" in Mail::Box::Locker

$obj->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(FOLDER)

See "Locking" in Mail::Box::Locker

$obj->unlock

See "Locking" in Mail::Box::Locker

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

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.

REFERENCES

See the MailBox website at http://perl.overmeer.net/mailbox/ for more details.

COPYRIGHTS

Distribution version 2.062. Written by Mark Overmeer (mark@overmeer.net). See the ChangeLog for other contributors.

Copyright (c) 2001-2003 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.