Skip to content

Commit 903b80d

Browse files
committed
[#687] Add benchmark documentation
1 parent e532871 commit 903b80d

File tree

2 files changed

+32
-0
lines changed

2 files changed

+32
-0
lines changed

benchmarks/README.md

+30
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Benchmarks
22

3+
1. [Publish-Subscribe](#Publish-Subscribe)
4+
2. [Request-Response](#Request-Response)
5+
3. [Event](#Event)
6+
4. [Queue](#Queue)
7+
38
## Publish-Subscribe
49

510
The benchmark quantifies the latency between a `Publisher` sending a message and
@@ -19,6 +24,31 @@ For more benchmark configuration details, see
1924
cargo run --bin benchmark-publish-subscribe --release -- --help
2025
```
2126

27+
## Request-Response
28+
29+
The benchmark quantifies two scenarios:
30+
31+
1. The latency between a `Client` sending a request and a `Server` receiving it.
32+
2. The latency of a response stream from an established request-response
33+
connection. So sending a stream of responses from an `ActiveRequest` to the
34+
corresponding `PendingResponse`.
35+
36+
In the setup, a bidirectional connection is
37+
established from process `a` to `b` (service name `a2b`) and back (service name
38+
`b2a`). `PendingResponse`s employ multithreaded busy waiting and promptly
39+
respond upon message reception. This process repeats `n` times, and the average
40+
latency is subsequently computed.
41+
42+
```sh
43+
cargo run --bin benchmark-request-response --release
44+
```
45+
46+
For more benchmark configuration details, see
47+
48+
```sh
49+
cargo run --bin benchmark-request-response --release -- --help
50+
```
51+
2252
## Event
2353

2454
The event quantifies the latency between a `Notifier` sending a notification and

doc/release-notes/iceoryx2-unreleased.md

+2
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@
3737
[#643](https://github.com/eclipse-iceoryx/iceoryx2/issues/643)
3838
* Expose set_log_level_from_env* APIs to C++
3939
[#653](https://github.com/eclipse-iceoryx/iceoryx2/issues/653)
40+
* Add benchmark for request-response
41+
[#687](https://github.com/eclipse-iceoryx/iceoryx2/issues/687)
4042

4143
### Bugfixes
4244

0 commit comments

Comments
 (0)