CZMQ - High-level C binding for ØMQ

| Linux & MacOSX | Windows | |:--------------:|:--------:| |||

Overview

Scope and Goals

Ownership and License

Using CZMQ

Install from a package manager

Linux
MacOS
Windows

Building on Linux and macOS

Building on Windows

Using CMake
Using MSBuild (Out of date, may not work now!)

Building for iOS

Linking with an Application

Use from Other Languages

API v3 Summary

zactor - simple actor framework
zauth - authentication for ZeroMQ security mechanisms
zbeacon - LAN discovery and presence
zcert - work with CURVE security certificates
zcertstore - work with CURVE security certificate stores
zchunk - work with memory chunks
zclock - millisecond clocks and delays
zconfig - work with config files written in rfc.zeromq.org/spec:4/ZPL.
zdigest - provides hashing functions (SHA-1 at present)
zdir - work with file-system directories
zdir_patch - work with directory patches
zfile - provides methods to work with files in a portable fashion.
zframe - working with single message frames
zgossip - decentralized configuration management
zhash - simple generic hash container
zhashx - extended generic hash container
ziflist - list of network interfaces available on system
zlist - simple generic list container
zlistx - extended generic list container
zloop - event-driven reactor
zmonitor - socket event monitor
zmsg - working with multipart messages
zpoller - trivial socket poller class
zproc - process configuration and status
zproxy - run a steerable proxy in the background
zrex - work with regular expressions
zsock - high-level socket API that hides libzmq contexts and sockets
zstr - sending and receiving strings
zsys - system-level methods
ztimerset - timer set
ztrie - simple trie for tokenizable strings
zuuid - UUID support class

Error Handling

CZMQ Actors

Under the Hood

Adding a New Class

Documentation

Development

Porting CZMQ

Hints to Contributors

Code Generation

Docker
Linux and MacOS

This Document

Overview

Scope and Goals

CZMQ has these goals:

To wrap the ØMQ core API in semantics that lead to shorter, more readable applications.
To hide as far as possible the differences between different versions of ØMQ (2.x, 3.x, 4.x).
To provide a space for development of more sophisticated API semantics.
To wrap the ØMQ security features with high-level tools and APIs.
To become the basis for other language bindings built on top of CZMQ.

CZMQ grew out of concepts developed in ØMQ - The Guide.

Ownership and License

The contributors are listed in AUTHORS. This project uses the MPL v2 license, see LICENSE.

CZMQ uses the C4.1 (Collective Code Construction Contract) process for contributions.

CZMQ uses the CLASS (C Language Style for Scalabilty) guide for code style.

To report an issue, use the CZMQ issue tracker at github.com.

Using CZMQ

Install from a package manager

Linux

Deb packages are available for Debian and Ubuntu.

For other distros please refer to pkgs.org.

You can also get prebuild binaries for latest git master for most distros on openSUSE's Build Service:

Git master only stable APIs: http://software.opensuse.org/download.html?project=network%3Amessaging%3Azeromq%3Agit-stable&package=czmq

Git master including draft APIs: http://software.opensuse.org/download.html?project=network%3Amessaging%3Azeromq%3Agit-draft&package=czmq

MacOS

On macOS install czmq with Homebrew see here.

Windows

Using vcpkg

If you are already using vcpkg, you can download and install czmq with one single command:

vcpkg.exe install czmq

this will build czmq as a 32-bit shared library.

vcpkg.exe install czmq:x64-windows-static

this will build czmq as a 64-bit static library.

You may also build czmq with one or more optional libraries:

vcpkg.exe install czmq[curl,httpd,lz4]:x64-windows

this will build czmq with libcurl, libmicrohttpd, lz4, as a 64-bit shared library.

To use the draft APIs, you may build czmq with draft feature:

vcpkg install czmq[draft]

If you are an adventurer, and want to always use the latest version of czmq, pass an extra --head option:

vcpkg.exe install czmq --head

These commands will also print out instructions on how to use the library from your MSBuild or CMake-based projects.

Building on Linux and macOS

To start with, you need at least these packages:

git -- git is how we share code with other people.
build-essential, libtool, pkg-config - the C compiler and related tools.
autotools-dev, autoconf, automake - the GNU autoconf makefile generators.
cmake - the CMake makefile generators (an alternative to autoconf).

Plus some others:

uuid-dev, libpcre3-dev - utility libraries.
valgrind - a useful tool for checking your code.
pkg-config - an optional useful tool to make building with dependencies easier.

Which we install like this (using the Debian-style apt-get package manager):

sudo apt-get update
sudo apt-get install -y \
    git build-essential libtool \
    pkg-config autotools-dev autoconf automake cmake \
    uuid-dev libpcre3-dev valgrind

# only execute this next line if interested in updating the man pages as well (adds to build time):
sudo apt-get install -y asciidoc

Here's how to build CZMQ from GitHub (building from packages is very similar, you don't clone a repo but unpack a tarball), including the libzmq (ZeroMQ core) library (NOTE: skip ldconfig on OSX):

git clone https://github.com/zeromq/libzmq.git
cd libzmq
./autogen.sh
# do not specify "--with-libsodium" if you prefer to use internal tweetnacl security implementation (recommended for development)
./configure --with-libsodium
make check
sudo make install
sudo ldconfig
cd ..

git clone https://github.com/zeromq/czmq.git
cd czmq
./autogen.sh && ./configure && make check
sudo make install
sudo ldconfig
cd ..

In general CZMQ works best with the latest libzmq master. If you already have an older version of libzmq installed on your system, e.g. in /usr/, then you ca

Czmq

Install / Use

README