Full-featured client for locker lock server with timeouts support
Last updated 8 years ago by bobrik .
Repository · Original npm · Tarball · package.json
$ cnpm install locker 
SYNC missed versions from official npm registry.

node-locker - full-featured client for locker lock server

Allows to lock common resources across servers with sub-second precision in node.js in async way.


Check out locker server page for server installation instructions.

npm install locker


var Locker = require("locker"),
    locker = new Locker(4545, "");

locker.on("reset", function() {
    console.log("Reset happened (is server running?)");

locker.on("error", function(error) {
    console.log("Catched error:", error);

//            name    wait  max   callback
locker.locked("five", 2000, 3000, function(error, callback) {
    if (error) {
        // lock failed

    // do whatever you want with your shared resource

    callback(undefined, {well: "done"});


  • Requiring
var Locker = require("Locker");
  • New connection
var locker = new Locker(port, host);
  • Locking resource
locker.locked(identifier, lock_wait_time, max_execution_time, callback)

callback signature:

function(error, next) {}

In callback you will be exclusive owner of resource with name identifier if there is no error argument.

After doing exclusive stuff you should release lock by calling next callback.


  • reset — connection was reset and all locks were gone.
  • error - error occurred on some of connection locks (timeout exceed for waiting or execution time)

Current Tags

  • 0.1.0                                ...           latest (8 years ago)

1 Versions

  • 0.1.0                                ...           8 years ago

Copyright 2014 - 2017 © |