GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  MAIL::BOX::LOCKER::DOTLOCK (3)

.ds Aq ’

NAME

Mail::Box::Locker::DotLock - lock a folder with a separate file

CONTENTS

INHERITANCE



 Mail::Box::Locker::DotLock
   is a Mail::Box::Locker
   is a Mail::Reporter



SYNOPSIS



 See Mail::Box::Locker



DESCRIPTION

The ::DotLock object lock the folder by creating a file with the same name as the folder, extended by .lock.

See documentation in the base class.

METHODS

See documentation in the base class.

    Constructors

See documentation in the base class.
Mail::Box::Locker::DotLock-><B>newB>(OPTIONS) Name of the file to lock. By default, the folder’s name is extended with .lock.



 -Option      --Defined in       --Default
  dotlock_file                     <undef>
  expires       Mail::Box::Locker  1 hour
  file          Mail::Box::Locker  <folderfile>.lock
  folder        Mail::Box::Locker  <undef>
  log           Mail::Reporter     WARNINGS
  method        Mail::Box::Locker  DOTLOCK
  timeout       Mail::Box::Locker  10 seconds
  trace         Mail::Reporter     WARNINGS



dotlock_file => FILENAME Alternative name for file, especially useful to confusion when the multi locker is used.
expires => SECONDS
file => FILENAME
folder => FOLDER
log => LEVEL
method => STRING|CLASS|ARRAY
timeout => SECONDS|’NOTIMEOUT
trace => LEVEL

    The Locker

See documentation in the base class.
$obj-><B>filenameB>([FILENAME]) See The Locker in Mail::Box::Locker
$obj-><B>folderB>([FOLDER]) See The Locker in Mail::Box::Locker
$obj-><B>nameB>() See The Locker in Mail::Box::Locker

    Locking

See documentation in the base class.
$obj-><B>hasLockB>() See Locking in Mail::Box::Locker
$obj-><B>isLockedB>() See Locking in Mail::Box::Locker
$obj-><B>lockB>()
$obj-><B>unlockB>()

    Error handling

See documentation in the base class.
$obj-><B>AUTOLOADB>() See Error handling in Mail::Reporter
$obj-><B>addReportB>(OBJECT) See Error handling in Mail::Reporter
$obj-><B>defaultTraceB>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
Mail::Box::Locker::DotLock-><B>defaultTraceB>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK]) See Error handling in Mail::Reporter
$obj-><B>errorsB>() See Error handling in Mail::Reporter
$obj-><B>logB>([LEVEL [,STRINGS]])
Mail::Box::Locker::DotLock-><B>logB>([LEVEL [,STRINGS]]) See Error handling in Mail::Reporter
$obj-><B>logPriorityB>(LEVEL)
Mail::Box::Locker::DotLock-><B>logPriorityB>(LEVEL) See Error handling in Mail::Reporter
$obj-><B>logSettingsB>() See Error handling in Mail::Reporter
$obj-><B>notImplementedB>() See Error handling in Mail::Reporter
$obj-><B>reportB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>reportAllB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>traceB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>warningsB>() See Error handling in Mail::Reporter

    Cleanup

See documentation in the base class.
$obj-><B>DESTROYB>() See Cleanup in Mail::Box::Locker

DIAGNOSTICS

Warning: Couldn’t remove lockfile $lock: $!
Error: Failed to remove expired lockfile $lockfile: $!
Warning: Folder already locked with file $lockfile
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.
Warning: Removed expired lockfile $lockfile

SEE ALSO

This module is part of Mail-Box distribution version 2.109, built on August 19, 2013. Website: http://perl.overmeer.net/mailbox/

LICENSE

Copyrights 2001-2013 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

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 MAIL::BOX::LOCKER::DOTLOCK (3) 2013-08-19

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.