| commit | f5fe0c23a4e6cffe9d781271ea08f181bf5bf6e7 | [log] [tgz] |
|---|---|---|
| author | Baodi Shi <wudixiaolongbao@icloud.com> | Thu Jan 12 14:43:25 2023 +0800 |
| committer | GitHub <noreply@github.com> | Thu Jan 12 14:43:25 2023 +0800 |
| tree | 489335700da74a4c3006d1aa4950947dab08ae80 | |
| parent | 0bef7999874f35df9229d2b2fce8d6f5df4f053d [diff] |
[refactor] optimize ci and build form source code. (#280) ### Motivation When building by source code on a Linux system, If the CPP client is present locally, the installation CPP client may fail. ### Modifications - Install the CPP client to a tmp path, not a system path. In this way, even if the CPP client exists locally, it does not affect each other. - Add README to explain that build from source code requires Node.js version greater than 16.18. - Optimize file structure.
The Pulsar Node.js client can be used to create Pulsar producers and consumers in Node.js.
This library works only in Node.js 10.x or later because it uses the node-addon-api module to wrap the C++ library.
Note
These instructions are only available for versions after 1.8.0. For versions previous to 1.8.0, you need to install the C++ client first. Please switch to the corresponding version branch of this repo to read the specific instructions.
To run the examples, skip this section.
To use the Pulsar Node.js client in your project, run:
npm install pulsar-client
or
yarn add pulsar-client
Then you can run the following simple end-to-end example:
const Pulsar = require('pulsar-client'); (async () => { // Create a client const client = new Pulsar.Client({ serviceUrl: 'pulsar://localhost:6650' }); // Create a producer const producer = await client.createProducer({ topic: 'persistent://public/default/my-topic', }); // Create a consumer const consumer = await client.subscribe({ topic: 'persistent://public/default/my-topic', subscription: 'sub1' }); // Send a message producer.send({ data: Buffer.from("hello") }); // Receive the message const msg = await consumer.receive(); console.log(msg.getData().toString()); consumer.acknowledge(msg); await producer.close(); await consumer.close(); await client.close(); })();
You should find the output as:
hello
You can see more examples in the examples directory. However, since these examples might use an API that was not released yet, you need to build this module. See the next section.
Note
Build from source code requires the Node.js version greater than 16.18
First, clone the repository.
git clone https://github.com/apache/pulsar-client-node.git cd pulsar-client-node
Since this client is a C++ addon that depends on the Pulsar C++ client, you need to install the C++ client first. You need to ensure there is a C++ compiler that supports C++11 installed in your system.
pkg/linux/download-cpp-client.sh
pkg\windows\download-cpp-client.bat
pkg/mac/build-cpp-deps-lib.sh pkg/mac/build-cpp-lib.sh
After the C++ client is installed, run the following command to build this C++ addon.
npm install
To verify it has been installed successfully, you can run an example like:
node examples/producer
You should find the output as:
Sent message: my-message-0 Sent message: my-message-1 Sent message: my-message-2 Sent message: my-message-3 Sent message: my-message-4 Sent message: my-message-5 Sent message: my-message-6 Sent message: my-message-7 Sent message: my-message-8 Sent message: my-message-9