jonhoo/bus

Efficient, lock-free, bounded Rust broadcast channel

Rust

846

176 commits

updated Sep 9, 2023

See the code

README

bus

Crates.io Documentation Codecov

Bus provides a lock-free, bounded, single-producer, multi-consumer, broadcast channel.

NOTE: bus sometimes busy-waits in the current implementation, which may cause increased CPU usage — see #23.

It uses a circular buffer and atomic instructions to implement a lock-free single-producer, multi-consumer channel. The interface is similar to that of the std::sync::mpsc channels, except that multiple consumers (readers of the channel) can be produced, whereas only a single sender can exist. Furthermore, in contrast to most multi-consumer FIFO queues, bus is broadcast; every send goes to every consumer.

I haven't seen this particular implementation in literature (some extra bookkeeping is necessary to allow multiple consumers), but a lot of related reading can be found in Ross Bencina's blog post "Some notes on lock-free and wait-free algorithms".

See the documentation for usage examples.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

broadcast
communication
lock-free
rust
synchronization

jonhoo/bus

Efficient, lock-free, bounded Rust broadcast channel

Rust

846

176 commits

updated Sep 9, 2023

See the code

README

bus

Crates.io Documentation Codecov

Bus provides a lock-free, bounded, single-producer, multi-consumer, broadcast channel.

NOTE: bus sometimes busy-waits in the current implementation, which may cause increased CPU usage — see #23.

It uses a circular buffer and atomic instructions to implement a lock-free single-producer, multi-consumer channel. The interface is similar to that of the std::sync::mpsc channels, except that multiple consumers (readers of the channel) can be produced, whereas only a single sender can exist. Furthermore, in contrast to most multi-consumer FIFO queues, bus is broadcast; every send goes to every consumer.

I haven't seen this particular implementation in literature (some extra bookkeeping is necessary to allow multiple consumers), but a lot of related reading can be found in Ross Bencina's blog post "Some notes on lock-free and wait-free algorithms".

See the documentation for usage examples.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

broadcast
communication
lock-free
rust
synchronization

Project health

Overall

4.6/10

Maintained

0/10

Code review

3/10
OpenSSF Scorecard

crates.io

Latest release

2.4.1 · Aug 20, 2023

Releases this year

0

Significant stargazers

(top 24 of 29)

Pascal Hertleif

970 followers · starred Jul 2019

Michael Murphy

837 followers · starred Jul 2018

Itamar Turner-Trauring

408 followers · starred Jan 2021

Emmanuel Leblond

207 followers · starred Mar 2023