send, register_listener, and unregister_listener

[Xerner]

Disclaimer: This is essentially the first month I have been programming in Rust. If any Rust-specific stuff (i.e. Arc, Mutex) feels out of place or unnecessary, please leave a comment 🙂

Summary of Changes (iceoryx2 0.7.0)

• Added packages
  • tokio: for regular use
  • iceoryx2-bb-container: for FixedSizeVec
  • hostname: to derive the hostname of the host machine when creating ServiceName instances
• Contrary to the previous iteration that used iceoryx2 0.6.1, the UTransport trait functions now interact with iceoryx2 classes directly in their async fn definitions in Iceoryx2PubSub
• Created a thread worker, and a dispatcher to handle creating the worker. The worker continuously runs on its own thread listening for data from publishers for its subscribers. When data arrives, it sends it to the subscribers and their respective UListener
• Added subscriber example on how to register a UListener
• Added publisher example on how to send a UMessage
• Updated the UUri to ServiceName functions that handles converting UUri's into Iceoryx2 ServiceName instances. This was almost a 1-1 copy from what was in the students PRs. All I did was update their code to use uProtocols UMessageType and rely on what the expected iceoryx2 MessagingPattern will be. ❗I think it's still somewhat unfinished. Let me know if I need to put more work into it before this is good enough to merge
• Added VS Code launch settings to debug rust with the LLDB debugger
• Updated Java SDK version to 21 and added its version to the welcome message in the devcontainer. Hopefully this is ok. For some reason, apt-get could not find java SDK version 17 anymore and I was not sure why

Related Project Issues

• closes Implement send() of UTransport trait #11
• closes Implement register_listener() of UTransport trait #12
• closes Implement unregister_listener() of UTransport trait #13
• closes Write example in examples/ folder for a publisher of Publish-style messages #19
• closes Write example in examples/ folder for a subscriber toPublish-style messages #20

[Xerner]

A short summary of these changes now exists in the PR description

[Xerner]

I forgot to add the students as co-authors on the original commit 😭. Looking into how to fix this

• Here;s the link on how to add co-authors https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors#creating-co-authored-commits-on-the-command-line
• Here's the docs describing how to amend older commits that are already pushed https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message#amending-older-or-multiple-commit-messages

I would like their co-authoring to be part of the original commit of this PR. That way their contribution is correctly reflected if people ever search for what exact code they helped contribute. Therefore, I amended the commit for this PR and added them as coauthors to it, and force pushed it. Sorry 😄 this will cause git pull issues if you have already checked out this PR on your local

[Xerner]

I only saw 4 students just looking through their PRs commit history. Let me know if you know of anyone I missed. Here's their info

Co-authored-by: kwarraich kwarraic@andrew.cmu.edu
Co-authored-by: Noella Horo nhoro@andrew.cmu.edu
Co-authored-by: vidishac2004 144144085+vidishac2004@users.noreply.github.com
Co-authored-by: arakabCL arakab@andrew.cmu.edu

[Xerner]

So, UnsafeCell is no longer an issue and I can work directly with Iceoryx2 classes inside an async context now. Not really sure what changed, but I'm able to write this code without most of the dispatcher/worker logic now 🥳. Huge code reducing commit coming soon

[Xerner]

FYI I have rewritten the PR description based on my changes for iceoryx2 0.7.0

[Xerner]

Code is ready to be reviewed again. No segmentation faults, no compile errors, and code works as intended. To run the code, open two terminals and run these commands

cargo run --example subscriber
should produce

cargo run --example publisher
should produce

[PLeVasseur]

Nice, confirmed working on my end:

I may have a chance to poke around in the code during the plane flight to Berlin ✈️

[PLeVasseur]

Hey @Xerner -- this looks good.

As we chatted about, there's some extensions we'd need to make in up-rust to support true zero-copy.

[PLeVasseur]

Hey @Xerner -- this looks like a great start.

We'll need to make some extensions to up-rust to support true zero-copy in the case of using Eclipse iceoryx2 as we talked a bit about.