GitHub - kpturner/rsmq-worker: Helper to simply implement a worker around RSMQ ( Redis Simple Message Queue )

Helper to simply implement a worker RSMQ ( Redis Simple Message Queue ).

Install

  npm install rsmq-worker

Initialize

  new RSMQWorker( queuename, options );

Example:

  var RSMQWorker = require( "rsmq-worker" );
  var worker = new RSMQWorker( "myqueue" );

  worker.on( "message", function( msg, next, id ){
  	// process your message
  	console.log("Message id : " + id);
  	console.log(msg);
  	next()
  });

  // optional error listeners
  worker.on('error', function( err, msg ){
      console.log( "ERROR", err, msg.id );
  });
  worker.on('exceeded', function( msg ){
      console.log( "EXCEEDED", msg.id );
  });
  worker.on('timeout', function( msg ){
      console.log( "TIMEOUT", msg.id, msg.rc );
  });

  worker.start();

Config

queuename: ( String required ) The queuename to pull the messages
options ( Object optional ) The configuration object
- options.interval: ( Number[] optional; default = [ 0, 1, 5, 10 ] ) An Array of increasing wait times in seconds
- options.maxReceiveCount: ( Number optional; default = 10 ) Receive count until a message will be exceeded
- options.invisibletime: ( Number optional; default = 30 ) A time in seconds to hide a message after it has been received.
- options.defaultDelay: ( Number optional; default = 1 ) The default delay in seconds for for sending new messages to the queue.
- options.autostart: ( Boolean optional; default = false ) Autostart the worker on init
- options.timeout: ( Number optional; default = 3000 ) Message processing timeout in ms. So you have to call the next() method of message at least after e.g. 3000ms. If set to 0 it'll wait until infinity.
- options.customExceedCheck: ( Function optional; ) A custom function, with the raw message (see message format) as argument to build a custom exceed check. If you return a true the message will not exceed. On return false the regular check for maxReceiveCount will be used.
- options.alwaysLogErrors: ( Boolean optional; default = false ) An error will be logged to the console even if an error listener has been attached.
- options.rsmq: ( RedisSMQ optional; default = null ) A already existing rsmq instance to use instead of creating a new client
- options.redis: ( RedisClient optional; default = null ) A already existing redis client instance to use if no rsmq instance has been defined
- options.redisPrefix: ( String optional; default = "" ) The redis prefix/namespace for rsmq if no rsmq instance has been defined. This has to match the option ns of RSMQ.
- options.host: ( String optional; default = "localhost" ) Host to connect to redis if no rsmq or redis instance has been defined
- options.port: ( Number optional; default = 6379 ) Port to connect to redis if no rsmq or redis instance has been defined
- options.options: ( Object optional; default = {} ) Options to connect to redis if no rsmq or redis instance has been defined

Raw message format

A message ( e.g. received by the event data or customExceedCheck ) contains the following keys:

msg.message : ( String ) The queue message content. You can use complex content by using a stringified JSON.
msg.id : ( String ) The rsmq internal message id
msg.sent : ( Number ) Timestamp of when this message was sent / created.
msg.fr : ( Number ) Timestamp of when this message was first received.
msg.rc : ( Number ) Number of times this message was received.