man Mail::Box::Locker::NFS () - lock a folder with a separate file, NFS-safe

NAME

Mail::Box::Locker::NFS - lock a folder with a separate file, NFS-safe

INHERITANCE

 Mail::Box::Locker::NFS
   is a Mail::Box::Locker
   is a Mail::Reporter

SYNOPSIS

 See Mail::Box::Locker

DESCRIPTION

Like the CW::DotLock locker, but then in an NFS-safe fashion. Over NFS, the creation of a file is not atomic. The CW::DotLock locker depends on an atomic CWopen system call, hence in not usable to lock a folder which accessed over NFS. The CW::NFS locker is therefore more complicated (so therefore slower), but will work for NFS --and for local disks as well.

METHODS

Constructors

Mail::Box::Locker::NFS->new(OPTIONS)

 Option   Defined in       Default      
 expires  L<Mail::Box::Locker>  1 hour       
 file     L<Mail::Box::Locker>  undef        
 folder   L<Mail::Box::Locker>  <required>   
 log      L<Mail::Reporter>  C<'WARNINGS'>
 method   L<Mail::Box::Locker>  C<'NFS'>     
 timeout  L<Mail::Box::Locker>  10 seconds   
 trace    L<Mail::Reporter>  C<'WARNINGS'>
. 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 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 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::NFS->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::NFS->log([LEVEL [,STRINGS]]) See Error handling in Mail::Reporter

$obj->logPriority(LEVEL)

Mail::Box::Locker::NFS->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 CW$package does not implement CW$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 CW$filename.

A lock file was found which was older than the expiration period as specified with new(timeout). The lock file was succesfully removed.

Error: Unable to remove expired lockfile CW$lockfile: $!

A lock file was found which was older than the expiration period as specified with the new(timeout) option. It is impossible to remove that lock file, so we need to wait until it vanishes by some external cause.

REFERENCES

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

COPYRIGHTS

Distribution version 2.063. 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.