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 CW::Flock object lock the folder by creating an exclusive lock on the file using the kernel's CWflock 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 CWflock.

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'>

$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

$obj->hasLock See Locking in Mail::Box::Locker

$obj->isLocked

$obj->lock

$obj->unlock See Locking in Mail::Box::Locker

$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::Flock->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::Flock->log([LEVEL [,STRINGS]]) See Error handling in Mail::Reporter

$obj->logPriority(LEVEL)

Mail::Box::Locker::Flock->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

$obj->DESTROY See Cleanup in Mail::Box::Locker

$obj->inGlobalDestruction See Cleanup in Mail::Reporter

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.

Error: Unable to check lock file CW$filename for CW$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 CW$filename for CW$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 CW$filename for CW$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.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.