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
299
300
301
302
303
|
=head1 NAME
Mail::Box::Locker::Flock - lock a folder using kernel file-locking
=head1 INHERITANCE
Mail::Box::Locker::Flock
is a Mail::Box::Locker
is a Mail::Reporter
=head1 SYNOPSIS
See Mail::Box::Locker
=head1 DESCRIPTION
The C<::Flock> object lock the folder by creating an exclusive lock on
the file using the kernel's C<flock> facilities. This lock is created
on a separate file-handle to the folder file, so not the handle which
is reading.
File locking does not work in some situations, for instance for
operating systems do not support C<flock>.
=head1 METHODS
=head2 Constructors
Mail::Box::Locker::Flock-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 'FLOCK'
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
=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::Flock-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::Flock-E<gt>B<log>([LEVEL [,STRINGS]])
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<logPriority>(LEVEL)
Mail::Box::Locker::Flock-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 flocked
The folder is already locked, but you attempt to lock it again. The
behavior of double flock's is platform dependend, and therefore should
not be attempted. The second lock is ignored (but the unlock isn't)
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<Error:> Unable to check lock file $filename for $folder: $!
To check whether the filename is used to flock a folder, the file must be
opened. Apparently this fails, which does not mean that the folder is
locked neither that it is unlocked.
I<Error:> Unable to open flock file $filename for $folder: $!
For flock-ing a folder it must be opened, which does not succeed for the
specified reason.
I<Error:> Will never get a flock at $filename for $folder: $!
Tried to flock the folder, but it did not succeed. The error code received
from the OS indicates that it will not succeed ever, so we do not need to
try again.
=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.
|
