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
|
=encoding utf8
=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 the generic Mail::Box::Locker interface
=head1 DESCRIPTION
The C<::Flock> object locks 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>.
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)
Inherited, 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 'FLOCK'
timeout Mail::Box::Locker 10
=over 2
=item expires => $seconds
=item file => $file
=item folder => $folder
=item method => $name|CLASS|\@names
=item timeout => $seconds|'NOTIMEOUT'
=back
=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<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>()
Acquire a lock on the folder.
Improves base, 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()>
=item Warning: folder $name already flocked.
The folder is already locked, but you attempt to lock it again. The
behavior of double flock's is platform dependent, and therefore should
not be attempted. The second lock is ignored (but the unlock isn't).
Cast by C<lock()>
=item Fault: unable to check lock file $file for $folder: $!
To check whether the C<$file> is used to C<flock> a C<$folder>, the file must be
opened. Apparently this fails, which does not mean that the folder is
locked neither that it is unlocked.
Cast by C<isLocked()>
=item Fault: unable to open flock file $file for $folder: $!
For C<flock>-ing a C<$folder> it must be opened, which does not succeed for the
specified reason.
Cast by C<lock()>
=item Fault: will never get a flock at $file for $folder: $!
Tried to C<flock> the C<$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.
Cast by C<lock()>
=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.
|
