-
Notifications
You must be signed in to change notification settings - Fork 40
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[#390] Fix clippy warnings and write example readme
- Loading branch information
Showing
2 changed files
with
38 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,35 @@ | ||
# Event-Based Communication | ||
|
||
## Running The Example | ||
|
||
This example demonstrates iceoryx2's event multiplexing mechanism in a more | ||
complex setup. The iceoryx2 `Publisher` and `Subscriber` are integrated into | ||
custom `ExamplePublisher` and `ExampleSubscriber` classes, which also | ||
incorporate an additional iceoryx2 `Notifier` and `Listener`. This setup | ||
enables automatic event emission whenever an `ExamplePublisher` or | ||
`ExampleSubscriber` is created or dropped. Additionally, events are emitted | ||
whenever a new `Sample` is sent or received. | ||
|
||
When a `struct` implements `SynchronousMultiplexing`, it can be attached to a | ||
`WaitSet`. Both `ExamplePublisher` and `ExampleSubscriber` implement this | ||
interface by forwarding calls to their underlying `Listener`, which already | ||
provides an implementation of `SynchronousMultiplexing`. | ||
|
||
The `WaitSet` notifies the user of the origin of an event notification. The | ||
user can then acquire the `EventId` from the `Listener`. Based on the value of | ||
the `EventId`, the user can identify the specific event that occurred and take | ||
appropriate action. | ||
|
||
### Terminal 1 | ||
|
||
```sh | ||
cargo run --example event_based_comm_publisher | ||
``` | ||
|
||
### Terminal 2 | ||
|
||
```sh | ||
cargo run --example event_based_comm_subscriber | ||
``` | ||
|
||
Feel free to run multiple publishers or subscribers in parallel. |