larvitamintercom
v0.4.86
Published
[![Build Status](https://github.com/larvit/larvitamintercom/actions/workflows/ci.yml/badge.svg)](https://github.com/larvit/larvitamintercom/actions)
Downloads
2,045
Keywords
Readme
Larvitamintercom
Communication wrapper for rabbitmq in autobahn.
Usage
Connection
When instantiating a new intercom it will try to connect instantly and on connection error or connection lost it will try to reconnect an infinite number of times every 1sec.
Send
send() to autobahn.
const Intercom = require('larvitamintercom'),
conStr = 'amqp://user:[email protected]/',
intercom = new Intercom(conStr);
let message = {'hello': 'world'},
options = {'exchange': 'foo'}; // Will default to "default" if options is omitted
intercom.send(message, options, function (err, msgUuid) {
// called when message is accepted by queue handler
// msgUuid will be a unique UUID for this specific message
});
Default send options:
{
'exchange': 'default',
'durable': true,
'forceConsumeQueue': false // Will create a queue for consumtion even if there is no current listeners. This way no message will ever be lost, since they will wait in this queue until some consumer consumes them.
}
Read
There are two types of read operations; "consume" and "subscribe".
A message can only be "consumed" once, but it can be "subscribed" several times, by different readers.
Consumers can be assigned to an exchanged after the message have been sent, and they still receive the message. However, very importantly, ONE consumer must be assigned before the send happends, or the consumer queue never gets declared!
Subscribers, in contrast, must subscribe BEFORE the message is sent or they will not receive it.
Each subscriber only get each message once.
Consume
const Intercom = require('larvitamintercom'),
conStr = 'amqp://user:[email protected]/',
intercom = new Intercom(conStr);
let options = {'exchange': 'foo'}; // Will default to "default" if options is omitted
intercom.consume(options, function (message, ack, deliveryTag) {
// message being the object sent with intercom.send()
// deliveryTag is an identification of this delivery
// Must be ran! Always! ACK!!
ack();
// or
ack(new Error('Something was wrong with the message'));
}, function (err) {
// Callback from established consume connection
});
Default consume options:
{
'exchange': 'default'
}
Subscribe
const Intercom = require('larvitamintercom').Intercom,
conStr = 'amqp://user:[email protected]/',
intercom = new Intercom(conStr);
let options = {'exchange': 'default'};
intercom.subscribe(options, function (message, ack, deliveryTag) {
// message subscribe the object sent with intercom.send()
// deliveryTag is an identification of this delivery
// Must be ran! Always! ACK!!
ack();
// or
ack(new Error('Something was wrong with the message'));
}, function (err, subscribeInstance) {
// Callback from established subscribe connection
});
Default subscribe options:
{
'exchange': 'default'
}
Custom logging
const Intercom = require('larvitamintercom').Intercom,
winston = require('winston'),
log = winston.createLogger({'transports': [new winston.transports.Console()]}),
conStr = 'amqp://user:[email protected]/',
intercom = new Intercom({'conStr': conStr, 'log': log});