bramqp-wrapper

Wrapper of bramqp lib to make easy access to amqp protocol.

ES2015 syntax in npm repo is not used now.

Install with:

npm install bramqp-wrapper

Dependencies:

bramqp

Be careful! not implemented usage of noWait flag.

Changelog

Usage

Example:

 
    var a = new (require('bramqp-wrapper'))({
        host: '127.0.0.1',
        port: 5672,
        vhost: '/',
        user: 'guest',
        password: 'guest',
        protocolVersion: 'rabbitmq/full/amqp0-9-1.stripped.extended',
        channelPoolCapacity: 100,
        taskPoolCapacity: 100
      });
    
      a.connect(function (err) {
        console.log('connected', err);
    
        var body = (function(size){
          var res = '';
          var s = 'qwertyuiopasdfghjklzxcvbnmQWERTYUIOPASDFGHJKLZXCVBNM1234567890';
          while (res.length < size){
            res += s[Math.floor(Math.random()*s.length)];
          }
          return res;
        })(1024);
        var start = new Date();
        var endCount = 100000;
          for (let i = endCount-1; i > -1; i--) {
            (function (i) {
              a.getChannel(function (err, b, done) {
                  b.basic.publish('', 'queue', body, {}, {}, () => {
                    done();
                    if (i === 0) {
                      let time = new Date() - start;
                      console.log('End in', time, 'ms.');
                      console.log(endCount*1000/time, 'rps.');
                      setTimeout(a.disconnect.bind(a, function(){
                        console.log('disconnected');
                      }), 100);
                    }
                  });
              });
            })(i);
          }
      });

In this example you will try to add 100k messages and you will use only 100 channels wor it.

Client

Kind: global class

Client

new Client(config)

Param	Type	Default
config	`Object`
[config.host]	`String`	`'127.0.0.1'`
[config.port]	`Number`	`5672`
[config.user]	`String`	`'guest'`
[config.password]	`String`	`'guest'`
[config.protocolVersion]	`String`	`'rabbitmq/full/amqp0-9-1.stripped.extended'`
[config.vhost]	`String`	`'/'`
[config.channelPoolCapacity]	`Number`	`0`
[config.taskPoolCapacity]	`Number`	`0`

client.connect(callback)

Connect to amqp server.

Kind: instance method of Client

Param	Type
callback	`function`

client.disconnect(cb)

Wait of end of all tasks. After - disconnect.

Kind: instance method of Client

Param	Type
cb	`function`

client.getChannel(callback)

Gets channel from pool. If no channels, will wait until some chan free.

Kind: instance method of Client

Param	Type	Description
callback	`function`	1st arguments is error. 2nd argument is object like `{basic:.., channel:.., confirm:.., exchange:.., queue:.., queue:.., tx:..}` all methods provided an api of amqp protocol. 3rd argument is done callback to make channel free.

client.getChannelOnConnect(callback)

Gets channel from pool. If no channels, will wait until some chan free. If client is disconnected, will wait until connect.

Kind: instance method of Client

Param	Type	Description
callback	`function`	1st arguments is error. 2nd argument is object like `{basic:.., channel:.., confirm:.., exchange:.., queue:.., queue:.., tx:..}` all methods provided an api of amqp protocol. 3rd argument is done callback to make channel free.

client.getChannelDirect(callback)

Gets channel from pool. If no channels, will return error. Mark channel busy, but dos not increment counter of tasks in work.

Kind: instance method of Client

Param	Type	Description
callback	`function`	1st arguments is error. 2nd argument is object like `{basic:.., channel:.., confirm:.., exchange:.., queue:.., queue:.., tx:..}` all methods provided an api of amqp protocol. 3rd argument is done callback to make channel free.

Client events

"connect"

Client object emits this event after opening socket and success authorisation on AMQP server.

"disconnect"

Client object emits this event then socket is closed. It does not mean, that, you should create new connection manually. By default, client will reconnect after 5 seconds. To prevent this behaviour, just call

client.disconnect(() => {
  //and now, if you want, spawn:
  client.connect(()=>{}); 
});

"amqp-blocked"

Client object emits this event then AMQP server start rejecting messages, because it has no memory to get message.

"amqp-unblocked"

Client object emits this event then AMQP server start resieving messages after amqp-bocked.

Classes

Basic ⇐ EventEmitter: Basic
Channel ⇐ EventEmitter: Channel
Confirm
Exchange ⇐ EventEmitter
Queue ⇐ EventEmitter
RabbitClientError
RabbitRouteError
TX ⇐ EventEmitter

Basic ⇐ `EventEmitter`

Basic

Kind: global class
Extends: EventEmitter

Basic ⇐ EventEmitter

new Basic(client, channel, done)

Work with basic content.

The Basic class provides methods that support an industry-standard messaging model. Work with channels.

Param	Type	Description
client	`BRAMQPClient`	Client object that returns from bramqp#openAMQPCommunication() method.
channel	`Channel`	Channel object (should be opened).
done	`function`

basic.qos([options], callback)

Specify quality of service.

This method requests a specific quality of service. The QoS can be specified for the current channel or for all channels on the connection. T he particular properties and semantics of a qos method always depend on the content class semantics. Though the qos method could in principle apply to both peers, it is currently meaningful only for the server.