Mail::Box::Locker::POSIX - lock a folder using kernel file-locking

DIAGNOSTICS
REFERENCES
COPYRIGHTS

NAME

Mail::Box::Locker::POSIX - lock a folder using kernel file-locking

INHERITANCE

 Mail::Box::Locker::POSIX
   is a Mail::Box::Locker
   is a Mail::Reporter

SYNOPSIS

 See Mail::Box::Locker

DESCRIPTION

This locker object is created by the folder to get an exclusive lock on the file which contains the data using the kernel's POSIX facilities. This lock is created on a separate file-handle to the folder file, so not the handle which is reading. Not all platforms support POSIX locking.

METHODS

Constructors

Mail::Box::Locker::POSIX->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<POSIX>     
 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 the Mail::Box::Locker manpage

$obj->folder

See The Locker in the Mail::Box::Locker manpage

$obj->name

See The Locker in the Mail::Box::Locker manpage

Locking

$obj->hasLock

See Locking in the Mail::Box::Locker manpage

$obj->isLocked

$obj->lock

$obj->unlock

See Locking in the Mail::Box::Locker manpage

Error handling

$obj->AUTOLOAD

See Error handling in the Mail::Reporter manpage

$obj->addReport(OBJECT)

See Error handling in the Mail::Reporter manpage

$obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

Mail::Box::Locker::POSIX->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

See Error handling in the Mail::Reporter manpage

$obj->errors

See Error handling in the Mail::Reporter manpage

$obj->log([LEVEL [,STRINGS]])

Mail::Box::Locker::POSIX->log([LEVEL [,STRINGS]])

See Error handling in the Mail::Reporter manpage

$obj->logPriority(LEVEL)

Mail::Box::Locker::POSIX->logPriority(LEVEL)

See Error handling in the Mail::Reporter manpage

$obj->logSettings

See Error handling in the Mail::Reporter manpage

$obj->notImplemented

See Error handling in the Mail::Reporter manpage

$obj->report([LEVEL])

See Error handling in the Mail::Reporter manpage

$obj->reportAll([LEVEL])

See Error handling in the Mail::Reporter manpage

$obj->trace([LEVEL])

See Error handling in the Mail::Reporter manpage

$obj->warnings

See Error handling in the Mail::Reporter manpage

Cleanup

$obj->DESTROY

See Cleanup in the Mail::Box::Locker manpage

$obj->inGlobalDestruction

See Cleanup in the Mail::Reporter manpage

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 POSIX lock file $filename for $folder: $!

For POSIX style locking, a folder it must be opened, which does not succeed for the specified reason.

Error: Will never get a POSIX lock at $filename for $folder: $!

Tried to lock 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.059. Written by Mark Overmeer (mark@overmeer.net) See the ChangeLog for other contributors.

Mail::Box::Locker::POSIX - lock a folder using kernel file-locking