Hey! Welcome to ZeroBase, a pub-sub communications framework based on ZeroMQ for multiprocessing systems!
This is a C++ library that provides a base class for building ZeroMQ & pub-sub based programs, while easily using multiple threads. It handles all of the necessary setup and teardown for ZeroMQ, and provides a simple interface for sending and receiving messages. The library is designed to be easy to use and flexible, allowing you to quickly build and deploy ZeroMQ-based programs for a variety of use cases.
With ZeroBase, you can focus on building the application logic, while the library takes care of the underlying ZeroMQ infrastructure.
That being said, it is still a work in progress, so don't hesitate to create an issue or start a PR!
Yours truly,
Augusto M.P
Below you'll find the necessary information to install and get started with ZeroBase as a static library. For in-depth documentation, check out the docs folder in the zerobase-python repo. Eventually, the docs will be moved to a central location.
The library is built using CMake, so you'll need to have that installed. You can find instructions for installing CMake here. You'll also need a C++ compiler, such as gcc or clang. Finally, you'll need to have libzmq (version >= 4.3.4) installed. You can find instructions for installing libzmq here.
| Option | Description | Default |
|---|---|---|
ZB_BUILD_TESTS |
Build the tests | ON |
ZB_BUILD_EXAMPLES |
Build the examples | ON |
- Clone the repo (as a submodule or otherwise) into the
vendordirectory. - Add the following to your
CMakeLists.txtfile (of course, this can be modified to suit your needs):
add_subdirectory(vendor/zerobase-cpp)
target_link_libraries(<your-target> zerobase)- Run
cmakeand your build system of choice. - Include the
zerobase.hheader in your source files!
Once you have the library, take a look at examples/basic.cpp for a basic example on how to use the library.
The main function generates random messages and sends them on example topics "A", "B", and "C". The MsgReceived function is called whenever a message is received on one of the subscribed topics, and simply prints out the message and topic.
To customize the code for your own use case, you can modify the main function to generate and send messages on different topics, and modify the MsgReceived function to handle incoming messages according to the given topic. You can also modify the passed vectors for publisher and subscriber config objects to change the addresses and topics used by the publisher and subscribers.
For more complex examples, check out the complete examples directory.
This project is licensed under the GPLv3 license - see the LICENSE file for details.