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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
|
=head1 NAME
Mail::Box::Locker::NFS - lock a folder with a separate file, NFS-safe
=head1 INHERITANCE
Mail::Box::Locker::NFS
is a Mail::Box::Locker
is a Mail::Reporter
=head1 SYNOPSIS
See Mail::Box::Locker
=head1 DESCRIPTION
Like the C<::DotLock> locker, but then in an NFS-safe fashion. Over NFS,
the creation of a file is not atomic. The C<::DotLock> locker depends
on an atomic C<open> system call, hence in not usable to lock a folder
which accessed over NFS. The C<::NFS>
locker is therefore more complicated (so therefore slower), but will work
for NFS --and for local disks as well.
=head1 METHODS
=head2 Constructors
Mail::Box::Locker::NFS-E<gt>B<new>(OPTIONS)
=over 4
Option --Defined in --Default
expires Mail::Box::Locker 1 hour
file Mail::Box::Locker undef
folder Mail::Box::Locker <required>
log Mail::Reporter 'WARNINGS'
method Mail::Box::Locker 'NFS'
timeout Mail::Box::Locker 10 seconds
trace Mail::Reporter 'WARNINGS'
. expires SECONDS
. file FILENAME
. folder FOLDER
. log LEVEL
. method STRING|CLASS|ARRAY
. timeout SECONDS|'NOTIMEOUT'
. trace LEVEL
=back
=head2 The Locker
$obj-E<gt>B<filename>([FILENAME])
=over 4
See L<Mail::Box::Locker/"The Locker">
=back
$obj-E<gt>B<folder>
=over 4
See L<Mail::Box::Locker/"The Locker">
=back
$obj-E<gt>B<name>
=over 4
See L<Mail::Box::Locker/"The Locker">
=back
=head2 Locking
$obj-E<gt>B<hasLock>
=over 4
See L<Mail::Box::Locker/"Locking">
=back
$obj-E<gt>B<isLocked>
=over 4
See L<Mail::Box::Locker/"Locking">
=back
$obj-E<gt>B<lock>
=over 4
=back
$obj-E<gt>B<unlock>
=over 4
See L<Mail::Box::Locker/"Locking">
=back
=head2 Error handling
$obj-E<gt>B<AUTOLOAD>
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<addReport>(OBJECT)
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
Mail::Box::Locker::NFS-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<errors>
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<log>([LEVEL [,STRINGS]])
Mail::Box::Locker::NFS-E<gt>B<log>([LEVEL [,STRINGS]])
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<logPriority>(LEVEL)
Mail::Box::Locker::NFS-E<gt>B<logPriority>(LEVEL)
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<logSettings>
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<notImplemented>
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<report>([LEVEL])
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<reportAll>([LEVEL])
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<trace>([LEVEL])
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<warnings>
=over 4
See L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
$obj-E<gt>B<DESTROY>
=over 4
See L<Mail::Box::Locker/"Cleanup">
=back
$obj-E<gt>B<inGlobalDestruction>
=over 4
See L<Mail::Reporter/"Cleanup">
=back
=head1 DIAGNOSTICS
I<Warning:> Folder $folder already locked over nfs
Do not try to lock the folder when the application already has the
lock: it will give you dead-locks.
I<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.
I<Warning:> Removed expired lockfile $filename.
A lock file was found which was older than the expiration period as
specified with L<new(timeout)|Mail::Box::Locker/"METHODS">. The lock file was succesfully
removed.
I<Error:> Unable to remove expired lockfile $lockfile: $!
A lock file was found which was older than the expiration period as
specified with the L<new(timeout)|Mail::Box::Locker/"METHODS"> option. It is impossible to remove that
lock file, so we need to wait until it vanishes by some external cause.
=head1 REFERENCES
See the MailBox website at L<http://perl.overmeer.net/mailbox/> for more details.
=head1 COPYRIGHTS
Distribution version 2.068.
Written by Mark Overmeer (mark@overmeer.net). See the ChangeLog for
other contributors.
Copyright (c) 2001-2006 by the author(s). All rights reserved.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
|
