1 unstable release
0.4.0 | Oct 10, 2024 |
---|
#2049 in Network programming
140KB
3.5K
SLoC
zmq.rs - A native Rust implementation of ZeroMQ
DISCLAIMER: This codebase does not implement all of ZeroMQ's feature set.
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
Basic ZMTP implementation is working and tested against the reference implementation.
Supported transport types:
- TCP
- IPC (unix only)
Supported socket patterns:
- 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 tokio
, async-std
, and async-dispatcher
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
: Usetokio
as your async runtime. async-std-runtime
: Useasync-std
as your async runtime.async-dispatcher-runtime
: Useasync-dispatcher
as your async runtime.- (default)
all-transport
: Enable all the*-transport
flags ipc-transport
: Enable IPC as a transport mechanismtcp-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
Dependencies
~6–18MB
~249K SLoC