Awesome Open Source
Awesome Open Source

CI Documentation Status Gitter License License

Eclipse zenoh

The Eclipse zenoh: Zero Overhead Pub/sub, Store/Query and Compute.

Eclipse zenoh (pronounce /zeno/) unifies data in motion, data in-use, data at rest and computations. It carefully blends traditional pub/sub with geo-distributed storages, queries and computations, while retaining a level of time and space efficiency that is well beyond any of the mainstream stacks.

Check the website zenoh.io for more detailed information.


How to install and test it

See our "Getting started" tour starting with the zenoh key concepts.


How to build it

Install Cargo and Rust. Zenoh can be succesfully compiled with Rust stable (>= 1.5.1), so no special configuration is required from your side.
To build zenoh, just type the following command after having followed the previous instructions:

$ cargo build --release --all-targets

The zenoh router is built as target/release/zenohd. All the examples are built into the target/release/examples directory. They can all work in peer-to-peer, or interconnected via the zenoh router.


Quick tests of your build:

Peer-to-peer tests:

  • pub/sub

    • run: ./target/release/examples/z_sub
    • in another shell run: ./target/release/examples/z_put
    • the subscriber should receive the publication.
  • get/eval

    • run: ./target/release/examples/z_eval
    • in another shell run: ./target/release/examples/z_get
    • the eval should display the log in it's listener, and the get should receive the eval result.

Routed tests:

  • put/store/get

    • run the zenoh router with a memory storage:
      ./target/release/zenohd --mem-storage '/demo/example/**'
    • in another shell run: ./target/release/examples/z_put
    • then run ./target/release/examples/z_get
    • the get should receive the stored publication.
  • REST API using curl tool

    • run the zenoh router with a memory storage:
      ./target/release/zenohd --mem-storage '/demo/example/**'
    • in another shell, do a publication via the REST API:
      curl -X PUT -d 'Hello World!' http://localhost:8000/demo/example/test
    • get it back via the REST API:
      curl http://localhost:8000/demo/example/test
  • router admin space via the REST API

    • run the zenoh router with a memory storage:
      ./target/release/zenohd --mem-storage '/demo/example/**'
    • in another shell, get info of the zenoh router via the zenoh admin space:
      curl http://localhost:8000/@/router/local
    • get the backends of the router (only memory by default):
      curl 'http://localhost:8000/@/router/local/**/backend/*'
    • get the storages of the local router (the memory storage configured at startup on '/demo/example/**' should be present):
      curl 'http://localhost:8000/@/router/local/**/storage/*'
    • add another memory storage on /demo/mystore/**:
      curl -X PUT -H 'content-type:application/properties' -d 'path_expr=/demo/mystore/**' http://localhost:8000/@/router/local/plugin/storages/backend/memory/storage/my-storage
    • check it has been created:
      curl 'http://localhost:8000/@/router/local/**/storage/*'

See other examples of zenoh usage:


Troubleshooting

In case of troubles, please first check on this page if the trouble and cause are already known.
Otherwise, you can ask a question on the zenoh Gitter channel, or create an issue.


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
Rust (61,502
Iot (5,592
Robotics (3,221
Networking (2,572
Embedded (1,774
Storage (1,660
Distributed Systems (1,650
Protocol (1,245
Messaging (1,194
Distributed (1,006
Distributed Computing (611
Network Programming (383
Ros2 (309
Edge Computing (306
Related Projects