A lightweight message queue for Node.js that requires no dedicated queue server. Just a Redis server.
tl;dr: If you run a Redis server and currently use Amazon SQS or a similar message queue you might as well use this fast little replacement. Using a shared Redis server multiple Node.js processes can send / receive messages.
Lightweight: Just Redis. Every client can send and receive messages via a shared Redis server.
Guaranteed delivery of a message to exactly one recipient within a messages visibility timeout.
No security: Like memcached. Only for internal use in trusted environments.
Similar to Amazon SQS (Simple Queue Service) - with some differences:
sendMessage method.Optional RESTful interface via rest-rsmq
id that you can use to delete the message.sendMessage method will return the id for a sent message.receiveMessage method will return an id along with the message and some stats.createQueue and receiveMessage methods described below for optional parameters like visibility timeout and delay.npm install rsmq
RedisSMQ = require("rsmq");
rsmq = new RedisSMQ( {host: "127.0.0.1", port: 6379, ns: "rsmq"} );
Parameters for RedisSMQ via an options object:
host (String): optional (Default: "127.0.0.1") The Redis serverport (Number): optional (Default: 6379) The Redis portoptions (Object): optional (Default: {}) The Redis https://github.com/mranney/node_redis#rediscreateclientport-host-options options object.client (RedisClient): optional A existing redis client instance. host and server will be ignored.ns (String): optional (Default: "rsmq") The namespace prefix used for all keys created by rsmqPlease look at the Methods section for optional parameters when creating a queue.
rsmq.createQueue({qname:"myqueue"}, function (err, resp) {
if (resp===1) {
console.log("queue created")
}
});
rsmq.sendMessage({qname:"myqueue", message:"Hello World"}, function (err, resp) {
if (resp) {
console.log("Message sent. ID:", resp);
}
});
rsmq.receiveMessage({qname:"myqueue"}, function (err, resp) {
if (resp.id) {
console.log("Message received.", resp)
}
else {
console.log("No messages for me...")
}
});
rsmq.deleteMessage({qname:"myqueue", id:"dhoiwpiirm15ce77305a5c3a3b0f230c6e20f09b55"}, function (err, resp) {
if (resp===1) {
console.log("Message deleted.")
}
else {
console.log("Message not found.")
}
});
Change the visibility timer of a single message.
The time when the message will be visible again is calculated from the current time (now) + vt.
Parameters:
qname (String): The Queue name.id (String): The message id.vt (Number): The length of time, in seconds, that this message will not be visible. Allowed values: 0-9999999 (around 115 days)Returns:
1 if successful, 0 if the message was not found.Create a new queue.
Parameters:
qname (String): The Queue name. Maximum 80 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.vt (Number): optional (Default: 30) The length of time, in seconds, that a message received from a queue will be invisible to other receiving components when they ask to receive messages. Allowed values: 0-9999999 (around 115 days)delay (Number): optional (Default: 0) The time in seconds that the delivery of all new messages in the queue will be delayed. Allowed values: 0-9999999 (around 115 days)maxsize (Number): optional (Default: 65536) The maximum message size in bytes. Allowed values: 1024-65536Returns:
1Parameters:
qname (String): The Queue name.id (String): message id to delete.Returns:
1 if successful, 0 if the message was not found.Deletes a queue and all messages.
Parameters:
qname (String): The Queue name.Returns:
1Get queue attributes, counter and stats
Parameters:
qname (String): The Queue name.Returns an object:
vt: The visibility timeout for the queue in secondsdelay: The delay for new messages in secondsmaxsize: The maximum size of a message in bytestotalrecv: Total number of messages received from the queuetotalsent: Total number of messages sent to the queuecreated: Timestamp (epoch in seconds) when the queue was createdmodified: Timestamp (epoch in seconds) when the queue was last modified with setQueueAttributesmsgs: Current number of messages in the queuehiddenmsgs: Current number of hidden / not visible messages. A message can be hidden while "in flight" due to a vt parameter or when sent with a delayList all queues
Returns an array:
["qname1", "qname2"]Receive the next message from the queue.
Parameters:
qname (String): The Queue name.vt (Number): optional (Default: queue settings) The length of time, in seconds, that the received message will be invisible to others. Allowed values: 0-9999999 (around 115 days)Returns an object:
message: The message's contents.id: The internal message id.sent: Timestamp of when this message was sent / created.fr: Timestamp of when this message was first received.rc: Number of times this message was received.Note: Will return an empty object if no message is there
Sends a new message.
Parameters:
qname (String)message (String)delay (Number): optional (Default: queue settings) The time in seconds that the delivery of the message will be delayed. Allowed values: 0-9999999 (around 115 days)Returns:
id: The internal message id.
Sets queue parameters.
Parameters:
qname (String): The Queue name.vt (Number): optional * The length of time, in seconds, that a message received from a queue will be invisible to other receiving components when they ask to receive messages. Allowed values: 0-9999999 (around 115 days)delay (Number): optional The time in seconds that the delivery of all new messages in the queue will be delayed. Allowed values: 0-9999999 (around 115 days)maxsize (Number): optional The maximum message size in bytes. Allowed values: 1024-65536Note: At least one attribute (vt, delay, maxsize) must be supplied. Only attributes that are supplied will be modified.
Returns an object:
vt: The visibility timeout for the queue in secondsdelay: The delay for new messages in secondsmaxsize: The maximum size of a message in bytestotalrecv: Total number of messages received from the queuetotalsent: Total number of messages sent to the queuecreated: Timestamp (epoch in seconds) when the queue was createdmodified: Timestamp (epoch in seconds) when the queue was last modified with setQueueAttributesmsgs: Current number of messages in the queuehiddenmsgs: Current number of hidden / not visible messages. A message can be hidden while "in flight" due to a vt parameter or when sent with a delaysee the CHANGELOG
Check out our other projects which are based on Node.js and Redis as a datastore:
A Node.js helper library to make tagging of items in any legacy database (SQL or NoSQL) easy and fast. Redis is used to store tag-item associations and to allow fast queries and paging over large sets of tagged items.
limit and offsetThis is a Node.js module to keep sessions in a Redis datastore and add some useful methods.
The main purpose of this module is to generalize sessions across application server platforms. We use nginx reverse proxy to route parts of a website to a Node.js server and other parts could be Python, .net, PHP, Coldfusion or Java servers. You can then use rest-sessions to access the same sessions on all app server via a REST interface.
Copyright © Patrick Liess, http://www.tcs.de
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
0.3.9
FAQs
A really simple message queue based on Redis
The npm package rsmq receives a total of 3,314 weekly downloads. As such, rsmq popularity was classified as popular.
We found that rsmq demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
RubyGems.org has added a new "maintainer" role that allows for publishing new versions of gems. This new permission type is aimed at improving security for gem owners and the service overall.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.