Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hemerajs/hemera-rabbitmq
Use RabbitMQ with Hemera
https://github.com/hemerajs/hemera-rabbitmq
bridge hemerajs queue rabbitmq
Last synced: 6 days ago
JSON representation
Use RabbitMQ with Hemera
- Host: GitHub
- URL: https://github.com/hemerajs/hemera-rabbitmq
- Owner: hemerajs
- License: mit
- Created: 2018-03-08T20:04:27.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-04-20T19:14:15.000Z (almost 7 years ago)
- Last Synced: 2024-11-14T23:08:23.170Z (2 months ago)
- Topics: bridge, hemerajs, queue, rabbitmq
- Language: JavaScript
- Size: 91.8 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Hemera-rabbitmq
[](https://travis-ci.org/hemerajs/hemera-rabbitmq)
[](https://www.npmjs.com/package/hemera-rabbitmq)
[](#badge)
This is a plugin to use [RabbitMQ](https://www.rabbitmq.com) with Hemera.
RabbitMQ is a messaging broker - an intermediary for messaging. It gives your applications a common platform to send and receive messages, and your messages a safe place to live until received. It is complementary to the primary NATS transport system.
The client use JSON to transfer data.
## Start RabbitMQ instance
Start a rabbitmq instance via docker-compose
```
docker-compose up
```
## Administration
Visit http://127.0.0.1:15672 and log in with
```
Username: user
Password: user
```
#### Example
```js
const Hemera = require('nats-hemera')
const nats = require('nats').connect()
const hemera = new Hemera(nats, {
logLevel: 'info'
})
hemera.use(require('hemera-joi'))
// Topology & configuration via JSON look at https://github.com/arobson/rabbot
hemera.use(require('hemera-rabbitmq', { rabbot: options }))
```
## Plugin dependencies
* hemera-joi
## Interface
* [RabbitMQ API](#RabbitMQ-api)
* [Publish](#publish)
* [Request](#request)
* [Create pub/sub subscriber](#Create-pub-sub-subscriber)
* [Create request/reply subscriber](#Create-request-reply-subscriber)
* [Consume events](#consume-events)
---
### publish
The pattern is:
* `topic`: is the service name to publish to `rabbitmq`
* `cmd`: is the command to execute `publish`
* `exchange`: the name of the exachange `string`
* `options`: rabbot transport options `object`
* `data`: the data to transfer `object`
Example:
```js
hemera.act(
{
topic: 'rabbitmq',
cmd: 'publish',
exchange: 'pubsub',
options: {
type: 'MyMessage'
},
data: {
name: 'peter',
amount: 50
}
},
function() {}
)
```
---
### request
The pattern is:
* `topic`: is the service name to publish to `rabbitmq`
* `cmd`: is the command to execute `publish`
* `exchange`: the name of the exachange `string`
* `options`: rabbot transport options `object`
* `data`: the data to transfer `object`
Example:
```js
hemera.act(
{
topic: 'rabbitmq',
cmd: 'request',
exchange: 'request',
options: {
type: 'MyRequest'
},
data: {
name: 'peter',
amount: 50
}
},
function() {}
)
```
---
### Create pub/sub subscriber
Create a new rabbitmq subscriber which handles the interest on this subject and forward all messages with pub/sub semantic to the hemera service.
You can define a pattern which represent the destination hemera service.
The interface is:
* `pattern`: the pattern which arrive hemera
* `type`: the type `string`
Example:
```js
hemera.rabbitmq.addPubSubProxy(
{
type: 'MyMessage'
pattern: {}
}
)
```
---
### Create request/reply subscriber
Create a new rabbitmq subscriber which handles the interest on this subject and forward all messages with request/reply semantic to the hemera service.
You can define a pattern which represent the destination hemera service.
The interface is:
* `pattern`: the pattern which arrive hemera
* `type`: the type `string`
Example:
```js
hemera.rabbitmq.addRequestProxy(
{
type: 'MyMessage'
pattern: {}
}
)
```
---
### Consume events
The pattern is:
* `topic`: is a combination of the service name and the type `rabbitmq.`
Example:
```js
hemera.add(
{
topic: 'rabbitmq.MyMessage'
},
function(req, reply) {
// In case of pub / sub you can't reply
// In case of request / reply you can reply only with valid json
// In case of error or crash the message is redelivered
}
)
```