mirror of
https://github.com/Telecominfraproject/wlan-cloud-lib-cppkafka.git
synced 2025-11-02 11:37:50 +00:00
fbe3759fed
* header support implementation * Fixed issue when ptr is null and doesn't have a cloner function * Code complete with test cases updated travis file with v0.11.5 * Added compile time check for rdkafka header support version * Changes per last code review * Using brace list initializers
118 lines
3.8 KiB
Markdown
118 lines
3.8 KiB
Markdown
# cppkafka: high level C++ wrapper for _rdkafka_
|
|
|
|
[](https://travis-ci.org/mfontanini/cppkafka)
|
|
|
|
_cppkafka_ allows C++ applications to consume and produce messages using the Apache Kafka
|
|
protocol. The library is built on top of [_librdkafka_](https://github.com/edenhill/librdkafka),
|
|
and provides a high level API that uses modern C++ features to make it easier to write code
|
|
while keeping the wrapper's performance overhead to a minimum.
|
|
|
|
# Features
|
|
|
|
* _cppkafka_ is a high level C++ wrapper for _rdkafka_, aiming to allow using _rdkafka_ in a
|
|
simple, less error prone way.
|
|
|
|
* _cppkafka_ provides an API to produce messages as well as consuming messages, but the latter is
|
|
only supported via the high level consumer API. _cppkafka_ requires **rdkafka >= 0.9.4** in
|
|
order to use it. Other wrapped functionalities are also provided, like fetching metadata,
|
|
offsets, etc.
|
|
|
|
* _cppkafka_ provides message header support. This feature requires **rdkafka >= 0.11.4**.
|
|
|
|
* _cppkafka_ tries to add minimal overhead over _librdkafka_. A very thin wrapper for _librdkafka_
|
|
messages is used for consumption so there's virtually no overhead at all.
|
|
|
|
# It's simple!
|
|
|
|
_cppkafka_'s API is simple to use. For example, this code creates a producer that writes a message
|
|
into some partition:
|
|
|
|
```c++
|
|
#include <cppkafka/cppkafka.h>
|
|
|
|
using namespace std;
|
|
using namespace cppkafka;
|
|
|
|
int main() {
|
|
// Create the config
|
|
Configuration config = {
|
|
{ "metadata.broker.list", "127.0.0.1:9092" }
|
|
};
|
|
|
|
// Create the producer
|
|
Producer producer(config);
|
|
|
|
// Produce a message!
|
|
string message = "hey there!";
|
|
producer.produce(MessageBuilder("my_topic").partition(0).payload(message));
|
|
producer.flush();
|
|
}
|
|
```
|
|
|
|
# Compiling
|
|
|
|
In order to compile _cppkafka_ you need:
|
|
|
|
* _librdkafka >= 0.9.4_
|
|
* _CMake_
|
|
* A compiler with good C++11 support (e.g. gcc >= 4.8). This was tested successfully on
|
|
_g++ 4.8.3_.
|
|
* The boost library.
|
|
|
|
Now, in order to build, just run:
|
|
|
|
```Shell
|
|
mkdir build
|
|
cd build
|
|
cmake <OPTIONS> ..
|
|
make
|
|
```
|
|
|
|
## CMake options
|
|
|
|
The following cmake options can be specified:
|
|
* `RDKAFKA_ROOT_DIR` : Specify a different librdkafka install directory.
|
|
* `BOOST_ROOT` : Specify a different Boost install directory.
|
|
* `CPPKAFKA_CMAKE_VERBOSE` : Generate verbose output. Default is `OFF`.
|
|
* `CPPKAFKA_BUILD_SHARED` : Build cppkafka as a shared library. Default is `ON`.
|
|
* `CPPKAFKA_DISABLE_TESTS` : Disable build of cppkafka tests. Default is `OFF`.
|
|
* `CPPKAFKA_DISABLE_EXAMPLES` : Disable build of cppkafka examples. Default is `OFF`.
|
|
* `CPPKAFKA_BOOST_STATIC_LIBS` : Link with Boost static libraries. Default is `ON`.
|
|
* `CPPKAFKA_BOOST_USE_MULTITHREADED` : Use Boost multi-threaded libraries. Default is `ON`.
|
|
* `CPPKAFKA_RDKAFKA_STATIC_LIB` : Link to Rdkafka static library. Default is `OFF`.
|
|
|
|
Example:
|
|
```Shell
|
|
cmake -DRDKAFKA_ROOT_DIR=/some/other/dir -DCPPKAFKA_BUILD_SHARED=OFF ...
|
|
```
|
|
|
|
The `RDKAFKA_ROOT_DIR` must contain the following structure. If the system
|
|
architecture is 64-bit and both `lib` and `lib64` folders are available, the `lib64`
|
|
folder location will be selected by cmake.
|
|
|
|
```Shell
|
|
${RDKAFKA_ROOT_DIR}/
|
|
|
|
|
+ include/librdkafka/rdkafka.h
|
|
|
|
|
+ lib/librdkafka.a
|
|
|
|
|
+ lib64/librdkafka.a (optional)
|
|
```
|
|
|
|
# Using
|
|
|
|
If you want to use _cppkafka_, you'll need to link your application with:
|
|
|
|
* _cppkafka_
|
|
* _rdkafka_
|
|
|
|
# Documentation
|
|
|
|
You can generate the documentation by running `make docs` inside the build directory. This requires
|
|
_Doxygen_ to be installed. The documentation will be written in html format at
|
|
`<build-dir>/docs/html/`.
|
|
|
|
Make sure to check the [wiki](https://github.com/mfontanini/cppkafka/wiki) which includes
|
|
some documentation about the project and some of its features.
|