Go to file
Luca Boccassi c33da0ea5b Problem: we lack an (internal) definition of severity for security issues
Solution: attempt to define a reasonable one
2020-05-09 13:03:02 +01:00
.github Problem: fuzzing Github action ran on pushes on forks and fails 2020-05-06 12:39:45 +01:00
builds add wss transport and fix tipc tests when building using cmake on linux (#3857) 2020-04-13 23:03:19 +01:00
doc problem: no thread-safe alternative for ZMQ_PAIR 2020-05-09 08:49:01 +03:00
external Problem: no license.txt file for external/sha1/ 2019-07-16 17:27:01 +01:00
include problem: no thread-safe alternative for ZMQ_PAIR 2020-05-09 08:49:01 +03:00
m4 Problem: posix_memalign autoconf check broken on some platforms 2019-01-19 21:06:23 +00:00
packaging add wss transport and fix tipc tests when building using cmake on linux (#3857) 2020-04-13 23:03:19 +01:00
perf Problem: formatting not up to date 2020-02-23 18:25:20 +00:00
RELICENSE RELICENSE: Grant from laplaceyang. 2020-04-22 17:11:58 +08:00
src Merge pull request #3903 from bjovke/msvc_cplusplus 2020-05-09 10:50:43 +01:00
tests Problem: potential memory leak in test_connect_curve_fuzzer 2020-05-09 12:31:36 +01:00
tools Problem: formatting inconsistent 2018-02-02 15:47:43 +01:00
unittests Problem: sub/cancel broken with CURVE 2020-05-03 17:42:53 +01:00
.clang-format Problem: clang-format produces C++11 style nested templated arguments 2019-07-12 18:04:30 +02:00
.clang-tidy Problem: inconsistent polymorphic inheritance 2020-01-27 08:46:55 +01:00
.gitignore add wss transport and fix tipc tests when building using cmake on linux (#3857) 2020-04-13 23:03:19 +01:00
.hgeol Line-ending conversion rules for hg-git users and enabled use of .gitignore by hg-git users 2011-11-19 10:02:23 +01:00
.mailmap Fix mailmap entry for Max Skaller 2015-12-11 15:26:42 +01:00
.travis.yml Problem: we want to check for undefined behaviour in the CI 2020-05-05 12:58:39 +01:00
acinclude.m4 acinclude.m4: add -latomic to PKGCFG_LIBS_PRIVATE 2020-01-12 10:18:23 +01:00
appveyor.yml Merge pull request #3751 from sigiesec/windows-domain-sockets-signaler 2019-12-07 00:25:21 +00:00
AUTHORS Add Lionel Flandrin to AUTHORS 2018-05-02 19:24:07 +02:00
autogen.sh Fix small typo 2016-11-04 14:21:33 +01:00
branding.bmp Add ZeroMQ branding. 2012-06-12 21:30:24 -04:00
ci_build.sh Problem: syntax errors in ci_build.sh 2020-05-05 12:16:19 +01:00
ci_deploy.sh Problem: race condition breaks automated OBS release 2019-01-20 14:34:29 +00:00
CMakeLists.txt problem: no thread-safe alternative for ZMQ_PAIR 2020-05-09 08:49:01 +03:00
configure.ac Problem: memory sanitizer not enabled in CI 2020-05-06 00:14:02 +01:00
COPYING missing COPYING file added 2010-02-16 17:50:36 +01:00
COPYING.LESSER Added note about tivotisation 2013-07-29 10:42:15 +02:00
Dockerfile Add Docker support 2014-07-11 22:42:55 -03:00
Doxygen.cfg Problem: No default doxygen cfg for ZeroMQ project 2016-04-28 14:14:38 +01:00
INSTALL Problem: building on OS X may failed 2020-02-29 22:44:59 +09:00
installer.ico Add ZeroMQ branding. 2012-06-12 21:30:24 -04:00
Jenkinsfile Improve handling of Jenkinsfile failed testlog archives 2018-02-01 01:40:49 +01:00
Makefile.am problem: no thread-safe alternative for ZMQ_PAIR 2020-05-09 08:49:01 +03:00
NEWS Problem: NEWS out of date with latest changes 2020-02-23 17:37:56 +00:00
README.cygwin.md Implement a definitive cygwin target for libzmq. 2014-12-29 17:39:19 -05:00
README.doxygen.md Problem: No default doxygen cfg for ZeroMQ project 2016-04-28 14:14:38 +01:00
README.md typo fix root README 2020-04-18 15:24:14 +06:00
SECURITY.md Problem: we lack an (internal) definition of severity for security issues 2020-05-09 13:03:02 +01:00
SupportedPlatforms.md Problem: no documentation of supported platforms 2019-02-20 15:08:29 +01:00
version.sh m4_esyscmd_s doesnt seem to be portable across different systems 2011-02-07 15:06:20 +01:00

ZeroMQ

Build Status Build status Coverage Status

Welcome

The ZeroMQ lightweight messaging kernel is a library which extends the standard socket interfaces with features traditionally provided by specialised messaging middleware products. ZeroMQ sockets provide an abstraction of asynchronous message queues, multiple messaging patterns, message filtering (subscriptions), seamless access to multiple transport protocols and more.

Supported platforms

Libzmq is mainly written in C++98 with some optional C++11-fragments. For configuration either autotools or CMake is employed. See below for some lists of platforms, where libzmq has been successfully compiled on.

Supported platforms with primary CI

OS and version Architecture Compiler and version Build system Remarks
Android NDK r20 arm, arm64, x86, x86_64 llvm (see NDK) autotools DRAFT
Ubuntu 14.04.5 LTS (trusty) amd64 clang 5.0.0 autotools STABLE, extras: GSSAPI, PGM, NORM, C++98 mode only
Ubuntu 14.04.5 LTS (trusty) amd64 gcc 4.8.4 autotools STABLE, DRAFT, extras: GSSAPI, PGM, NORM, TIPC, IPV6, also POLLER=poll, POLLER=select, also valgrind and address sanitizer executions
Ubuntu 14.04.5 LTS (trusty) amd64 gcc 4.8.4 CMake 3.12.2 STABLE
Windows Server 2012 R2 x86 Visual Studio 2008 CMake 3.12.2 DRAFT
Windows Server 2012 R2 x86 Visual Studio 2010 SP1 CMake 3.12.2 DRAFT
Windows Server 2012 R2 x86 Visual Studio 2012 Update 5 CMake 3.12.2 DRAFT
Windows Server 2012 R2 x86, amd64 Visual Studio 2013 Update 5 CMake 3.12.2 DRAFT, STABLE (x86 Release only), also POLLER=epoll
Windows Server 2012 R2 x86 Visual Studio 2015 Update 3 CMake 3.12.2 DRAFT
Windows Server 2016 x86 Visual Studio 2017 15.9.6 CMake 3.13.3 DRAFT
cygwin 3.0.0 on Windows Server 2012 R2 amd64 gcc 7.4.0 CMake 3.6.2 DRAFT
MSYS2 ? on Windows Server 2012 R2 amd64 gcc 6.4.0 CMake ? DRAFT
Mac OS X 10.13 amd64 Xcode 9.4.1, Apple LLVM 9.1.0 autotools STABLE, DRAFT
Mac OS X 10.13 amd64 Xcode 9.4.1, Apple LLVM 9.1.0 CMake 3.11.4 DRAFT

Note: the platforms are regularly updated by the service providers, so this information might get out of date without any changes on the side of libzmq. For Appveyor, refer to https://www.appveyor.com/updates/ regarding platform updates. For travis-ci, refer to https://changelog.travis-ci.com/ regarding platform updates.

Supported platforms with secondary CI

OS and version Architecture Compiler and version Build system Remarks
CentOS 6 x86, amd64 ? autotools
CentOS 7 amd64 ? autotools
Debian 8.0 x86, amd64 ? autotools
Debian 9.0 ARM64, x86, amd64 ? autotools
Fedora 28 ARM64, ARM32, amd64 ? autotools
Fedora 29 ARM64, ARM32, amd64 ? autotools
Fedora Rawhide ARM64, ARM32, amd64 ? autotools
RedHat Enterprise Linux 7 amd64, ppc64 ? autotools
SuSE Linux Enterprise 12 SP4 ARM64, amd64, ppc64, s390x ? autotools
SuSE Linux Enterprise 15 amd64 ? autotools
xUbuntu 12.04 x86, amd64 ? autotools
xUbuntu 14.04 x86, amd64 ? autotools
xUbuntu 16.04 x86, amd64 ? autotools
xUbuntu 18.04 x86, amd64 ? autotools
xUbuntu 18.10 x86, amd64 ? autotools

Supported platforms with known active users

At the time of writing, no explicit reports have been available. Please report your experiences by opening a PR adding an entry or moving an entry from the section below.

Under "last report", please name either the SHA1 in case of an unreleased version, or the version number in case of a released version.

OS and version Architecture Compiler and version Build system Last report Remarks
Solaris 10 x86, amd64, sparc GCC 8.1.0 CMake 2019/03/18
DragonFly BSD amd64 gcc 8.3 autotools 2018/08/07 git-72854e63
IBM i ppc64 gcc 6.3 autotools 2019/10/02 git-25320a3
QNX 7.0 x86_64 gcc 5.4.0 CMake 4.3.2

Supported platforms without known active users

Note: this list is incomplete and inaccurate and still needs some work.

OS and version Architecture Compiler and version Build system Remarks
Any Linux distribution x86, amd64 gcc ?+, clang ?+, icc ?+ autotools, CMake
SunOS, Solaris x86, amd64 SunPro autotools, CMake
GNU/kFreeBSD ? ? autotools, CMake
FreeBSD ? ? autotools, CMake
NetBSD ? ? autotools, CMake
OpenBSD ? ? autotools, CMake
DragonFly BSD amd64 gcc 8.3 autotools, CMake
HP-UX ? ? autotools, CMake
GNU/Hurd ? ? autotools
VxWorks 6.8 ? ? ?
Windows CE ? ? ?
Windows UWP ? ? ?
OpenVMS ? ? ?

Unsupported platforms

OS and version Architecture Compiler and version Remarks
QNX 6.3 ? gcc 3.3.5 see #3371, support was added by a user, but not contributed to upstream
Windows 10 ARM, ARM64 Visual Studio 2017 see #3366, probably only minor issues

For more details, see here.

For some platforms (Linux, Mac OS X), prebuilt binary packages are supplied by the ZeroMQ organization. For other platforms, you need to build your own binaries.

Installation of binary packages

Linux

For Linux users, pre-built binary packages are available for most distributions. Note that DRAFT APIs can change at any time without warning, pick a STABLE build to avoid having them enabled.

Latest releases

DEB

OBS release stable OBS release draft

RPM

OBS release stable OBS release draft

Bleeding edge packages

DEB

OBS release stable OBS release draft

RPM

OBS release stable OBS release draft

Example: Debian 9 latest release, no DRAFT apis

echo "deb http://download.opensuse.org/repositories/network:/messaging:/zeromq:/release-stable/Debian_9.0/ ./" >> /etc/apt/sources.list
wget https://download.opensuse.org/repositories/network:/messaging:/zeromq:/release-stable/Debian_9.0/Release.key -O- | sudo apt-key add
apt-get install libzmq3-dev

OSX

For OSX users, packages are available via brew.

brew install zeromq

Build from sources

To build from sources, see the INSTALL file included with the distribution.

Android

To build from source, see README file in the android build directory.

Resources

Extensive documentation is provided with the distribution. Refer to doc/zmq.html, or "man zmq" after you have installed libzmq on your system.

Website: http://www.zeromq.org/

Development mailing list: zeromq-dev@lists.zeromq.org Announcements mailing list: zeromq-announce@lists.zeromq.org

Git repository: http://github.com/zeromq/libzmq

ZeroMQ developers can also be found on the IRC channel #zeromq, on the Freenode network (irc.freenode.net).

License

The project license is specified in COPYING and COPYING.LESSER.

libzmq is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License (LGPL) as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

As a special exception, the Contributors give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you must extend this exception to your version of the library.

libzmq is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

Contributing

This project uses C4(Collective Code Construction Contract) process for contributions.