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

slocket

v1.0.5

Published

A locking socket alternative to file-system mutex locks

Downloads

273

Readme

slocket

A locking socket alternative to file-system mutex locks

Algorithm

to ACQUIRE(lockname)
- create server, listen on lockname
  - if enotsock, WATCH(lockname)
  - if eaddrinuse,
    - CONNECT(lockname)
  - unref server
  - lock has been acquired via server
  ! on connection, place sockets in queue

to RELEASE(lockname)
- if acquired via connection
  - if connected, disconnect
  - else, unlink lockname
- if acquired via server
  - send "OK" to front-most connection
    - when connection disconnects, RELEASE(lockname)
- if acquired via filename
  - unlink file

to CONNECT(lockname)
- net.connect(lockname)
  - if econnrefused (socket, but not listening!)
    could be that a server process crashed, leaving a dangling
    connection that thinks it has the lock.
    - WATCH(lockname)
  - if enoent or on socket termination, ACQUIRE(lockname)
  - when server says "OK",
    - lock has been acquired via connection
    - on connection disconnect, on release, unlink socket

to WATCH(lockname)
- fs.watch(lockname)
- on change, ACQUIRE(lockname)

USAGE

var slocket = require('slocket')

// Only one of these can run in this filesystem space,
// even if there are many processes running at once
function someMutexedThing (cb) {
  slocket('/path/to/my-lock-name', function (er, lock) {
    if (er) throw er
    // lock acquired
    // do your thing here
    // and then...
    lock.release()
  })
}

A slocket is like a Promise, so this works:

slocket('/path/to/filename.lock').then(lock => {
  // do your stuff in this space
  lock.release()
}).catch(er => {
  // a lock could not be acquired
})

If you want to use async/await, you can do this, which is nice:

async function fooSingleFile (args) {
  var lock = await slocket('foo')

  // now I have an exclusive lock on the fooness!

  await otherAsyncThingie(args)

  // all done, release the mutex
  lock.release()
}