.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" 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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Lucy::Store::LockFactory 3pm"
.TH Lucy::Store::LockFactory 3pm "2017-08-02" "perl v5.26.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"
Lucy::Store::LockFactory \- Create Locks.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 10
\&    use Sys::Hostname qw( hostname );
\&    my $hostname = hostname() or die "Can\*(Aqt get unique hostname";
\&    my $folder = Lucy::Store::FSFolder\->new( 
\&        path => \*(Aq/path/to/index\*(Aq, 
\&    );
\&    my $lock_factory = Lucy::Store::LockFactory\->new(
\&        folder => $folder,
\&        host   => $hostname,
\&    );
\&    my $write_lock = $lock_factory\->make_lock(
\&        name     => \*(Aqwrite\*(Aq,
\&        timeout  => 5000,
\&        interval => 100,
\&    );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
LockFactory is used to spin off interprocess mutex locks used by various
index reading and writing components.  The default implementation uses
lockfiles, but LockFactory subclasses which are implemented using
alternatives such as \fIflock()\fR are possible.
.SH "CONSTRUCTORS"
.IX Header "CONSTRUCTORS"
.SS "new( \fI[labeled params]\fP )"
.IX Subsection "new( [labeled params] )"
.Vb 4
\&    my $lock_factory = Lucy::Store::LockFactory\->new(
\&        folder => $folder,      # required
\&        host   => $hostname,    # required
\&    );
.Ve
.IP "\(bu" 4
\&\fBfolder\fR \- A Lucy::Store::Folder.
.IP "\(bu" 4
\&\fBhost\fR \- An identifier which should be unique per-machine.
.SH "METHODS"
.IX Header "METHODS"
.SS "make_lock( \fI[labeled params]\fP )"
.IX Subsection "make_lock( [labeled params] )"
Return a Lock object, which, once \fIobtain()\fR returns successfully,
maintains an exclusive lock on a resource.
.IP "\(bu" 4
\&\fBname\fR \- A file-system-friendly id which identifies the
resource to be locked.
.IP "\(bu" 4
\&\fBtimeout\fR \- Time in milliseconds to keep retrying before abandoning
the attempt to \fIobtain()\fR a lock.
.IP "\(bu" 4
\&\fBinterval\fR \- Time in milliseconds between retries.
.SS "make_shared_lock( \fI[labeled params]\fP )"
.IX Subsection "make_shared_lock( [labeled params] )"
Return a Lock object for which \fIshared()\fR returns true, and which
maintains a non-exclusive lock on a resource once \fIobtain()\fR returns
success.
.IP "\(bu" 4
\&\fBname\fR \- A file-system-friendly id which identifies the
resource to be locked.
.IP "\(bu" 4
\&\fBtimeout\fR \- Time in milliseconds to keep retrying before abandoning
the attempt to \fIobtain()\fR a lock.
.IP "\(bu" 4
\&\fBinterval\fR \- Time in milliseconds between retries.
.SH "INHERITANCE"
.IX Header "INHERITANCE"
Lucy::Store::LockFactory isa Lucy::Object::Obj.