NAME¶

INHERITANCE¶

 Mail::Box::Locker
   is a Mail::Reporter
 Mail::Box::Locker is extended by
   Mail::Box::Locker::DotLock
   Mail::Box::Locker::FcntlLock
   Mail::Box::Locker::Flock
   Mail::Box::Locker::Multi
   Mail::Box::Locker::Mutt
   Mail::Box::Locker::NFS
   Mail::Box::Locker::POSIX

SYNOPSIS¶

 use Mail::Box::Locker;
 my $locker = new Mail::Box::Locker(folder => $folder);
 $locker->lock;
 $locker->isLocked;
 $locker->hasLock;
 $locker->unlock;
 use Mail::Box;
 my $folder = Mail::Box->new(lock_method => 'DOTLOCK');
 print $folder->locker->type;

DESCRIPTION¶

METHODS¶

Constructors¶

Mail::Box::Locker->new(OPTIONS)

Create a new lock. You may do this directly. However, in most cases the lock will not be separately instantiated but will be the second class in a multiple inheritance construction with a Mail::Box.

 

Generally the client program specifies the locking behavior through options given to the folder class.

 

 -Option --Defined in     --Default
  expires                   1 hour
  file                      undef
  folder                    <undef>
  log      Mail::Reporter   'WARNINGS'
  method                    'DOTLOCK'
  timeout                   10 seconds
  trace    Mail::Reporter   'WARNINGS'
    

 my $locker = Mail::Box::Locker::MyOwn->new;
 $folder->open(locker => $locker);

The Locker¶

$obj->filename([FILENAME])

Returns the filename which is used to lock the folder, optionally after setting it to the specified FILENAME.

 

example:

 

 print $locker->filename;
    

$obj->folder([FOLDER])

Returns the folder object which is locker.

$obj->name()

Returns the method used to lock the folder. See the new(method) for details on how to specify the lock method. The name of the method is returned in upper-case.

 

example:

 

 if($locker->name eq 'FLOCK') ...
    

Locking¶

$obj->hasLock()

Check whether the folder has the lock.

 

example:

 

 if($locker->hasLock) {...}
 if($folder->locker->hasLock) {...}
    

$obj->isLocked()

Test if the folder is locked by this or a different application.

 

example:

 

 if($locker->isLocked) {...}
 if($folder->locker->isLocked) {...}
    

$obj->lock(FOLDER)

Get a lock on a folder. This will return false if the lock fails.

 

example:

 

 die unless $locker->lock;
 if($folder->locker->lock) {...}
    

$obj->unlock()

Undo the lock on a folder.

 

example:

 

 $locker->unlock;
 $folder->locker->unlock;
    

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->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->log([LEVEL [,STRINGS]])

See "Error handling" in Mail::Reporter

$obj->logPriority(LEVEL)

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

When the locker is destroyed, for instance when the folder is closed or the program ends, the lock will be automatically removed.

$obj->inGlobalDestruction()

See "Cleanup" in Mail::Reporter

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.

SEE ALSO¶

LICENSE¶