Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rfrench/simple-cluster-cache
Dead simple cluster based in-memory cache that allows the master process and the worker processes to share the same object cache.
https://github.com/rfrench/simple-cluster-cache
cache cluster master node nodejs npm worker
Last synced: 2 months ago
JSON representation
Dead simple cluster based in-memory cache that allows the master process and the worker processes to share the same object cache.
- Host: GitHub
- URL: https://github.com/rfrench/simple-cluster-cache
- Owner: rfrench
- License: mit
- Created: 2015-06-24T06:16:21.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2015-07-11T16:42:15.000Z (over 9 years ago)
- Last Synced: 2024-11-11T11:30:14.721Z (3 months ago)
- Topics: cache, cluster, master, node, nodejs, npm, worker
- Language: JavaScript
- Homepage:
- Size: 180 KB
- Stars: 7
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# simple-cluster-cache [](https://travis-ci.org/rfrench/simple-cluster-cache) [](http://badge.fury.io/js/simple-cluster-cache)
Dead simple cluster based in-memory cache that allows the master process and the worker processes to share the same object cache.
## Install
```bash
$ npm install simple-cluster-cache
```
## Methods
- `get(key, callback)` - Gets the value from cache. Returns undefined if the value does not exist.
- `key`: The unique cache object key or an array of keys.
- `callback`: The optional callback function.
- `set(key, value, ttl, callback)` - Sets a cache object for the specified key.
- `key`: The unique cache object key.
- `value`: The cache object value.
- `ttl`: The optional time to live on the cache object. (milliseconds)
- `callback`: The optional callback function.
- `del(key, callback)` - Deletes a key from cache.
- `key`: The unique cache object key or an array of keys.
- `callback`: The optional callback function.
- `clear(callback)` - Clears the cache.
- `callback`: The optional callback function.
## Usage
``` js
cache.set('hello', 'world', function(err, value) {
console.log(value);
});
cache.set('world', 'hello', function(err, value) {
console.log(value);
});
// single get
cache.get('hello', function(err, value) {
// prints 'world'
console.log(value);
});
// multi get
cache.get(['hello', 'world'], function(err, value) {
// prints '{ 'hello': 'world', 'world': 'hello' }'
console.log(value);
});
// single delete
cache.del('hello', function(err) {
console.log('deleted');
});
// multi delete
cache.del(['hello', 'world'], function(err) {
console.log('deleted');
});
// clears the entire cache
cache.clear(function() {
console.log('cache cleared!');
});
```
## Example
``` js
'use strict';
var cluster = require('cluster');
var cache = require('simple-cluster-cache');
var express = require('express');
var os = require('os');
if (cluster.isMaster) {
var cpus = os.cpus().length;
for (var i = 0; i < cpus; i++) {
cluster.fork();
}
cluster.on('exit', function(worker, code, signal) {
cluster.fork();
});
// preload some keys just to demonstrate it works from the master thread
cache.clear();
cache.set('hello', 'world', 5000);
cache.set('object', { 'hello': 'world' });
cache.set('array', [ 1, 2, 3 ]);
cache.set('callback', true, function(err, value) {
console.log('successfully set "callback" to %s', value);
});
}
else {
var app = express();
// gets the key from cache
app.get('/:key', function(req, res, next) {
var key = req.params.key;
cache.get(key, function(err, value) {
res.json(value);
});
});
// sets the cache value
app.post('/:key/:value/:ttl?', function(req, res, next) {
var key = req.params.key;
var value = req.params.value;
var ttl = req.params.ttl;
cache.set(key, value, ttl, function(err, value) {
res.json(value);
});
});
// deletes the cache key
app.delete('/:key', function(req, res, next) {
var key = req.params.key;
cache.del(key, function(err) {
res.json(key + ' was deleted.');
});
});
// clears the cache
app.purge('/clear', function(req, res, next) {
console.log('clear')
cache.clear(function() {
res.json('cache cleared!');
});
});
app.listen(process.env.PORT || 8000);
}
```