Skip to main content

The Pulsar C++ client

Supported platformsโ€‹

The Pulsar C++ client has been successfully tested on MacOS and Linux.

Linuxโ€‹

Installโ€‹

Since the 2.1.0 release, Pulsar ships pre-built RPM and Debian packages. You can choose to download and install those packages instead of building them yourself.

RPMโ€‹

LinkCrypto files
clientasc, sha512
client-debuginfoasc, sha512
client-develasc, sha512

To install a RPM package, download the RPM packages and install them using the following command:


$ rpm -ivh apache-pulsar-client*.rpm

DEBโ€‹

LinkCrypto files
clientasc, sha512
client-develasc, sha512

To install a DEB package, download the DEB packages and install them using the following command:


$ apt install ./apache-pulsar-client*.deb

Buildโ€‹

If you want to build RPM and Debian packages off latest master, you can follow the instructions below to do so. All the instructions are run at the root directory of your cloned Pulsar repo.

There are recipes that build RPM and Debian packages containing a statically linked libpulsar.so / libpulsar.a with all the required dependencies.

To build the C++ library packages, first build the Java packages:


mvn install -DskipTests

RPMโ€‹


pulsar-client-cpp/pkg/rpm/docker-build-rpm.sh

This will build the RPM inside a Docker container and it will leave the RPMs in pulsar-client-cpp/pkg/rpm/RPMS/x86_64/.

Package nameContent
pulsar-clientShared library libpulsar.so
pulsar-client-develStatic library libpulsar.a and C++ and C headers
pulsar-client-debuginfoDebug symbols for libpulsar.so

Debโ€‹

To build Debian packages:


pulsar-client-cpp/pkg/deb/docker-build-deb.sh

Debian packages will be created at pulsar-client-cpp/pkg/deb/BUILD/DEB/

Package nameContent
pulsar-clientShared library libpulsar.so
pulsar-client-devStatic library libpulsar.a and C++ and C headers

MacOSโ€‹

Pulsar releases are available through the Homebrew core repository. You can install the C++ client library with:


brew install libpulsar

This will install the package with the library and headers.

Connection URLsโ€‹

To connect to Pulsar using client libraries, you need to specify a Pulsar protocol URL.

Pulsar protocol URLs are assigned to specific clusters, use the pulsar URI scheme and have a default port of 6650. Hereโ€™s an example for localhost:


pulsar://localhost:6650

A URL for a production Pulsar cluster may look something like this:


pulsar://pulsar.us-west.example.com:6650

If youโ€™re using TLS authentication, the URL will look like something like this:


pulsar+ssl://pulsar.us-west.example.com:6651

Consumerโ€‹


Client client("pulsar://localhost:6650");

Consumer consumer;
Result result = client.subscribe("my-topic", "my-subscribtion-name", consumer);
if (result != ResultOk) {
LOG_ERROR("Failed to subscribe: " << result);
return -1;
}

Message msg;

while (true) {
consumer.receive(msg);
LOG_INFO("Received: " << msg
<< " with payload '" << msg.getDataAsString() << "'");

consumer.acknowledge(msg);
}

client.close();

Producerโ€‹


Client client("pulsar://localhost:6650");

Producer producer;
Result result = client.createProducer("my-topic", producer);
if (result != ResultOk) {
LOG_ERROR("Error creating producer: " << result);
return -1;
}

// Publish 10 messages to the topic
for (int i = 0; i < 10; i++){
Message msg = MessageBuilder().setContent("my-message").build();
Result res = producer.send(msg);
LOG_INFO("Message sent: " << res);
}
client.close();

Authenticationโ€‹


ClientConfiguration config = ClientConfiguration();
config.setUseTls(true);
config.setTlsTrustCertsFilePath("/path/to/cacert.pem");
config.setTlsAllowInsecureConnection(false);
config.setAuth(pulsar::AuthTls::create(
"/path/to/client-cert.pem", "/path/to/client-key.pem"););

Client client("pulsar+ssl://my-broker.com:6651", config);