Mail::Box::Locker::FcntlLock(3pm)			User Contributed Perl Documentation			 Mail::Box::Locker::FcntlLock(3pm)

NAME

       Mail::Box::Locker::FcntlLock - lock a folder using File::FcntlLock

INHERITANCE

	Mail::Box::Locker::FcntlLock
	  is a Mail::Box::Locker
	  is a Mail::Reporter

SYNOPSIS

	See Mail::Box::Locker

DESCRIPTION

       This locker object is uses File::FcntlLock, and was contributed by Jim in Aus. It is close to Mail::Box::Locker::POSIX, but does work on
       more systems, for instance Darwin.

       You will need to install File::FcntlLock separately: there is no dependency to it by the MailBox distribution.

METHODS

   Constructors
       Mail::Box::Locker::FcntlLock->new(OPTIONS)
	    -Option --Defined in     --Default
	     expires  Mail::Box::Locker  1 hour
	     file     Mail::Box::Locker  undef
	     folder   Mail::Box::Locker  <undef>
	     log      Mail::Reporter   'WARNINGS'
	     method   Mail::Box::Locker  FcntlLock
	     timeout  Mail::Box::Locker  10 seconds
	     trace    Mail::Reporter   '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([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()
       $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::FcntlLock->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::FcntlLock->log([LEVEL [,STRINGS]])
	   See "Error handling" in Mail::Reporter

       $obj->logPriority(LEVEL)
       Mail::Box::Locker::FcntlLock->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

       Warning: Folder $folder already lockf'd
       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 FcntlLock lock file $filename for $folder: $!
	   For FcntlLock style locking, a folder it must be opened, which does not succeed for the specified reason.

       Error: Will never get a FcntlLock 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.

SEE ALSO

       This module is part of Mail-Box distribution version 2.105, built on May 07, 2012. Website: http://perl.overmeer.net/mailbox/

LICENSE

       Copyrights 2001-2012 by [Mark Overmeer]. For other contributors see ChangeLog.

       This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.  See
       http://www.perl.com/perl/misc/Artistic.html

perl v5.14.2							    2012-05-07					 Mail::Box::Locker::FcntlLock(3pm)