Battle-hardened distributed locking using redis
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib return lock id in .lock Jan 4, 2016
test return lock id in .lock Jan 4, 2016
.gitignore Initial commit Mar 6, 2014
.travis.yml Add node 4 & 5 to Travis build list Jan 5, 2016
CHANGELOG.md
LICENSE Initial commit Mar 6, 2014
README.md return lock id in .lock Jan 4, 2016
package.json 0.2.0 Jan 5, 2016

README.md

warlock

Travis Dependency Status Join the chat at https://gitter.im/TheDeveloper/warlock

Battle-hardened distributed locking using redis.

Requirements

  • node-redis compatible with v0.10
  • Redis v2.6.12 or above. If you're running a Redis version from v2.6.0 to v2.6.11 inclusive use v0.0.7 of this module.

Install

npm install node-redis-warlock

Usage

var Warlock = require('node-redis-warlock');
var redis = require('redis');

// Establish a redis client and pass it to warlock
var redis = redis.createClient();
var warlock = Warlock(redis);

// Set a lock
var key = 'test-lock';
var ttl = 10000; // Lifetime of the lock

warlock.lock(key, ttl, function(err, unlock){
  if (err) {
    // Something went wrong and we weren't able to set a lock
    return;
  }

  if (typeof unlock === 'function') {
    // If the lock is set successfully by this process, an unlock function is passed to our callback.
    // Do the work that required lock protection, and then unlock() when finished...
    //
    // do stuff...
    //
    unlock();
  } else {
    // Otherwise, the lock was not established by us so we must decide what to do
    // Perhaps wait a bit & retry...
  }
});

// set a lock optimistically
var key = 'opt-lock';
var ttl = 10000;
var maxAttempts = 4; // Max number of times to try setting the lock before erroring
var wait = 1000; // Time to wait before another attempt if lock already in place
warlock.optimistic(key, ttl, maxAttempts, wait, function(err, unlock) {});

// unlock using the lock id
var key = 'test-lock-2';
var ttl = 10000;
var lockId;

warlock.lock(key, ttl, function(err, _, id) {
  lockId = id;
});

// each client who knows the lockId can release the lock
warlock.unlock(key, lockId, function(err, result) {
  if(result == 1) {
    // unlocked successfully
  }
});

ProTips