duckybsd / zmq.rs

A native implementation of ØMQ in Rust

zmq.rs - A native Rust implementation of ZeroMQ

DISCLAIMER: The codebase is very much a work in progress and feature incomplete. DO NOT USE IN PRODUCTION

ZeroMQ is a high-performance asynchronous messaging library that provides many popular messaging patterns for many transport types. They look and feel like Berkeley style sockets, but are fault tolerant and easier to use. This project aims to provide a native rust alternative to the reference implementation, and leverage Rust's async ecosystem.

Current status

A basic ZMTP implementation is working, but is not yet fully compliant to the spec. Integration tests against the reference implementation are also missing. External APIs are still subject to change - there are no semver or stability guarantees at the moment.

Supported transport types:

We plan to support most of the basic ZMQ sockets. The current list is as follows:

• TCP
• IPC (unix only)

Supported socket patterns:

We plan to support most of the basic ZMQ messaging patterns. The current list is as follows:

• Request/Response (REQ, REP, DEALER, ROUTER)
• Publish/Subscribe (PUB, SUB)
• Pipeline (PUSH, PULL)

Usage

See the examples for some ways to get up and running quickly. You can also generate the documentation by doing cargo doc --open on the source code.

Choosing your async runtime

The project currently supports both tokio and async-std, controllable via feature flags. tokio is used by default. If you want to use async-std, you would disable the default features, and then select the async-std-runtime feature. For example in your Cargo.toml, you might specify the dependency as follows:

zeromq = { version = "*", default-features = false, features = ["async-std-runtime", "all-transport"] }

See the section about feature flags for more info.

Feature Flags

Feature flags provide a way to customize the functionality provided by this library. Refer to the cargo guide for more info.

Features:

• (default) tokio-runtime: Use tokio as your async runtime.
• async-std-runtime: Use async-std as your async runtime.
• (default) all-transport: Enable all the *-transport flags
• ipc-transport: Enable IPC as a transport mechanism
• tcp-transport: Enable TCP as a transport mechanism

Contributing

Contributions are welcome! See our issue tracker for a list of the things we need help with.

Questions

You can ask quesions in our Discord channel - https://discord.gg/pFXSqWtjQT

Useful links

• https://rfc.zeromq.org/
• https://rfc.zeromq.org/spec:23/ZMTP/
• https://rfc.zeromq.org/spec:28/REQREP/
• https://rfc.zeromq.org/spec/29/