Mail::Box::Locker::Flock - lock a folder using kernel file-locking
Mail::Box::Locker::Flock is a Mail::Box::Locker is a Mail::Reporter
See Mail::Box::Locker
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.
::Flock
flock
File locking does not work in some situations, for instance for operating systems do not support flock.
Mail::Box::Locker::Flock->new(OPTIONS)
-Option --Defined in --Default expires Mail::Box::Locker 1 hour file Mail::Box::Locker undef folder Mail::Box::Locker <required> log Mail::Reporter 'WARNINGS' method Mail::Box::Locker 'FLOCK' timeout Mail::Box::Locker 10 seconds trace Mail::Reporter 'WARNINGS'
'WARNINGS'
'FLOCK'
. expires SECONDS
. file FILENAME
. folder FOLDER
. log LEVEL
. method STRING|CLASS|ARRAY
. timeout SECONDS|'NOTIMEOUT'
. trace LEVEL
$obj->filename([FILENAME])
See "The Locker" in Mail::Box::Locker
$obj->folder
$obj->name
$obj->hasLock
See "Locking" in Mail::Box::Locker
$obj->isLocked
$obj->lock
$obj->unlock
$obj->AUTOLOAD
See "Error handling" in Mail::Reporter
$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
$obj->DESTROY
See "Cleanup" in Mail::Box::Locker
$obj->inGlobalDestruction
See "Cleanup" in Mail::Reporter
Warning: Folder $folder already flocked
The folder is already locked, but you attempt to lock it again. The behavior of double flock's is platform dependend, and therefore should not be attempted. The second lock is ignored (but the unlock isn't)
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.
See the MailBox website at http://perl.overmeer.net/mailbox/ for more details.
Distribution version 2.066. 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.
To install Mail::Box, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Mail::Box
CPAN shell
perl -MCPAN -e shell install Mail::Box
For more information on module installation, please visit the detailed CPAN module installation guide.