Add initial Blackboard support #7
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 |
|---|---|---|
|
|
@@ -14,6 +14,7 @@ | |
| * ✅ **Event API** - Complete notifier/listener implementation with | ||
| blocking/timed waits | ||
| * ✅ **Request-Response API** - Complete client/server RPC with verified FFI signatures | ||
| * ✅ **Blackboard API** - Key-value store pattern for shared state monitoring | ||
| * ✅ **Complex Data Types** - Full support for custom structs with sequential layout | ||
| * ✅ **Async/Await Support** - Modern async methods for all blocking operations | ||
| with CancellationToken | ||
|
|
@@ -38,7 +39,7 @@ | |
| * 🧹 **Memory-safe** - Automatic resource management via SafeHandle and IDisposable | ||
| * 🎯 **Idiomatic C#** - Builder pattern, Result types, LINQ-friendly APIs | ||
| * 🔧 **Cross-platform** - Works on Linux, macOS, and Windows | ||
| * 📦 **Multiple patterns** - Publish-Subscribe, Event, Request-Response, and Blackboard communication | ||
|
Check failure on line 42 in README.md
|
||
| * ⚡ **Async/Await** - Full async support with CancellationToken for modern C# applications | ||
| * 🔍 **Service Discovery** - Dynamically discover and monitor running services | ||
| * 🌐 **Domain Isolation** - Separate communication groups for multi-tenant deployments | ||
|
|
@@ -77,13 +78,14 @@ | |
| ### Services and Communication Patterns | ||
|
|
||
| iceoryx2 organizes communication through **services**. Each service has a unique | ||
| name and supports one of four communication patterns: | ||
|
|
||
| | Pattern | Description | Use Case | | ||
| |---------|-------------|----------| | ||
| | **Publish-Subscribe** | Many-to-many data distribution | Sensor data, telemetry, state broadcasts | | ||
| | **Event** | Lightweight notifications with event IDs | Wake-up signals, state changes, triggers | | ||
| | **Request-Response** | Client-server RPC | Commands, queries, configuration updates | | ||
| | **Blackboard** | Shared key-value store with latest values | State monitoring, configuration sharing, sensor fusion | | ||
|
|
||
| ### Nodes | ||
|
|
||
|
|
@@ -331,6 +333,18 @@ | |
| dotnet run -- listener | ||
| ``` | ||
|
|
||
| **Blackboard Example:** | ||
|
|
||
| ```bash | ||
| # Terminal 1 - Run creator | ||
| cd examples/Blackboard | ||
| dotnet run -- creator | ||
|
|
||
| # Terminal 2 - Run opener | ||
| cd examples/Blackboard | ||
| dotnet run -- opener | ||
| ``` | ||
|
|
||
| ### Alternative: Use the Build Script | ||
|
|
||
| A convenience build script is provided that handles all steps: | ||
|
|
@@ -371,13 +385,15 @@ | |
| │ │ ├── PublishSubscribe/ # Pub/Sub messaging pattern | ||
| │ │ ├── Event/ # Event-based communication | ||
| │ │ ├── RequestResponse/ # Request-Response (RPC) pattern | ||
| │ │ ├── Blackboard/ # Blackboard key-value store pattern | ||
| │ │ └── Types/ # Common types and utilities | ||
| │ └── Iceoryx2.Reactive/ # Reactive Extensions support | ||
| ├── examples/ # C# examples | ||
| │ ├── PublishSubscribe/ # Pub/Sub example | ||
| │ ├── ComplexDataTypes/ # Complex struct example | ||
| │ ├── Event/ # Event API example | ||
| │ ├── RequestResponse/ # Request-Response RPC example | ||
| │ ├── Blackboard/ # Blackboard key-value store example | ||
| │ ├── AsyncPubSub/ # Async/await patterns example | ||
| │ ├── WaitSetMultiplexing/ # Event multiplexing with WaitSet | ||
| │ └── ServiceDiscovery/ # Service discovery and monitoring | ||
|
|
||
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
|
|
||
| <PropertyGroup> | ||
| <OutputType>Exe</OutputType> | ||
| <Nullable>enable</Nullable> | ||
| <AllowUnsafeBlocks>true</AllowUnsafeBlocks> | ||
| <TargetFrameworks>net8.0;net9.0</TargetFrameworks> | ||
| </PropertyGroup> | ||
|
|
||
| <!-- Copy native library from Iceoryx2 output directory --> | ||
| <Target Name="CopyNativeLibrary" AfterTargets="Build"> | ||
| <PropertyGroup> | ||
| <Iceoryx2OutputPath>../../src/Iceoryx2/bin/$(Configuration)/$(TargetFramework)</Iceoryx2OutputPath> | ||
| </PropertyGroup> | ||
| <!-- macOS --> | ||
| <Copy SourceFiles="$(Iceoryx2OutputPath)/libiceoryx2_ffi_c.dylib" | ||
| DestinationFolder="$(OutputPath)" | ||
| Condition="Exists('$(Iceoryx2OutputPath)/libiceoryx2_ffi_c.dylib')" | ||
| SkipUnchangedFiles="true" /> | ||
| <!-- Linux --> | ||
| <Copy SourceFiles="$(Iceoryx2OutputPath)/libiceoryx2_ffi_c.so" | ||
| DestinationFolder="$(OutputPath)" | ||
| Condition="Exists('$(Iceoryx2OutputPath)/libiceoryx2_ffi_c.so')" | ||
| SkipUnchangedFiles="true" /> | ||
| <!-- Windows --> | ||
| <Copy SourceFiles="$(Iceoryx2OutputPath)/iceoryx2_ffi_c.dll" | ||
| DestinationFolder="$(OutputPath)" | ||
| Condition="Exists('$(Iceoryx2OutputPath)/iceoryx2_ffi_c.dll')" | ||
| SkipUnchangedFiles="true" /> | ||
| </Target> | ||
|
|
||
| <ItemGroup> | ||
| <ProjectReference Include="../../src/Iceoryx2/Iceoryx2.csproj" /> | ||
| <ProjectReference Include="../../src/Iceoryx2.Reactive/Iceoryx2.Reactive.csproj" /> | ||
| </ItemGroup> | ||
|
|
||
| </Project> |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you add a small Readme on how to run the example and what is happening there?
A link to https://ekxide.github.io/iceoryx2-book/main/fundamentals/messaging-patterns/blackboard.html would be help here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok...will do in the future
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@dkroenke please wait with the review while it is still in
DRAFTstate