patrun-emitter

patrun-emitter  

An Opinionated Message Queue with an emitter-style API, but with objects as events, plus callbacks.

• Installation
• Basic Example
• API
• Licence & copyright

Installation

$ npm install patrun-emitter --save

Basic Example

var mq = require('patrun-emitter')
  , emitter = mq({ concurrency: 5 })
  , message

emitter.on({ topic: 'hello world' }, function(message, cb) {
  // call callback when you are done
  // do not pass any errors, the emitter cannot handle it.
  cb()
})

// topic is just a convetion
// we can use anything else!
message = { topic: 'hello world', payload: 'or any other fields' }
emitter.emit(message, function() {
  // emitter will never return an error
})

API

• PatrunEmitter
• emitter#emit()
• emitter#on()
• emitter#removeListener()

PatrunEmitter(opts)

PatrunEmitter is the class and function exposed by this module. It can be created by PatrunEmitter() or using new PatrunEmitter().

An PatrunEmitter accepts the following options:

• concurrency: the maximum number of concurrent messages that can be on concurrent delivery.

emitter.emit(message, callback())

Emit the given message.

emitter.on(pattern, callback(message, done))

Add the given callback to the passed pattern, see patrun for the matching rules.

The callback, accept two parameters, the passed message and a done callback.

The callback must never error and done must not be called with an err object.

emitter.removeListener(pattern, callback)

The inverse of on.

LICENSE

Copyright (c) 2014, Matteo Collina [e-mail]

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.