1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
=encoding utf8
=head1 NAME
Mail::Box::Locker::Multi - lock a folder in all ways which work
=head1 INHERITANCE
Mail::Box::Locker::Multi
is a Mail::Box::Locker
is a Mail::Reporter
=head1 SYNOPSIS
See Mail::Box::Locker
=head1 DESCRIPTION
The C<::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.
Extends L<"DESCRIPTION" in Mail::Box::Locker|Mail::Box::Locker/"DESCRIPTION">.
=head1 METHODS
Extends L<"METHODS" in Mail::Box::Locker|Mail::Box::Locker/"METHODS">.
=head2 Constructors
Extends L<"Constructors" in Mail::Box::Locker|Mail::Box::Locker/"Constructors">.
=over 4
=item $class-E<gt>B<new>(%options)
You may also pass all C<%options> understood by the initiated lockers
used by the multi locker.
Improves base, see L<Mail::Box::Locker/"METHODS">
-Option --Defined in --Default
expires Mail::Box::Locker 1 hour
file Mail::Box::Locker undef
folder Mail::Box::Locker <C<undef>>
method Mail::Box::Locker 'MULTI'
timeout Mail::Box::Locker 10
use <all possible>
=over 2
=item expires => $seconds
=item file => $file
=item folder => $folder
=item method => $name|CLASS|\@names
=item timeout => $seconds|'NOTIMEOUT'
=item 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 (preferably
to 1).
Some locking types are not available on some platforms, so they will
not be excluded from the default list (NFS POSIX Flock).
=back
ยป example: using a subset of multi-lockers
my $locker = Mail::Box::Locker::Multi->new(use => ['DOTLOCK','FLOCK']);
=back
=head2 Attributes
Extends L<"Attributes" in Mail::Box::Locker|Mail::Box::Locker/"Attributes">.
=over 4
=item $obj-E<gt>B<expires>( [SECONDS] )
Inherited, see L<Mail::Box::Locker/"Attributes">
=item $obj-E<gt>B<filename>( [$filename] )
Inherited, see L<Mail::Box::Locker/"Attributes">
=item $obj-E<gt>B<folder>( [$folder] )
Inherited, see L<Mail::Box::Locker/"Attributes">
=item $obj-E<gt>B<lockers>()
Returns a list with all locker objects used by this object.
=item $obj-E<gt>B<name>()
Inherited, see L<Mail::Box::Locker/"Attributes">
=item $obj-E<gt>B<timeout>( [SECONDS] )
Inherited, see L<Mail::Box::Locker/"Attributes">
=back
=head2 Locking
Extends L<"Locking" in Mail::Box::Locker|Mail::Box::Locker/"Locking">.
=over 4
=item $obj-E<gt>B<hasLock>()
Inherited, see L<Mail::Box::Locker/"Locking">
=item $obj-E<gt>B<isLocked>()
Inherited, see L<Mail::Box::Locker/"Locking">
=item $obj-E<gt>B<lock>($folder)
Inherited, see L<Mail::Box::Locker/"Locking">
=item $obj-E<gt>B<unlock>()
Inherited, see L<Mail::Box::Locker/"Locking">
=back
=head2 Error handling
Extends L<"Error handling" in Mail::Box::Locker|Mail::Box::Locker/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
Extends L<"Cleanup" in Mail::Box::Locker|Mail::Box::Locker/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
Inherited, see L<Mail::Box::Locker/"Cleanup">
=back
=head1 DIAGNOSTICS
=over 4
=item Error: class $package does not implement method $method.
Fatal error: the specific C<$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.
Cast by C<notImplemented()>
=back
=head1 SEE ALSO
This module is part of Mail-Box version 4.01,
built on December 13, 2025. Website: F<http://perl.overmeer.net/CPAN/>
=head1 LICENSE
For contributors see file ChangeLog.
This software is copyright (c) 2001-2025 by Mark Overmeer.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
|
