npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

rwlock

v5.0.0

Published

A read/write lock implementation for Node.

Downloads

73,638

Readme

rwlock

Asynchronous read/write lock implementation for Node.js.

Main rules:

  • there may be zero or more readers at a time,
  • there may be only one writer at a time,
  • there may be no writer if there are one or more readers already.

Installation

It's on npmjs:

$ npm install rwlock

Basic usage

Requiring the package, creating an instance:

var ReadWriteLock = require('rwlock');

var lock = new ReadWriteLock();

Acquiring a read lock:

lock.readLock(function (release) {
	// do stuff

	release();
});

Acquiring a write lock:

lock.writeLock(function (release) {
	// do stuff

	release();
});

Locks can be released later:

lock.readLock(function (release) {
	// not ready to release yet

	setTimeout(function () {
		// ok, now I'm ready
		release();
	}, 1000);
});

Upgrading to a write lock

ReadWriteLock does not explicitly support upgrading but you can take advantage of the asynchronous-ness:

lock.readLock(function (release) {
	// read stuff here

	// ok, I now realize I need to write

	// this will be queued
	lock.writeLock(function (release) {
		// you can write here

		release();

		// everything is now released.
	});

	// release the read lock, this will activate the writer
	release();
});

Downgrading to a read lock

Similar to upgrading:

lock.writeLock(function (release) {
	lock.readLock(function (release) {
		// ...
		release();
	});
	release();
});

Keys

Every ReadWriteLock instance allows you to work on a virtually unlimited number of completely independent read/write locks.

Locks are identified by names called "keys". Every exposed method has an optional "key" first argument indicating the lock to work on; if you don't specify a key, the default lock is used.

Example:

lock.writeLock('lock1', function (release) {
	console.log('writing 1...');
	lock.writeLock('lock2', function (release) {
		console.log('writing 2...');
		release();
		console.log('done 2.');
	});
	release();
	console.log('done 1.');
});

The previous example logs:

writing 1...
writing 2...
done 2.
done 1.

async compatibility

The ReadWriteLock class does not return errors to your callbacks, but many APIs in Node do. The async module uses that as a convention: callbacks usually receive two arguments, a possibly null error object and the actual result in case there is no error.

To aid async compatibility, ReadWriteLock sends null errors if you specify the async flag like in the following example:

lock.async.readLock(function (error, release) {
	// no need to check on error, it will always be null

	// do stuff here

	release();
});

You can use rwlock and async together like in this example:

var releaseLock = null;

async.waterfall([function (next) {
	lock.async.writeLock(next);
}, function (release, next) {
	releaseLock = release;
	fs.writeFile('file', 'content', next);
}, function (next) {
	releaseLock();
	next(null);
}], function (error) {
	if (error) {
		if (releaseLock) {
			releaseLock();
		}
		console.dir(error);
	} else {
		console.log('done.');
	}
});

Building from source and testing

You don't need this, but in case you want:

$ sudo npm install -g grunt-cli
$ cd
$ git clone https://github.com/71104/rwlock.git
$ cd rwlock
$ npm install
$ grunt all

The following folders will be generated:

  • lib, containing the minified ReadWriteLock class to require in Node.js;
  • doc, containing the API reference documentation in HTML format.

License

MIT. Copyright 2013 Alberto La Rocca