mirror of
https://github.com/zeromq/cppzmq.git
synced 2024-12-12 18:40:28 +01:00
131 lines
5.6 KiB
Markdown
131 lines
5.6 KiB
Markdown
[](https://travis-ci.org/zeromq/cppzmq)
|
|
[](https://ci.appveyor.com/project/zeromq/cppzmq/branch/master)
|
|
[](https://coveralls.io/github/zeromq/cppzmq?branch=master)
|
|
[](https://github.com/zeromq/cppzmq/blob/master/LICENSE)
|
|
|
|
Introduction & Design Goals
|
|
===========================
|
|
|
|
cppzmq is a C++ binding for libzmq. It has the following design goals:
|
|
- cppzmq maps the libzmq C API to C++ concepts. In particular:
|
|
- it is type-safe (the libzmq C API exposes various class-like concepts as void*)
|
|
- it provides exception-based error handling (the libzmq C API provides errno-based error handling)
|
|
- it provides RAII-style classes that automate resource management (the libzmq C API requires the user to take care to free resources explicitly)
|
|
- cppzmq is a light-weight, header-only binding. You only need to include the header file zmq.hpp (and maybe zmq_addon.hpp) to use it.
|
|
- zmq.hpp is meant to contain direct mappings of the abstractions provided by the libzmq C API, while zmq_addon.hpp provides additional higher-level abstractions.
|
|
|
|
There are other C++ bindings for ZeroMQ with different design goals. In particular, none of the following bindings are header-only:
|
|
- [zmqpp](https://github.com/zeromq/zmqpp) is a high-level binding to libzmq.
|
|
- [czmqpp](https://github.com/zeromq/czmqpp) is a binding based on the high-level czmq API.
|
|
- [fbzmq](https://github.com/facebook/fbzmq) is a binding that integrates with Apache Thrift and provides higher-level abstractions in addition. It requires C++14.
|
|
|
|
Supported platforms
|
|
===================
|
|
|
|
- Only a subset of the platforms that are supported by libzmq itself are supported. Some features already require a compiler supporting C++11. In the future, probably all features will require C++11. To build and run the tests, CMake and Catch are required.
|
|
- Any libzmq 4.x version is expected to work. DRAFT features may only work for the most recent tested version. Currently explicitly tested libzmq versions are
|
|
- 4.2.0 (without DRAFT API)
|
|
- 4.2.5 (without DRAFT API)
|
|
- 4.3.1 (with and without DRAFT API)
|
|
- Platforms with full support (i.e. CI executing build and tests)
|
|
- Ubuntu 14.04 x64 (with gcc 4.8.4) (without DRAFT API only)
|
|
- Ubuntu 14.04 x64 (with gcc 7.3.0)
|
|
- Visual Studio 2015 x86
|
|
- Visual Studio 2017 x86
|
|
- OSX (with clang xcode9.1) (without DRAFT API)
|
|
- Additional platforms that are known to work:
|
|
- We have no current reports on additional platforms that are known to work yet. Please add your platform here. If CI can be provided for them with a cloud-based CI service working with GitHub, you are invited to add CI, and make it possible to be included in the list above.
|
|
- Additional platforms that probably work:
|
|
- Any platform supported by libzmq that provides a sufficiently recent gcc (4.8.1 or newer) or clang (3.4.1 or newer)
|
|
- Visual Studio 2012+ x86/x64
|
|
|
|
Examples
|
|
========
|
|
These examples require at least C++11.
|
|
```c++
|
|
#include <zmq.hpp>
|
|
|
|
int main()
|
|
{
|
|
zmq::context_t ctx;
|
|
zmq::socket_t sock(ctx, zmq::socket_type::push);
|
|
sock.bind("inproc://test");
|
|
sock.send(zmq::str_buffer("Hello, world"), zmq::send_flags::dontwait);
|
|
}
|
|
```
|
|
This a more complex example where we send and receive multi-part messages.
|
|
```c++
|
|
#include <iostream>
|
|
#include <zmq_addon.hpp>
|
|
|
|
int main()
|
|
{
|
|
zmq::context_t ctx;
|
|
zmq::socket_t sock1(ctx, zmq::socket_type::pair);
|
|
zmq::socket_t sock2(ctx, zmq::socket_type::pair);
|
|
sock1.bind("inproc://test");
|
|
sock2.connect("inproc://test");
|
|
|
|
std::array<zmq::const_buffer, 2> send_msgs = {
|
|
zmq::str_buffer("foo"),
|
|
zmq::str_buffer("bar!")
|
|
};
|
|
if (!zmq::send_multipart(sock1, send_msgs))
|
|
return 1;
|
|
|
|
std::vector<zmq::message_t> recv_msgs;
|
|
const auto ret = zmq::recv_multipart(
|
|
sock2, std::back_inserter(recv_msgs));
|
|
if (!ret)
|
|
return 1;
|
|
std::cout << "Got " << *ret
|
|
<< " messages" << std::endl;
|
|
return 0;
|
|
}
|
|
```
|
|
|
|
Compatibility Guidelines
|
|
========================
|
|
|
|
The users of cppzmq are expected to follow the guidelines below to ensure not to break when upgrading cppzmq to newer versions (non-exhaustive list):
|
|
|
|
* Do not depend on any macros defined in cppzmq unless explicitly declared public here.
|
|
|
|
The following macros may be used by consumers of cppzmq: `CPPZMQ_VERSION`, `CPPZMQ_VERSION_MAJOR`, `CPPZMQ_VERSION_MINOR`, `CPPZMQ_VERSION_PATCH`.
|
|
|
|
Contribution policy
|
|
===================
|
|
|
|
The contribution policy is at: http://rfc.zeromq.org/spec:22
|
|
|
|
Build instructions
|
|
==================
|
|
|
|
Build steps:
|
|
|
|
1. Build [libzmq](https://github.com/zeromq/libzmq) via cmake. This does an out of source build and installs the build files
|
|
- download and unzip the lib, cd to directory
|
|
- mkdir build
|
|
- cd build
|
|
- cmake ..
|
|
- sudo make -j4 install
|
|
|
|
2. Build cppzmq via cmake. This does an out of source build and installs the build files
|
|
- download and unzip the lib, cd to directory
|
|
- mkdir build
|
|
- cd build
|
|
- cmake ..
|
|
- sudo make -j4 install
|
|
|
|
Using this:
|
|
|
|
A cmake find package scripts is provided for you to easily include this library.
|
|
Add these lines in your CMakeLists.txt to include the headers and library files of
|
|
cpp zmq (which will also include libzmq for you).
|
|
|
|
```
|
|
#find cppzmq wrapper, installed by make of cppzmq
|
|
find_package(cppzmq)
|
|
target_link_libraries(*Your Project Name* cppzmq)
|
|
```
|