SDK of Node.js for Aliyun ONS.

ONS (Open Notification Service) is a message queue service of aliyun based on MetaQ (RocketMQ).

Maybe you want 中文文档?

$ npm install --save ons

NOTE: Because of Aliyun ONS C++ SDK's closed source, it only provides linux static library file (libonsclient4cpp.a). So you can only install this package under linux so far.

If you need to develop under OSX, please run a vagrant or a docker.

Microsoft Windows is supported now since version 1.2.0!

And what's more, because of C++ SDK again, I only can consider every messge as successfully processed and commit succeed back to ONS service. (ACK feature is finished!)

You're welcome to provide some useful solution!

You should turn on ONS first and then get an access key and a secret key. In next step you should create a consumer id or a producer id, and a topic.

You can do steps above by refering to help desk and aliyun console.

Here's examples for consumer and producer.

You can create a consumer by code following:

var Consumer = require("ons").Consumer;
var consumer = new Consumer(CUSTOMER_ID, TOPIC, TAGS, ACCESS_KEY, SECRET_KEY, OPTIONS);

OPTIONS is optional and any parameters in OPTIONS are optional too.

eg.

{
    namesrvAddr: "112.124.141.191:80",
    onsAddr: "http://onsaddr-internet.aliyun.com:80/rocketmq/nsaddr4client-internet",

    threadNum: 3
}

• namesrvAddr: the ONS server address
• onsAddr: an address to fetch ONS server address
• threadNum: worker thread count

Next step you should set one or more message receive function to that consumer.

consumer.on("message", function(msg, ack) {
    // DO SOMETHING
    // 
    // this function will be emitted while receiving a message
    //
    // after finishing this, call `ack.done(true)` or `ack.done(false)` to tell
    // ONS whether you're successful.
    //
    // `ack.done()` equals to `ack.done(true)`
});

After creating a consumer and set listener, you should initialize for it and then listen.

consumer.init(function(err) {
    if(err) return console.log(err);
    consumer.listen();
});

That's easy! And what's more, you can stop it when you want.

consumer.stop();

Caution: You should ack all received messages (whether done(true) or done(false)) before you call consumer.stop(), or you'll be blocked in the stop function.

You can create a producer by code following:

var Producer = require("ons").Producer;
var producer = new Producer(PRODUCER_ID, ACCESS_KEY, SECRET_KEY, OPTIONS);

OPTIONS is optional and any parameters in OPTIONS are optional too.

eg.

{
    namesrvAddr: "112.124.141.191:80",
    onsAddr: "http://onsaddr-internet.aliyun.com:80/rocketmq/nsaddr4client-internet",

    sendTimeout: 1000
}

• namesrvAddr: the ONS server address
• onsAddr: an address to fetch ONS server address
• sendTimeout: timeout for sending a message

After creating a producer, you should start it.

producer.start(function(err) {
    if(err) return console.log(err);
    console.log("Started!");
});

Now you can send message(s)!

producer.send(KEY, TOPIC, TAGS, CONTENT, DELAY, function(err, messageId) {
    console.log(arguments);
});

// or key / delay (ms) is an optional parameter

producer.send(TOPIC, TAGS, CONTENT, function(err, messageId) {
    console.log(arguments);
});

That's easy! And what's more, you can stop it when you want.

producer.stop();

You're welcome to fork and make pull requests!

「雖然我覺得不怎麼可能有人會關注我」