1Mail::Box::Locker::MultUis(e3r)Contributed Perl DocumentMaatiilo:n:Box::Locker::Multi(3)
2
3
4

NAME

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

INHERITANCE

9        Mail::Box::Locker::Multi
10          is a Mail::Box::Locker
11          is a Mail::Reporter
12

SYNOPSIS

14        See Mail::Box::Locker
15

DESCRIPTION

17       The "::Multi" locker locks a folder in each way it can.  This way, the
18       chance is highest that any other program will leave the folder alone
19       during our access to it.
20
21       NFS-lock and Flock are tried.  More may be added when the ways to lock
22       are extended.  DotLock overlaps with NFS-lock, but NFS-lock is safer,
23       so that version is preferred.
24

METHODS

26       Constructors
27
28       Mail::Box::Locker::Multi->new(OPTIONS)
29
30        Option --Defined in     --Default
31        expires  Mail::Box::Locker  1 hour
32        file     Mail::Box::Locker  undef
33        folder   Mail::Box::Locker  <required>
34        log      Mail::Reporter   'WARNINGS'
35        method   Mail::Box::Locker  'MULTI'
36        timeout  Mail::Box::Locker  10 seconds
37        trace    Mail::Reporter   'WARNINGS'
38        use                       <all possible>
39
40           . expires SECONDS
41
42           . file FILENAME
43
44           . folder FOLDER
45
46           . log LEVEL
47
48           . method STRING⎪CLASS⎪ARRAY
49
50           . timeout SECONDS⎪'NOTIMEOUT'
51
52           . trace LEVEL
53
54           . use ARRAY
55
56               Array of locker types and locker objects to be used to lock one
57               folder.  The type names are converted into objects.
58
59               Some locking types are not available on some platforms, so they
60               will not be excluded from the default list (NFS POSIX Flock).
61
62           Example: using a subset of multi-lockers
63
64            my $locker = Mail::Box::Locker::Multy->new(use => ['DOTLOCK','FLOCK']);
65
66       The Locker
67
68       $obj->filename([FILENAME])
69
70           See "The Locker" in Mail::Box::Locker
71
72       $obj->folder
73
74           See "The Locker" in Mail::Box::Locker
75
76       $obj->lockers
77
78           Returns a list with all locker objects used by this object.
79
80       $obj->name
81
82           See "The Locker" in Mail::Box::Locker
83
84       Locking
85
86       $obj->hasLock
87
88           See "Locking" in Mail::Box::Locker
89
90       $obj->isLocked
91
92           See "Locking" in Mail::Box::Locker
93
94       $obj->lock(FOLDER)
95
96           See "Locking" in Mail::Box::Locker
97
98       $obj->unlock
99
100           See "Locking" in Mail::Box::Locker
101
102       Error handling
103
104       $obj->AUTOLOAD
105
106           See "Error handling" in Mail::Reporter
107
108       $obj->addReport(OBJECT)
109
110           See "Error handling" in Mail::Reporter
111
112       $obj->defaultTrace([LEVEL]⎪[LOGLEVEL, TRACELEVEL]⎪[LEVEL, CALLBACK])
113
114       Mail::Box::Locker::Multi->defaultTrace([LEVEL]⎪[LOGLEVEL,
115       TRACELEVEL]⎪[LEVEL, CALLBACK])
116
117           See "Error handling" in Mail::Reporter
118
119       $obj->errors
120
121           See "Error handling" in Mail::Reporter
122
123       $obj->log([LEVEL [,STRINGS]])
124
125       Mail::Box::Locker::Multi->log([LEVEL [,STRINGS]])
126
127           See "Error handling" in Mail::Reporter
128
129       $obj->logPriority(LEVEL)
130
131       Mail::Box::Locker::Multi->logPriority(LEVEL)
132
133           See "Error handling" in Mail::Reporter
134
135       $obj->logSettings
136
137           See "Error handling" in Mail::Reporter
138
139       $obj->notImplemented
140
141           See "Error handling" in Mail::Reporter
142
143       $obj->report([LEVEL])
144
145           See "Error handling" in Mail::Reporter
146
147       $obj->reportAll([LEVEL])
148
149           See "Error handling" in Mail::Reporter
150
151       $obj->trace([LEVEL])
152
153           See "Error handling" in Mail::Reporter
154
155       $obj->warnings
156
157           See "Error handling" in Mail::Reporter
158
159       Cleanup
160
161       $obj->DESTROY
162
163           See "Cleanup" in Mail::Box::Locker
164
165       $obj->inGlobalDestruction
166
167           See "Cleanup" in Mail::Reporter
168

DIAGNOSTICS

170       Error: Package $package does not implement $method.
171
172       Fatal error: the specific package (or one of its superclasses) does not
173       implement this method where it should. This message means that some
174       other related classes do implement this method however the class at
175       hand does not.  Probably you should investigate this and probably
176       inform the author of the package.
177

SEE ALSO

179       This module is part of Mail-Box distribution version 2.070, built on
180       March 25, 2007. Website: http://perl.overmeer.net/mailbox/
181

LICENSE

183       Copyrights 2001-2007 by Mark Overmeer.For other contributors see
184       ChangeLog.
185
186       This program is free software; you can redistribute it and/or modify it
187       under the same terms as Perl itself.  See
188       http://www.perl.com/perl/misc/Artistic.html
189
190
191
192perl v5.8.8                       2007-03-25       Mail::Box::Locker::Multi(3)
Impressum