File::LockDir - basic filename-level lock utility
This document describes File::LockDir version 0.01
use File::LockDir;
Initializes the class. Returns the singleton object.
Locks the supplied filename. Only $file is required.
$file is the file to be locked; $nap_till is the total amount of time to wait before giving up; $locker is a name identifying the locker; $lockhost is the host requesting the lock.
Unlocks the supplied file.
Checks the state of the lock for the supplied file. Returns a list: the first item is true if the file is unlocked, and false if not; the second item is undef if the file is unlocked, and the identity (name and host) is it is locked.
%s already locked
Seen when you've already locked the requested pathname. Informational only.
No pathname to be locked
You didn't supply a pathname to be locked to nflock. Fatal.
can't write to directory of %s
The directory where the file resides can't be written, so the lockfile can't be created.
can't get %s: %s
The named lock can't be gotten: the reason is supplied. Failure occurs after ten tries to get the lock.
%s %s[%s]: lock on %s held by %s
The lock on the specified file is help by the noted locker. Informatory message, printed only when debugging is on.
close failed for %s: %s
The file containing the lock information couldn't be closed for the reason shown.
releasing lock on %s
Debug message; notes that the lock on the specified file was successfully released.
File::LockDir requires no configuration files or environment variables.
None.
None reported.
No bugs have been reported.
Please report any bugs or feature requests to bug-file-lockdir@rt.cpan.org, or through the web interface at http://rt.cpan.org.
bug-file-lockdir@rt.cpan.org
Joe McMahon <mcmahon@cpan.org>
<mcmahon@cpan.org>
Copyright (c) 2006, Joe McMahon <mcmahon@cpan.org>. All rights reserved.
This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.
BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
To install File::LockDir, copy and paste the appropriate command in to your terminal.
cpanm
cpanm File::LockDir
CPAN shell
perl -MCPAN -e shell install File::LockDir
For more information on module installation, please visit the detailed CPAN module installation guide.