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

locked

v2.4.1

Published

distributed consensus on a single value using etcd

Downloads

276

Readme

locked

Travis

distributed consensus on a single value using etcd

install

$ npm install locked

usage

First create a locker that is pointing at some nodes of your etcd cluster

var locked = require('locked')


// create a locker pointing with an etcd connection string
var locker = locked('127.0.0.1:4001,127.0.0.1:4002')

// create a node - this points to a single key and represents its value locked across the cluster
var node = locker({
	id:'node1',     // this is auto-completed if left blank
	path:'/master', // the etcd path we use for the lock
	value:10 ,      // the value for this node
	ttl:10          // we will check the lock every (ttl/2) seconds
})

// this is run when the values changes regardless of what node is elected
node.on('change', function(value, nodeid){
	console.log(value + ' was written by ' + nodeid)
})

// this is run when this node has been selected
node.on('select', function(){
	console.log('this server has been elected as the master!')
})

// this is run when this node is no longer the leader
node.on('deselect', function(){
	console.log('this server is no longer the master!')
})

// this starts the lock for this node
node.start()

you can also pass an existing etcdjs object:

var etcdjs = require('etcdjs')
var locker = locked(etcdjs('127.0.0.1:4001,127.0.0.1:4002'))

api

var locker = locked(etcdhosts)

Create a new locker pointing to some of the etcd servers in your cluster - etcdhosts can be an array or a single address string.

var node = locker(path, opts)

Create a node that represents a single key - other machines will have created nodes on the same path - they are all essentially competing.

Opts has the following keys:

  • id - specify the id of this node manually, this is auto-generated if left blank
  • value - the value this node will write to the registry
  • ttl - the amount of seconds that each value is valid - the value is automatically refreshed every ttl/2 seconds

node.start()

Start the lock process for this node

node.stop()

Stop the lock process for this node

node.id()

Get the currently active id across the lock

node.value()

Get the currently active value across the lock

node.localid()

The id for this specific node

node.localvalue()

The value for this specific node

node.localdata()

The data string for this specific node

This is id + ':::' + value

node.isSelected()

return boolean indicating if the node is currently the elected leader

events

node.on('change', function(value, leaderid){})

This event is triggered when the lock value has changed regardless of which node was elected.

The nodeid is of the elected machine is passed as the second argument.

node.on('select', function(value, leaderid){})

This event is triggered when the node has been elected and it's value distributed to the cluster.

You can run logic in this function that should only be running on one server at a time.

node.on('deselect', function(){})

This event is triggered when the node was the leader and now is not the leader (either because another node took leadership or because we were unable to refresh to leader itself)

node.on('refresh', function(value, leaderid){})

Triggered when the currently selected node has refreshed its value

node.on('ping', function(value, leaderid){})

Triggered when the leader has checked in and confirmed its leadership

node.on('error', function(error){})

If there is an error connecting to the etcd instance or with the HTTP request for each leadership poll, this event will be called with the error.

Upon such an error - the lock will cancel its polling for leadership and will leave you to clean up / restart the lock.

license

MIT