You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+26-18Lines changed: 26 additions & 18 deletions
Original file line number
Diff line number
Diff line change
@@ -21,31 +21,35 @@
21
21
22
22
# Pulsar C++ client library
23
23
24
-
Examples for using the API to publish and consume messages can be found under the [examples](https://github.com/apache/pulsar-client-cpp/tree/main/examples) folder.
24
+
Pulsar C++ clients support a variety of Pulsar features to enable building applications connecting to your Pulsar cluster.
25
+
26
+
For the supported Pulsar features, see [Client Feature Matrix](https://pulsar.apache.org/client-feature-matrix/).
27
+
28
+
For how to use APIs to publish and consume messages, see [examples](https://github.com/apache/pulsar-client-cpp/tree/main/examples).
25
29
26
30
## Generate the API documents
27
31
28
32
Pulsar C++ client uses [doxygen](https://www.doxygen.nl) to build API documents. After installing `doxygen`, you only need to run `doxygen` to generate the API documents whose main page is under the `doxygen/html/index.html` path.
29
33
30
34
## Requirements
31
35
32
-
* A C++ compiler that supports C++11, like GCC >= 4.8
If you want to build and run the tests, you need to install [GTest](https://github.com/google/googletest). Otherwise, you need to add CMake option `-DBUILD_TESTS=OFF`.
51
55
@@ -55,9 +59,9 @@ If you want to use `ClientConfiguration::setLogConfFilePath`, you need to instal
55
59
56
60
Pulsar C++ Client Library has been tested on:
57
61
58
-
* Linux
59
-
* Mac OS X
60
-
* Windows x64
62
+
- Linux
63
+
- Mac OS X
64
+
- Windows x64
61
65
62
66
## Compilation
63
67
@@ -172,7 +176,9 @@ Take Windows 64-bit library as an example, you only need to run
> NOTE: For Windows 32-bit library, change `x64-windows` to `x86-windows`, see [here](https://github.com/microsoft/vcpkg/blob/master/docs/users/triplets.md) for more details about the triplet concept in Vcpkg.
179
+
> **NOTE**:
180
+
>
181
+
> For Windows 32-bit library, change `x64-windows` to `x86-windows`, see [here](https://github.com/microsoft/vcpkg/blob/master/docs/users/triplets.md) for more details about the triplet concept in Vcpkg.
176
182
177
183
The all dependencies, which are specified by [vcpkg.json](vcpkg.json), will be installed in `vcpkg_installed/` subdirectory,
178
184
@@ -223,7 +229,7 @@ build/lib/Release/pulsar.dll
223
229
224
230
#### Examples
225
231
226
-
Add windows environment paths:
232
+
Add Windows environment paths:
227
233
228
234
```
229
235
build/lib/Release
@@ -257,8 +263,10 @@ See the [wireshark](wireshark/) directory for details.
257
263
258
264
## Requirements for Contributors
259
265
260
-
It's required to install [LLVM](https://llvm.org/builds/) for `clang-tidy` and `clang-format`. Pulsar C++ client use `clang-format`**11** to format files. `make format` automatically formats the files.
266
+
It's required to install [LLVM](https://llvm.org/builds/) for `clang-tidy` and `clang-format`. Pulsar C++ client use `clang-format`**11** to format files. `make format` automatically formats the files.
261
267
262
268
For Ubuntu users, you can install `clang-format-11` via `apt install clang-format-11`. For other users, run `./build-support/docker-format.sh` if you have Docker installed.
263
269
264
270
We welcome contributions from the open source community, kindly make sure your changes are backward compatible with GCC 4.8 and Boost 1.53.
271
+
272
+
If your contribution adds Pulsar features for C++ clients, you need to update both the [Pulsar docs](https://pulsar.apache.org/docs/client-libraries/) and the [Client Feature Matrix](https://pulsar.apache.org/client-feature-matrix/). See [Contribution Guide](https://pulsar.apache.org/contribute/site-intro/#pages) for more details.
0 commit comments