Nick Wellnhofer > Lucy-0.5.1 > Lucy::Store::LockFactory

Download:
Lucy-0.5.1.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.005001   Source   Latest Release: Lucy-0.6.0_2

NAME ^

Lucy::Store::LockFactory - Create Locks.

SYNOPSIS ^

    use Sys::Hostname qw( hostname );
    my $hostname = hostname() or die "Can't get unique hostname";
    my $folder = Lucy::Store::FSFolder->new( 
        path => '/path/to/index', 
    );
    my $lock_factory = Lucy::Store::LockFactory->new(
        folder => $folder,
        host   => $hostname,
    );
    my $write_lock = $lock_factory->make_lock(
        name     => 'write',
        timeout  => 5000,
        interval => 100,
    );

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 flock() are possible.

CONSTRUCTORS ^

new

    my $lock_factory = Lucy::Store::LockFactory->new(
        folder => $folder,      # required
        host   => $hostname,    # required
    );

Create a new LockFactory.

METHODS ^

make_lock

    my $lock = $lock_factory->make_lock(
        name     => $name      # required
        timeout  => $timeout   # default: 0
        interval => $interval  # default: 100
    );

Return a Lock object, which, once obtain() returns successfully, maintains an exclusive lock on a resource.

make_shared_lock

    my $lock = $lock_factory->make_shared_lock(
        name     => $name      # required
        timeout  => $timeout   # default: 0
        interval => $interval  # default: 100
    );

Return a Lock object for which shared() returns true, and which maintains a non-exclusive lock on a resource once obtain() returns success.

INHERITANCE ^

Lucy::Store::LockFactory isa Clownfish::Obj.

syntax highlighting: