Skip to content

Commit 9db4b1e

Browse files
committed
[eclipse-iceoryx#139] Add event benchmark to readme
1 parent b4f3687 commit 9db4b1e

File tree

2 files changed

+25
-6
lines changed

2 files changed

+25
-6
lines changed

benchmarks/README.md

+24-5
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,38 @@
22

33
## Publish-Subscribe
44

5-
The benchmark quantifies the latency between a publisher sending a message and
6-
a subscriber receiving it. In the setup, a bidirectional connection is
5+
The benchmark quantifies the latency between a `Publisher` sending a message and
6+
a `Subscriber` receiving it. In the setup, a bidirectional connection is
77
established from process `a` to `b` (service name `a2b`) and back
8-
(service name `b2a`). Subscribers employ multithreaded busy waiting and promptly
8+
(service name `b2a`). `Subscriber`s employ multithreaded busy waiting and promptly
99
respond upon message reception. This process repeats `n` times, and the average
1010
latency is subsequently computed.
1111

1212
```sh
13-
cargo run --release benchmark-publish-subscribe -- --bench-all
13+
cargo run --bin benchmark-publish-subscribe --release -- --bench-all
1414
```
1515

1616
For more benchmark configuration details, see
1717

1818
```sh
19-
cargo run --release benchmark-publish-subscribe -- --help
19+
cargo run --bin benchmark-publish-subscribe --release -- --help
20+
```
21+
22+
## Event
23+
24+
The event quantifies the latency between a `Notifier` sending a notification and
25+
a `Listener` waking up from and responding to it. In the setup, a bidirectional connection is
26+
established from process `a` to `b` (service name `a2b`) and back
27+
(service name `b2a`). The `Listener` employs a blocking wait and wakes up on signal
28+
reception to promptly respond with a return signal notification. This process repeats `n`
29+
times, and the average latency is subsequently computed.
30+
31+
```sh
32+
cargo run --bin benchmark-event --release -- -i 10000
33+
```
34+
35+
For more benchmark configuration details, see
36+
37+
```sh
38+
cargo run --bin benchmark-event --release -- --help
2039
```

benchmarks/event/Cargo.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[package]
2-
name = "event-benchmark"
2+
name = "benchmark-event"
33
description = "iceoryx2: [internal] benchmark for the iceoryx2 event services"
44
categories = { workspace = true }
55
edition = { workspace = true }

0 commit comments

Comments
 (0)