From c43c55f0c1b309f03f0451b4745615c21a247fe7 Mon Sep 17 00:00:00 2001 From: Yunze Xu Date: Thu, 24 Nov 2022 10:36:04 +0800 Subject: [PATCH] [improve][doc] Add documents for C++ client 3.0.0 or later (#18574) Co-authored-by: tison Co-authored-by: momo-jun <60642177+momo-jun@users.noreply.github.com> --- site2/docs/client-libraries-cpp.md | 49 +++++++++++++++++++++++++++++- 1 file changed, 48 insertions(+), 1 deletion(-) diff --git a/site2/docs/client-libraries-cpp.md b/site2/docs/client-libraries-cpp.md index 11ae9383d78457..29ae1d530137a7 100644 --- a/site2/docs/client-libraries-cpp.md +++ b/site2/docs/client-libraries-cpp.md @@ -11,6 +11,47 @@ import TabItem from '@theme/TabItem'; You can use a Pulsar C++ client to create producers, consumers, and readers. For Pulsar features that C++ clients support, see [Client Feature Matrix](https://docs.google.com/spreadsheets/d/1YHYTkIXR8-Ql103u-IMI18TXLlGStK8uJjDsOOA0T20/edit#gid=1784579914). For complete examples, refer to [C++ client examples](https://github.com/apache/pulsar-client-cpp/tree/main/examples). +## Changes for version 3.0.0 or later + +The new version of the Pulsar C++ client starts from 3.0.0 and has been no longer consistent with Pulsar since 2.10.x. For the latest releases, see the [Download](/download/) page. + +Take the [3.0.0 release](https://archive.apache.org/dist/pulsar/pulsar-client-cpp-3.0.0/) for example, there are following subdirectories: +- apk-arm64: the Alpine Linux packages for ARM64 architectures +- apk-x86_64: the Alpine Linux packages for x64 architectures +- deb-arm64: the Debian-based Linux packages for ARM64 architectures +- deb-x86_64: the Debian-based Linux packages for x64 architectures +- rpm-arm64: the RedHat-based Linux packages for ARM64 architectures +- rpm-x86_64: the RedHat-based Linux packages for x64 architectures + +These Linux packages above all contain the C++ headers installed under `/usr/include` and the following libraries installed under `/usr/lib`: +- libpulsar.so: the shared library that links 3rd party dependencies statically +- libpulsar.a: the static library +- libpulsarwithdeps.a: the fat static library that includes all 3rd party dependencies + +Here is an example to link these libraries for a C++ source file named `main.cc`: + +```bash +# Link to libpulsar.so +g++ -std=c++11 main.cc -lpulsar +# Link to libpulsarwithdeps.a +g++ -std=c++11 main.cc /usr/lib/libpulsarwithdeps.a -lpthread -ldl +# Link to libpulsar.a +g++ -std=c++11 main.cc /usr/lib/libpulsar.a \ + -lprotobuf -lcurl -lssl -lcrypto -lz -lzstd -lsnappy -lpthread -ldl +``` + +:::caution + +Linking to `libpulsar.a` can be difficult for beginners because the 3rd party dependencies must be compatible. For example, the protobuf version must be 3.20.0 or higher for Pulsar C++ client 3.0.0. It's better to link to `libpulsarwithdeps.a` instead. + +::: + +:::danger + +Before 3.0.0, there was a `libpulsarnossl.so`, which is removed now. + +::: + ## Installation Use one of the following methods to install a Pulsar C++ client. @@ -104,6 +145,12 @@ If you get an error like "libpulsar.so: cannot open shared object file: No such ::: +### APK + +```bash +apk add --allow-untrusted ./apache-pulsar-client-*.apk +``` + ## Connection URLs To connect to Pulsar using client libraries, you need to specify a [Pulsar protocol](developing-binary-protocol.md) URL. @@ -398,4 +445,4 @@ client.subscribe("my-topic", "my-sub", conf, consumer); ## Schema -To work with [Pulsar schema](schema-overview.md) using C++ clients, see [Schema - Get started](schema-get-started.md). For specific schema types that C++ clients support, see [code](https://github.com/apache/pulsar-client-cpp/blob/main/include/pulsar/Schema.h). \ No newline at end of file +To work with [Pulsar schema](schema-overview.md) using C++ clients, see [Schema - Get started](schema-get-started.md). For specific schema types that C++ clients support, see [code](https://github.com/apache/pulsar-client-cpp/blob/main/include/pulsar/Schema.h).