2013-07-14 00:55:40 +02:00
|
|
|
# ZeroMQ
|
|
|
|
|
|
|
|
[![Build Status](https://travis-ci.org/zeromq/libzmq.png?branch=master)](https://travis-ci.org/zeromq/libzmq)
|
2015-10-26 08:59:22 +01:00
|
|
|
[![Build status](https://ci.appveyor.com/api/projects/status/e2ks424yrs1un3wt?svg=true)](https://ci.appveyor.com/project/zeromq/libzmq)
|
2016-03-13 21:45:49 +01:00
|
|
|
[![Coverage Status](https://coveralls.io/repos/github/zeromq/libzmq/badge.svg?branch=master)](https://coveralls.io/github/zeromq/libzmq?branch=master)
|
2013-07-14 00:55:40 +02:00
|
|
|
|
|
|
|
## Welcome
|
2010-03-16 16:20:23 +01:00
|
|
|
|
2015-06-02 23:44:12 +02:00
|
|
|
The ZeroMQ lightweight messaging kernel is a library which extends the
|
2010-03-16 16:20:23 +01:00
|
|
|
standard socket interfaces with features traditionally provided by
|
2015-06-02 23:44:12 +02:00
|
|
|
specialised messaging middleware products. ZeroMQ sockets provide an
|
2010-03-16 16:20:23 +01:00
|
|
|
abstraction of asynchronous message queues, multiple messaging patterns,
|
|
|
|
message filtering (subscriptions), seamless access to multiple transport
|
|
|
|
protocols and more.
|
|
|
|
|
2019-02-19 21:31:30 +01:00
|
|
|
## Supported platforms <a name="#platforms"/>
|
|
|
|
|
|
|
|
### Supported platforms with primary CI
|
|
|
|
|
|
|
|
OS and version | Architecture | Compiler and version | Build system | Remarks
|
|
|
|
-------------- | ------------ | -------------------- | ------------ | -------
|
|
|
|
Android NDK 11c | ARM | gcc ? | autotools |
|
|
|
|
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
|
|
|
|
-------------- | ------------ | -------------------- | ------------ | ----------- | -------
|
2019-03-18 11:43:11 +01:00
|
|
|
Solaris 10 | x86, amd64, sparc | GCC 8.1.0 | CMake | 2019/03/18 |
|
2019-02-19 21:31:30 +01:00
|
|
|
|
|
|
|
|
|
|
|
### 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 |
|
|
|
|
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](SupportedPlatforms.md).
|
|
|
|
|
|
|
|
For some platforms (Linux, Mac OS X), [prebuilt binary packages are supplied by the ZeroMQ organization](#installation).
|
|
|
|
For other platforms, you need to [build your own binaries](#build).
|
|
|
|
|
|
|
|
## Installation of binary packages <a name="installation"/>
|
2010-03-16 16:20:23 +01:00
|
|
|
|
2017-08-21 12:09:32 +02:00
|
|
|
### 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](https://img.shields.io/badge/OBS%20master-stable-yellow.svg)](http://software.opensuse.org/download.html?project=network%3Amessaging%3Azeromq%3Arelease-stable&package=libzmq3-dev)
|
|
|
|
[![OBS release draft](https://img.shields.io/badge/OBS%20master-draft-yellow.svg)](http://software.opensuse.org/download.html?project=network%3Amessaging%3Azeromq%3Arelease-draft&package=libzmq3-dev)
|
|
|
|
|
|
|
|
##### RPM
|
|
|
|
|
|
|
|
[![OBS release stable](https://img.shields.io/badge/OBS%20master-stable-yellow.svg)](http://software.opensuse.org/download.html?project=network%3Amessaging%3Azeromq%3Arelease-stable&package=zeromq-devel)
|
|
|
|
[![OBS release draft](https://img.shields.io/badge/OBS%20master-draft-yellow.svg)](http://software.opensuse.org/download.html?project=network%3Amessaging%3Azeromq%3Arelease-draft&package=zeromq-devel)
|
|
|
|
|
|
|
|
#### Bleeding edge packages
|
|
|
|
|
|
|
|
##### DEB
|
|
|
|
|
|
|
|
[![OBS release stable](https://img.shields.io/badge/OBS%20master-stable-yellow.svg)](http://software.opensuse.org/download.html?project=network%3Amessaging%3Azeromq%3Agit-stable&package=libzmq3-dev)
|
|
|
|
[![OBS release draft](https://img.shields.io/badge/OBS%20master-draft-yellow.svg)](http://software.opensuse.org/download.html?project=network%3Amessaging%3Azeromq%3Agit-draft&package=libzmq3-dev)
|
|
|
|
|
|
|
|
##### RPM
|
|
|
|
|
|
|
|
[![OBS release stable](https://img.shields.io/badge/OBS%20master-stable-yellow.svg)](http://software.opensuse.org/download.html?project=network%3Amessaging%3Azeromq%3Agit-stable&package=zeromq-devel)
|
|
|
|
[![OBS release draft](https://img.shields.io/badge/OBS%20master-draft-yellow.svg)](http://software.opensuse.org/download.html?project=network%3Amessaging%3Azeromq%3Agit-draft&package=zeromq-devel)
|
|
|
|
|
|
|
|
#### 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
|
|
|
|
|
2019-02-19 21:31:30 +01:00
|
|
|
## Build from sources <a name="build"/>
|
2017-08-21 12:09:32 +02:00
|
|
|
|
|
|
|
To build from sources, see the INSTALL file included with the distribution.
|
2010-03-16 16:20:23 +01:00
|
|
|
|
2013-07-14 00:55:40 +02:00
|
|
|
## Resources
|
2010-03-16 16:20:23 +01:00
|
|
|
|
2010-03-16 17:07:17 +01:00
|
|
|
Extensive documentation is provided with the distribution. Refer to
|
2015-06-02 23:44:12 +02:00
|
|
|
doc/zmq.html, or "man zmq" after you have installed libzmq on your system.
|
2010-03-16 16:20:23 +01:00
|
|
|
|
|
|
|
Website: http://www.zeromq.org/
|
|
|
|
|
|
|
|
Development mailing list: zeromq-dev@lists.zeromq.org
|
|
|
|
Announcements mailing list: zeromq-announce@lists.zeromq.org
|
|
|
|
|
2011-04-02 19:32:44 +02:00
|
|
|
Git repository: http://github.com/zeromq/libzmq
|
2010-03-16 17:07:17 +01:00
|
|
|
|
2015-06-02 23:44:12 +02:00
|
|
|
ZeroMQ developers can also be found on the IRC channel #zeromq, on the
|
2010-03-16 16:20:23 +01:00
|
|
|
Freenode network (irc.freenode.net).
|
|
|
|
|
2015-06-02 23:44:12 +02:00
|
|
|
## 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.
|
2018-11-10 12:54:50 +01:00
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
|
|
This project uses [C4(Collective Code Construction Contract)](https://rfc.zeromq.org/spec:42/C4/) process for contributions.
|