NAME
Mail::Box::Locker::Flock - lock a folder using kernel file-locking
INHERITANCE
Mail::Box::Locker::Flock
is a Mail::Box::Locker
is a Mail::ReporterSYNOPSIS
See Mail::Box::LockerDESCRIPTION
The ::Flock object lock the folder by creating an exclusive lock on the file using the kernel's flock facilities. This lock is created on a separate file-handle to the folder file, so not the handle which is reading.
File locking does not work in some situations, for instance for operating systems do not support flock.
METHODS
Constructors
Mail::Box::Locker::Flock->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<'FLOCK'>
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])
$obj->folder
$obj->name
Locking
$obj->hasLock
$obj->isLocked
$obj->lock
$obj->unlock
Error handling
$obj->AUTOLOAD
$obj->addReport(OBJECT)
$obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
Mail::Box::Locker::Flock->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
$obj->errors
$obj->log([LEVEL [,STRINGS]])
Mail::Box::Locker::Flock->log([LEVEL [,STRINGS]])
$obj->logPriority(LEVEL)
Mail::Box::Locker::Flock->logPriority(LEVEL)
$obj->logSettings
$obj->notImplemented
$obj->report([LEVEL])
$obj->reportAll([LEVEL])
$obj->trace([LEVEL])
$obj->warnings
Cleanup
$obj->DESTROY
$obj->inGlobalDestruction
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.
Error: Unable to check lock file $filename for $folder: $!
To check whether the filename is used to flock a folder, the file must be opened. Apparently this fails, which does not mean that the folder is locked neither that it is unlocked.
Error: Unable to open flock file $filename for $folder: $!
For flock-ing a folder it must be opened, which does not succeed for the specified reason.
Error: Will never get a flock at $filename for $folder: $!
Tried to flock the folder, but it did not succeed. The error code received from the OS indicates that it will not succeed ever, so we do not need to try again.
REFERENCES
See the MailBox website at http://perl.overmeer.net/mailbox/ for more details.
COPYRIGHTS
Distribution version 2.064. 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.