2.8.3 • Published 4 months ago

podasync v2.8.3

Weekly downloads
7
License
MIT
Repository
github
Last release
4 months ago

Synopsis

Fanap's POD Async service (DIRANA)

Code Example

First you have to require PodAsync in your project.

var Async = require('podasync');

To be able to connect to async server, you should set some parameters. Websockets, ActiveMQ and MQTT protocols are currently supported.

Websocket protocol parameters

var params = {
  socketAddress: "ws://chat-sandbox.pod.land/ws",
  serverName: "chat-server",
  reconnectOnClose: true,
  connectionCheckTimeout: 10000,
  asyncLogging: {
    onFunction: true,
    onMessageReceive: true,
    onMessageSend: true
  }
};

ActiveMQ protocol parameters

var params = {
  protocol: "queue",
  servers: [{
    serverHost: "***",
    serverPort: "***",
    serverUsername: "***",
    serverPassword: "***"
  }, {
    serverHost: "***",
    serverPort: "***",
    serverUsername: "***",
    serverPassword: "***"
  }],
  queueReceive: "queue-***",
  queueSend: "queue-***",
  queueConnectionTimeout: 20000,
  asyncLogging: {
    onFunction: true, // log main actions on console
    onMessageReceive: true, // log received messages on console
    onMessageSend: true // log sent messaged on console
  }
};

MQTT parameters

var params = {
    protocol: 'mqtt',
    mqttHost: '***',
    mqttPort: '***',
    mqttUsername: '***',
    mqttPassword: '***',
    mqttConnectionTimeout: 20000,
    mqttClientId: 1234,
    mqttInputQueueName: "out/mqqttout",
    mqttOutputQueueName: "async/chat-server",
    peerId: 118401,
    asyncLogging: {
        onFunction: true, // log main actions on console
        onMessageReceive: true, // log received messages on console
        onMessageSend: true // log sent messaged on console
    }
};

After setting parameters you can make a new connection to Async server.

var asyncClient = new Async(params);

Async Ready Event

After making a new connection, you should wait for asyncReady event to fire so you could be sure that the connection has been estabilished and you are ready to go

asyncClient.on("asyncReady", function() {
  /**
  * Write your code inside asyncReady() function
  */
});

Receive messages

In order to receive messages from Async server, you could listen to message event.

/**
* Listening to responses came from DIRANA
*/
asyncClient.on("message", function(message, ack) {
  console.log(message);
});

Send message

To send a new message to Async server you can use send() function.

/**
* A Custom Message To be Send Through DIRANA
*/
var customMessage = {
  type: 3,
  content: {
    receivers: ["receiver1", "receiver2", "..."],
    content: "Hello Buddy!"
  }
};

/**
* Sending Message
*/
asyncClient.send(customMessage);

Motivation

This module helps you to easily connect POD chat service.

Installation

npm install podasync --save

API Reference

API Docs from POD

Tests

npm test

Contributors

You can send me your thoughts about making this repo great :) Email

License

Under MIT License.

2.8.4-snapshot.11

4 months ago

2.8.4-snapshot.10

4 months ago

2.8.4-snapshot.9

4 months ago

2.8.4-snapshot.7

4 months ago

2.8.4-snapshot.8

4 months ago

2.8.4-snapshot.6

4 months ago

2.8.4-snapshot.2

11 months ago

2.8.4-snapshot.3

11 months ago

2.8.4-snapshot.4

11 months ago

2.8.4-snapshot.5

9 months ago

2.8.3

3 years ago

2.8.2

3 years ago

2.8.1

3 years ago

2.7.4

5 years ago

2.7.3

5 years ago

2.7.2

5 years ago

2.7.1

5 years ago

2.7.0

5 years ago

2.6.5

5 years ago

2.6.4

5 years ago

2.6.3

5 years ago

2.6.2

5 years ago

2.6.1

5 years ago

2.6.0

5 years ago

2.5.14

5 years ago

2.5.13

5 years ago

2.5.12

5 years ago

2.5.11

5 years ago

2.5.10

5 years ago

2.5.9

5 years ago

2.5.8

5 years ago

2.5.7

5 years ago

2.5.6

5 years ago

2.5.5

5 years ago

2.5.4

5 years ago

2.5.3

5 years ago

2.5.2

5 years ago

2.5.1

6 years ago

2.5.0

6 years ago

2.4.3

6 years ago

2.4.2

6 years ago

2.4.1

6 years ago

2.4.0

6 years ago

2.3.19

6 years ago

2.3.18

6 years ago

2.3.17

6 years ago

2.3.16

6 years ago

2.3.15

6 years ago

2.3.14

6 years ago

2.3.13

6 years ago

2.3.12

6 years ago

2.3.11

6 years ago

2.3.10

6 years ago

2.3.9

6 years ago

2.3.8

6 years ago

2.3.7

6 years ago

2.3.6

6 years ago

2.3.5

6 years ago

2.3.4

6 years ago

2.3.3

6 years ago

2.3.2

6 years ago

2.3.1

6 years ago

2.3.0

6 years ago

2.2.4

6 years ago

2.2.3

6 years ago

2.2.2

6 years ago

2.2.1

6 years ago

2.2.0

6 years ago

2.1.5

6 years ago

2.1.4

6 years ago

2.1.3

6 years ago

2.1.2

6 years ago

2.1.1

6 years ago

2.1.0

6 years ago

2.0.1

6 years ago

2.0.0

6 years ago

1.6.0

6 years ago

1.5.2

6 years ago

1.5.1

6 years ago

1.5.0

6 years ago

1.4.1

6 years ago

1.4.0

6 years ago

1.3.5

6 years ago

1.3.4

6 years ago

1.3.3

6 years ago

1.3.2

6 years ago

1.3.1

6 years ago

1.3.0

6 years ago

1.2.0

6 years ago

1.1.2

6 years ago

1.0.0

6 years ago