node package manager
Easy collaboration. Discover, share, and reuse code in your team. Create a free org »

seneca-redis-queue-transport

Seneca

A Seneca.js transport plugin

seneca-redis-queue-transport

npm version Build Status Gitter

This plugin provides transport for micro-service messages via Redis (list based) queues. This lets you send messsages via redis.

ALSO READ: The seneca-transport readme has lots of introductory material about message transports. Start there if you have not used a message transport before.

  • Tested on: Seneca 0.7, 0.8
  • Node: 0.10, 0.12, 4, 5
  • License: MIT

seneca-redis-queue-transport's source can be read in an annotated fashion by,

  • running npm run annotate
  • viewing online.

The annotated source can be found locally at ./doc/redis-queue-transport.html.

If you're using this module, and need help, you can:

If you are new to Seneca in general, please take a look at senecajs.org. We have everything from tutorials to sample apps to help get you up and running quickly.

Install

To install, simply use npm. Remember you will need to install Seneca.js if you haven't already.

npm install seneca-redis-queue-transport

You'll also need redis.

Test

To run tests, simply use npm:

npm run test

Quick Example

require('seneca')()
  .use('redis-queue-transport')
  .add('foo:two',function(args,done){ done(null,{bar:args.bar}) })
  .client( {type:'redis-queue',pin:'foo:one,bar:*'} )
  .listen( {type:'redis-queue',pin:'foo:two,bar:*'} )

Available Options

require('seneca')()
  .use('redis-queue-transport', {
    'redis-queue': {
      timeout: 22222,
      type: 'redis-queue',
      host: 'localhost',
      port: 6379
    }
  })

Contributing

The Senecajs org encourage open participation. If you feel you can help in any way, be it with documentation, examples, extra testing, or new features please get in touch.

License

Copyright Richard Rodger and other contributors 2015, Licensed under MIT.