NAME

Redis::Setlock - Like the setlock command using Redis.

SYNOPSIS

$ redis-setlock [-nNxX] KEY program [ arg ... ]

--redis (Default: 127.0.0.1:6379): redis-host:redis-port
--expires (Default: 86400): The lock will be auto-released after the expire time is reached.
--keep: Keep the lock after invoked command exited.
-n: No delay. If KEY is locked by another process, redis-setlock gives up.
-N: (Default.) Delay. If KEY is locked by another process, redis-setlock waits until it can obtain a new lock.
-x: If KEY is locked, redis-setlock exits zero.
-X: (Default.) If KEY is locked, redis-setlock prints an error message and exits nonzero.

Using in your perl code.

use Redis::Setlock;
use Redis;  # or Redis::Fast
my $redis = Redis->new( server => 'redis.example.com:6379' );
if ( my $guard = Redis::Setlock->lock_guard($redis, "key", 60) ) {
   # got a lock!
   ...
   # unlock at guard destroyed.
}
else {
   # couldnot get lock
}

DESCRIPTION

Redis::Setlock is a like the setlock command using Redis.

REQUIREMENTS

Redis Server >= 2.6.12.

METHODS

new(%args)

lock_guard($redis, $lock_name, $expires, $blocking)

Creates Guard::guard object when the lock got.

The lock is released at the guard is destroyed.

If $blocking is true, lock_guard will be blocked until getting a lock. Otherwise returns immedetly when the lock is held by others .

Variables

$WAIT_QUEUE

Default: 0

If set to 1, Use the Redis BLPOP command to wait for unlocking instead of periodical polling.

$WARN_LOCK_TIME_THRESHOLD

Default: 0

If set to number over 0, put a warnings message to stderr when a lock guard unlocked spent over that seconds.

LICENSE

Copyright (C) FUJIWARA Shunichiro.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

AUTHOR

FUJIWARA Shunichiro <fujiwara.shunichiro@gmail.com>