[#1] Migration of C# Language-Binding into eclipse-iceoryx #3

patdhlk · 2025-12-18T17:04:06Z

Notes for Reviewer

Please take a look and feel free to test it! There is a good written documentation and practical examples to check out.

Pre-Review Checklist for the PR Author

Add sensible notes for the reviewer
PR title is short, expressive and meaningful
Consider switching the PR to a draft (Convert to draft)
- as draft PR, the CI will be skipped for pushes
Relevant issues are linked in the References section
Branch follows the naming format (csharp-iox2-123-introduce-posix-ipc-example)
Commits messages are according to this guideline
- Commit messages have the issue ID ([#123] Add posix ipc example)
- Keep in mind to use the same email that was used to sign the Eclipse Contributor Agreement
Assign PR to reviewer
All checks have passed (except task-list-completed)

PR Reviewer Reminders

Commits are properly organized and messages are according to the guideline
Unit tests have been written for new behavior
Public API is documented
PR title describes the changes

References

Relates #1

…es, add tests and an example.

…e README with zero-copy access details.

update workflow documentation formatting.

- Updated README.md to include new features: Service Discovery and Domain Isolation. - Expanded core concepts section with detailed explanations on Zero-Copy Shared Memory, Services and Communication Patterns, Nodes, Data Type Requirements, and Domain Isolation. - Added new examples for WaitSet Event Multiplexing and Service Discovery, demonstrating efficient event handling and dynamic service discovery. - Introduced NOTICE.md files in examples and src directories to clarify copyright and licensing information. - Improved service configuration documentation with detailed examples for Publish-Subscribe, Publisher, and Subscriber configurations.

README.md

ARCHITECTURE.md

Remove integration note and clarify NuGet installation options

examples/ArrayOfStructs/Program.cs

.gitmodules

dkroenke · 2025-12-19T18:03:46Z

Is Windows currently not supported? If so it can be added to the Roadmap and a hint to the Readme.

elBoberido · 2025-12-19T18:42:23Z

@dkroenke @budrus @elfenpiff since the C# bindings will probably never be safety certified, do we need to follow the same process like in the iceoryx2 repo? I would suggest that we relax the requirements a bit, e.g. to not have to create an issue before a pull request or have to use the issue number in the commit. What do you think?

elBoberido

@patdhlk thanks for your contribution

orecham · 2025-12-19T23:56:24Z

@patdhlk Awesome stuff :)

patdhlk · 2025-12-20T09:39:12Z

Is Windows currently not supported? If so it can be added to the Roadmap and a hint to the Readme.

@dkroenke Windows is supported, but currently excluded from CI pipelines. Please note that it is not yet as thoroughly tested as Linux or macOS.

elfenpiff · 2025-12-20T11:58:59Z

@patdhlk Thanks for all the hard work - this is amazing!

patdhlk · 2025-12-20T13:31:08Z

@dkroenke @budrus @elfenpiff since the C# bindings will probably never be safety certified, do we need to follow the same process like in the iceoryx2 repo? I would suggest that we relax the requirements a bit, e.g. to not have to create an issue before a pull request or have to use the issue number in the commit. What do you think?

@elBoberido actually, I would like to keep this workflow since it is used in an industrial production machine and the machine regulation has some traceability requirements as well. And tbh, it is not that much of effort to create an issue.

dkroenke · 2025-12-20T13:50:53Z

Windows is supported, but currently excluded from CI pipelines. Please note that it is not yet as thoroughly tested as Linux or macOS.

@patdhlk
I've tested some examples on Windows and they work fine, there is just a hiccup in the dotnet build for the examples because the iceoryx2_ffi_c.dll is not properly copied into the build folder of the example from src\Iceoryx2\bin. It happens only on Windows. When copying the file manually it works well.

My guess is that the library naming in iceoryx2 is not consistent across the platforms.
For example on Linux the library is named libiceoryx2_ffi_c.dylib but on Windows without the leading lib prefix. You can see it in the src\Iceoryx2\Iceoryx2.csproj. The CopyNativeLibrary directives in the project files of the examples does not catch that since they are looing for libiceoryx2_ffi_c.*.

Maybe a solution would be to take a similar approach for copying the library from the Iceoryx2.csproj where the differences in platforms are properly handled or maybe a wildcard/regex match could help here.

It can be fixed either in this Pull-Request or we create a follow-up ticket to handle it there together with the CI Pipelines to have no further delay of this Pull-Request and make a small note in the Readme to copy the file manually. What do you think?

patdhlk · 2025-12-20T13:53:14Z

Windows is supported, but currently excluded from CI pipelines. Please note that it is not yet as thoroughly tested as Linux or macOS.

@patdhlk

I've tested some examples on Windows and they work fine, there is just a hiccup in the dotnet build for the examples because the iceoryx2_ffi_c.dll is not properly copied into the build folder of the example from src\Iceoryx2\bin. It happens only on Windows. When copying the file manually it works well.

My guess is that the library naming in iceoryx2 is not consistent across the platforms.

For example on Linux the library is named libiceoryx2_ffi_c.dylib but on Windows without the leading lib prefix. You can see it in the src\Iceoryx2\Iceoryx2.csproj. The CopyNativeLibrary directives in the project files of the examples does not catch that since they are looing for libiceoryx2_ffi_c.*.

Maybe a solution would be to take a similar approach for copying the library from the Iceoryx2.csproj where the differences in platforms are properly handled or maybe a wildcard/regex match could help here.

It can be fixed either in this Pull-Request or we create a follow-up ticket to handle it there together with the CI Pipelines to have no further delay of this Pull-Request and make a small note in the Readme to copy the file manually. What do you think?

@dkroenke let me fix it now

- With platform-specific copy operations that handle the different naming conventions: - Each Copy task uses a Condition="Exists(...)" check so only the file that exists on the current platform gets copied, avoiding build errors on other platforms.

patdhlk · 2025-12-20T16:01:19Z

@dkroenke should be fixed ✅

.github/workflows/build.yml

dkroenke · 2025-12-22T07:10:02Z

@dkroenke should be fixed ✅

Yes retested it on Windows and it is solved now, thanks for this!

dkroenke

LGTM

elBoberido · 2025-12-22T15:07:39Z

examples/ArrayOfStructs/ArrayOfStructs.csproj

+    <Copy SourceFiles="$(Iceoryx2OutputPath)/libiceoryx2_ffi_c.dylib"
+          DestinationFolder="$(OutputPath)"
+          Condition="Exists('$(Iceoryx2OutputPath)/libiceoryx2_ffi_c.dylib')"
+          SkipUnchangedFiles="true" />


Would it be possible to set a PATH env variable instead of copying the libs?

@elBoberido well I think we could support it.

I assume the use case you have in mind is that a user/dev has iceoryx2 installed/cloned somewhere already and wants to use this instead of the submodule?

No, still with the submodule but without copying the libs into each folder. This somehow screams for trouble with outdated libraries.

patdhlk added 21 commits December 18, 2025 17:59

Initial commit

3277017

Update readme

984213b

Update readme, fix workflow warning

eaa811a

Add macOS build

cb16fd5

Add iceoryx2 files

e87f5e8

Introduce markdown linting

46f5c77

Upgrade markdown lint action version

bd647e9

Introduce service discovery

85dbc3c

Remove wrong setting

bf32ac5

update iceoryx2 submodule

ad7bda4

feat: Introduce zero-copy payload access and array handling for sampl…

68b4ec5

…es, add tests and an example.

refactor: remove example build steps from build.sh script

b168e06

feat: add TaskCommunication example, update solution file, and enhanc…

2b3fc07

…e README with zero-copy access details.

Set package version to 0.1.0

bcd7ffd

update workflow documentation formatting.

Add copyright headers

69f7230

Verify format in ci

1d380c3

Address review findings

febcbee

Add third-party dependency and license information

0df42c4

Compact overall table size

d620b26

Disable NuGet publishing in workflow until review process is completed

3fe5b18

dkroenke requested review from budrus, dkroenke and elBoberido December 18, 2025 17:06

dkroenke assigned patdhlk Dec 18, 2025

dkroenke reviewed Dec 18, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

dkroenke reviewed Dec 18, 2025

View reviewed changes

ARCHITECTURE.md Show resolved Hide resolved

ARCHITECTURE.md Show resolved Hide resolved

ARCHITECTURE.md Show resolved Hide resolved

ARCHITECTURE.md Show resolved Hide resolved

Address review findings

6f5ce58

Remove integration note and clarify NuGet installation options

dkroenke reviewed Dec 18, 2025

View reviewed changes

examples/ArrayOfStructs/Program.cs Show resolved Hide resolved

patdhlk mentioned this pull request Dec 18, 2025

Blackboard Pattern Support #4

Open

dkroenke reviewed Dec 19, 2025

View reviewed changes

.gitmodules Outdated Show resolved Hide resolved

Update submodule URL to use HTTPS

29f785c

patdhlk dismissed budrus’s stale review via 29f785c December 19, 2025 16:03

patdhlk requested review from budrus and dkroenke December 19, 2025 16:03

budrus previously approved these changes Dec 19, 2025

View reviewed changes

elBoberido previously approved these changes Dec 19, 2025

View reviewed changes

Fix windows build issues

bee503a

- With platform-specific copy operations that handle the different naming conventions: - Each Copy task uses a Condition="Exists(...)" check so only the file that exists on the current platform gets copied, avoiding build errors on other platforms.

patdhlk dismissed stale reviews from elBoberido and budrus via bee503a December 20, 2025 14:01

dkroenke reviewed Dec 22, 2025

View reviewed changes

.github/workflows/build.yml Outdated Show resolved Hide resolved

Temporarily disable NuGet package creation in build workflow

be79f79

patdhlk requested review from budrus, dkroenke and elBoberido December 22, 2025 11:10

dkroenke approved these changes Dec 22, 2025

View reviewed changes

budrus approved these changes Dec 22, 2025

View reviewed changes

elBoberido approved these changes Dec 22, 2025

View reviewed changes

dkroenke merged commit 37b648f into eclipse-iceoryx:main Dec 22, 2025
6 checks passed

dkroenke mentioned this pull request Dec 22, 2025

Repository Migration #1

Closed

2 tasks

[#1] Migration of C# Language-Binding into eclipse-iceoryx #3

[#1] Migration of C# Language-Binding into eclipse-iceoryx #3

Uh oh!

Conversation

patdhlk commented Dec 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Notes for Reviewer

Pre-Review Checklist for the PR Author

PR Reviewer Reminders

References

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dkroenke commented Dec 19, 2025

Uh oh!

elBoberido commented Dec 19, 2025

Uh oh!

elBoberido left a comment

Choose a reason for hiding this comment

Uh oh!

orecham commented Dec 19, 2025

Uh oh!

patdhlk commented Dec 20, 2025

Uh oh!

elfenpiff commented Dec 20, 2025

Uh oh!

patdhlk commented Dec 20, 2025

Uh oh!

dkroenke commented Dec 20, 2025

Uh oh!

patdhlk commented Dec 20, 2025

Uh oh!

patdhlk commented Dec 20, 2025

Uh oh!

Uh oh!

dkroenke commented Dec 22, 2025

Uh oh!

dkroenke left a comment

Choose a reason for hiding this comment

Uh oh!

elBoberido Dec 22, 2025

Choose a reason for hiding this comment

Uh oh!

patdhlk Dec 22, 2025

Choose a reason for hiding this comment

Uh oh!

elBoberido Dec 22, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

patdhlk commented Dec 18, 2025 •

edited

Loading