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::MULTI (3)

.ds Aq ’

NAME

Mail::Box::Locker::Multi - lock a folder in all ways which work

CONTENTS

INHERITANCE



 Mail::Box::Locker::Multi
   is a Mail::Box::Locker
   is a Mail::Reporter



SYNOPSIS



 See Mail::Box::Locker



DESCRIPTION

The ::Multi locker locks a folder in each way it can. This way, the chance is highest that any other program will leave the folder alone during our access to it.

NFS-lock and Flock are tried. More may be added when the ways to lock are extended. DotLock overlaps with NFS-lock, but NFS-lock is safer, so that version is preferred.

See documentation in the base class.

METHODS

See documentation in the base class.

    Constructors

See documentation in the base class.
Mail::Box::Locker::Multi-><B>newB>(OPTIONS) You may also pass all OPTIONS understood by the initiated lockers used by the multi locker.



 -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  MULTI
  timeout  Mail::Box::Locker  10 seconds
  trace    Mail::Reporter     WARNINGS
  use                         <all possible>



expires => SECONDS
file => FILENAME
folder => FOLDER
log => LEVEL
method => STRING|CLASS|ARRAY
timeout => SECONDS|’NOTIMEOUT
trace => LEVEL
use => ARRAY-of-(NAMES|LOCKER) Array of locker type NAMES or LOCKER objects to be used to lock one folder. The type NAMES are converted into objects. When you create your own LOCKER objects, be sure to set the timeout very short (preferrably to 1).

Some locking types are not available on some platforms, so they will not be excluded from the default list (NFS POSIX Flock).

example: using a subset of multi-lockers



 my $locker = Mail::Box::Locker::Multi->new(use => [DOTLOCK,FLOCK]);



    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>lockersB>() Returns a list with all locker objects used by this object.
$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>(FOLDER) See Locking in Mail::Box::Locker
$obj-><B>unlockB>() See Locking in Mail::Box::Locker

    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::Multi-><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::Multi-><B>logB>([LEVEL [,STRINGS]]) See Error handling in Mail::Reporter
$obj-><B>logPriorityB>(LEVEL)
Mail::Box::Locker::Multi-><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

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

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::MULTI (3) 2013-08-19

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