#bus #ipc #pubsub

bin+lib elbus

Local and network IPC bus

39 releases

Uses new Rust 2021

0.2.12 Aug 5, 2022
0.2.9 Jul 9, 2022
0.1.26 Mar 27, 2022

#196 in Network programming

Download history 57/week @ 2022-04-24 143/week @ 2022-05-01 138/week @ 2022-05-08 452/week @ 2022-05-15 115/week @ 2022-05-22 277/week @ 2022-05-29 204/week @ 2022-06-05 149/week @ 2022-06-12 43/week @ 2022-06-19 15/week @ 2022-06-26 59/week @ 2022-07-03 113/week @ 2022-07-10 64/week @ 2022-07-17 127/week @ 2022-07-24 165/week @ 2022-07-31 69/week @ 2022-08-07

426 downloads per month
Used in 5 crates

Apache-2.0

240KB
6.5K SLoC

Rust 4.5K SLoC // 0.0% comments Python 1.5K SLoC // 0.0% comments JavaScript 636 SLoC // 0.0% comments Shell 14 SLoC

ELBUS - Rust-native IPC broker

https://elbus.bma.ai/

What is ELBUS

ELBUS is a rust-native IPC broker, written in Rust/Tokio, inspired by NATS, ZeroMQ and Nanomsg. ELBUS is fast, flexible and very easy to use.

The library can be embedded in any Rust project or be used as a standalone server.

NOTE: ELBUS is not officially released yet and SDK can be changed at any time without any backward compatibility. ELBUS (stands actually for "EVA ICS Local Bus") is the key component of EVA ICS v4, which is going to be released in 2022-2023.

The name "ELBUS" is also only the working one, after the official release the bus will be renamed, as well as its crates, bindings and modules.

Documentation

Available at https://elbus.readthedocs.io/

Inter-process communication

The following communication patterns are supported out-of-the-box:

  • one-to-one messages
  • one-to-many messages
  • pub/sub

The following channels are supported:

  • async channels between threads/futures (Rust only)
  • UNIX sockets (local machine)
  • TCP sockets

In addition to Rust, ELBUS has also bindings for the following languages:

Rust crate: https://crates.io/crates/elbus

Client registration

A client should register with a name "group.subgroup.client" (subgroups are optional). The client's name can not start with dot (".", reserved for internal broker clients) if registered via IPC.

The client's name must be unique, otherwise the broker refuses the registration.

Broadcasts

Broadcast messages are sent to multiple clients at once. Use "?" for any part of the path, "*" as the ending for wildcards. E.g.:

"?.test.*" - the message is be sent to clients "g1.test.client1", "g1.test.subgroup.client2" etc.

Topics

Use MQTT-format for topics: "+" for any part of the path, "#" as the ending for wildcards. E.g. a client, subscribed to "+/topic/#" receives publications sent to "x/topic/event", "x/topic/sub/event" etc.

RPC layer

An optional included RPC layer for one-to-one messaging can be used. The layer is similar to JSON RPC but is optimized for byte communications.

Security and reliability model

ELBUS has a very simple optional security model in favor of simplicity and speed. Also, ELBUS is not designed to work via unstable connections, all clients should be connected either from the local machine or using high-speed reliable local network communications.

If you need a pub/sub server for a wide area network, try PSRT.

Examples

See examples folder.

Build a stand-alone server

cargo build --features server,rpc

The "rpc" feature is optional. When enabled for the server, it allows to initialize the default broker RPC API, spawn fifo servers, send broker announcements etc.

Some numbers

Benchmarks

CPU: i7-7700HQ

Broker: 4 workers, clients: 8, payload size: 100 bytes, local IPC (single unix socket), totals:

stage iters/s
rpc.call 126_824
rpc.call+handle 64_694
rpc.call0 178_505
send+recv.qos.no 1_667_131
send+recv.qos.processed 147_812
send.qos.no 2_748_870
send.qos.processed 183_795

About the authors

Bohemia Automation / Altertech is a group of companies with 15+ years of experience in the enterprise automation and industrial IoT. Our setups include power plants, factories and urban infrastructure. Largest of them have 1M+ sensors and controlled devices and the bar raises higher and higher every day.

Dependencies

~3–11MB
~178K SLoC