.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "SHARYANTO::File::Flock 3pm"
.TH SHARYANTO::File::Flock 3pm "2022-06-17" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
SHARYANTO::File::Flock \- Yet another flock module
.SH "VERSION"
.IX Header "VERSION"
version 0.56
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use SHARYANTO::File::Flock;
\&
\& # try to acquire exclusive lock. if fail to acquire lock within 60s, die.
\& my $lock = SHARYANTO::File::Flock\->lock($file);
\&
\& # explicitly unlock
\& $lock\->release;
\&
\& # automatically unlock if object is DESTROY\-ed.
\& undef $lock;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is yet another flock module. It is a more lightweight alternative to
File::Flock with some other differences:
.IP "\(bu" 4
\&\s-1OO\s0 interface only
.IP "\(bu" 4
Autoretry (by default for 60s) when trying to acquire lock
.Sp
I prefer this approach to blocking/waiting indefinitely or failing immediately.
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS "$lock = SHARYANTO::File::Flock\->lock($path, \e%opts)"
.el .SS "\f(CW$lock\fP = SHARYANTO::File::Flock\->lock($path, \e%opts)"
.IX Subsection "$lock = SHARYANTO::File::Flock->lock($path, %opts)"
Acquire an exclusive lock on \f(CW$path\fR. \f(CW$path\fR will be created if not already
exists. If \f(CW$path\fR is already locked by another process, will retry (by default
for 60 seconds). Will die if failed to acquire lock.
.PP
Will automatically unlock if \f(CW$lock\fR goes out of scope. Upon unlock, will
remove \f(CW$path\fR if it was created and is still empty (this behavior is the same
as File::Flock).
.PP
Available options:
.IP "\(bu" 4
retries => \s-1INT\s0 (default: 60)
.Sp
Number of retries (equals number of seconds, since retry is done every second).
.ie n .SS "$lock\->unlock"
.el .SS "\f(CW$lock\fP\->unlock"
.IX Subsection "$lock->unlock"
Unlock.
.ie n .SS "$lock\->release"
.el .SS "\f(CW$lock\fP\->release"
.IX Subsection "$lock->release"
Synonym for \fBunlock()\fR.
.SH "CAVEATS"
.IX Header "CAVEATS"
Not yet tested on Windows. Some filesystems do not support inode?
.SH "SEE ALSO"
.IX Header "SEE ALSO"
File::Flock
.PP
File::Flock::Tiny which is also tiny, but does not have the autoremove and
autoretry capability which I want. See also:
https://github.com/trinitum/perl\-File\-Flock\-Tiny/issues/1
.PP
\&\fBflock()\fR Perl function.
.SH "AUTHOR"
.IX Header "AUTHOR"
Steven Haryanto <stevenharyanto@gmail.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2013 by Steven Haryanto.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
None are exported by default, but they are exportable.