/usr/share/perl5/Mail/Box/Locker/FcntlLock.pod is in libmail-box-perl 2.117-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | =encoding utf8
=head1 NAME
Mail::Box::Locker::FcntlLock - lock a folder using File::FcntlLock
=head1 INHERITANCE
Mail::Box::Locker::FcntlLock
is a Mail::Box::Locker
is a Mail::Reporter
=head1 SYNOPSIS
See Mail::Box::Locker
=head1 DESCRIPTION
This locker object is uses File::FcntlLock, and was contributed by
Jim in Aus. It is close to L<Mail::Box::Locker::POSIX|Mail::Box::Locker::POSIX>, but does work
on more systems, for instance Darwin.
You will need to install File::FcntlLock separately: there is no
dependency to it by the MailBox distribution.
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 Mail::Box::Locker::FcntlLock-E<gt>B<new>(%options)
-Option --Defined in --Default
expires Mail::Box::Locker 1 hour
file Mail::Box::Locker undef
folder Mail::Box::Locker <undef>
log Mail::Reporter 'WARNINGS'
method Mail::Box::Locker FcntlLock
timeout Mail::Box::Locker 10 seconds
trace Mail::Reporter 'WARNINGS'
=over 2
=item expires => SECONDS
=item file => FILENAME
=item folder => FOLDER
=item log => LEVEL
=item method => STRING|CLASS|ARRAY
=item timeout => SECONDS|'NOTIMEOUT'
=item trace => LEVEL
=back
=back
=head2 The Locker
Extends L<"The Locker" in Mail::Box::Locker|Mail::Box::Locker/"The Locker">.
=over 4
=item $obj-E<gt>B<filename>( [$filename] )
Inherited, see L<Mail::Box::Locker/"The Locker">
=item $obj-E<gt>B<folder>( [$folder] )
Inherited, see L<Mail::Box::Locker/"The Locker">
=item $obj-E<gt>B<name>()
Inherited, see L<Mail::Box::Locker/"The Locker">
=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>()
=item $obj-E<gt>B<lock>()
=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<addReport>($object)
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
=item Mail::Box::Locker::FcntlLock-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<log>( [$level, [$strings]] )
=item Mail::Box::Locker::FcntlLock-E<gt>B<log>( [$level, [$strings]] )
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logPriority>($level)
=item Mail::Box::Locker::FcntlLock-E<gt>B<logPriority>($level)
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<report>( [$level] )
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<reportAll>( [$level] )
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<trace>( [$level] )
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
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 Warning: Folder $folder already lockf'd
=item 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.
=item 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.
=item Error: Unable to open FcntlLock lock file $filename for $folder: $!
For FcntlLock style locking, a folder it must be opened, which does not
succeed for the specified reason.
=item Error: Will never get a FcntlLock lock at $filename for $folder: $!
Tried to lock 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.
=back
=head1 SEE ALSO
This module is part of Mail-Box distribution version 2.117,
built on August 24, 2014. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
Copyrights 2001-2014 by [Mark Overmeer]. For other contributors see ChangeLog.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
See F<http://www.perl.com/perl/misc/Artistic.html>
|