aeron-rs 0.1.0

Aeron client library - fast messaging over UDP on Rust
Documentation

Aeron client written in Rust

About aeron-rs

Aeron is efficient reliable UDP and IPC message transport. Originally it was developed by RealLogic and hosted on GitHub real-logic/aeron

Aeron has two main components:

  • Media driver
  • Client library

The client library is linked with applications and allows several applications to talk with each other through Media driver(s). For more information about how Aeron works please read documentation.

aeron-rs library implements client functionality to work with Aeron Media driver. To get functioning system one need to download (and compile) Media driver from real-logic/aeron and write some Aeron enabled application using aeron-rs. Examples of such applications could be found inside the bin and in the library integration tests.

Running library tests

Integration tests for aeron-rs assume that Media driver executable (aeronmd) is present in the PATH. So prior to run these tests install aeronmd accordingly. Also integration tests designed to run sequentially one by one. Therefore use

cargo test -- --test-threads=1

command to run them.

Tips for contributors

If you use POSIX-compliant OS (or at least has /bin/sh), you can use predefined git pre-push hook to ensure coding standards are met.

ln -s ../../.pre-push.sh .git/hooks/pre-push

Also, if you use IDE from IntelliJ IDEA family with Rust plugin, you can enable autoformatting:

Settings -> Languages and Frameworks -> Rust -> Rustfmt -> Run rustfmt on Save