Skip to content
This repository has been archived by the owner on Dec 13, 2023. It is now read-only.

Implement display for port factory for all messaging patterns #56

Open
elfenpiff opened this issue Nov 15, 2023 · 4 comments
Open

Implement display for port factory for all messaging patterns #56

elfenpiff opened this issue Nov 15, 2023 · 4 comments
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@elfenpiff
Copy link
Contributor

(Code) Example Of Cumbersome API

If one would like to print a state overview of a service it would be nice if the port_factory::{event|publish_subscribe|...} would have implemented Display to show the overview from the example.

@elfenpiff elfenpiff added enhancement New feature or request good first issue Good for newcomers labels Nov 15, 2023
@elfenpiff elfenpiff mentioned this issue Nov 15, 2023
17 tasks
@hydroid7
Copy link

Hi,
I'd like to work on this. On what types should Display implemented?

@elfenpiff
Copy link
Contributor Author

elfenpiff commented Nov 22, 2023

@hydroid7 I assigned you the issue (so that you have dibs on the issue ;) ) but before you start working on this I suggest waiting until latest 4th December, until elkodon is moved into eclipse-iceoryx/iceoryx-ng and is also renamed to iceoryx-ng.
Otherwise, you may encounter a lot of merge conflicts.

Also we could not merge your work before elkodon is part of eclipse-iceoryx due to the licensing issue. At the moment, your work would be published under the GPL 3.0 but this is only a temporary construct and then we need your explicit agreement to re-license your code under a different license.

Still, I am totally happy that you are on board here, so lets focus on the more interesting technical details. The idea came from the example in these two files:

So it would be nice if these two port factories would implement Display and the nice overview that the example is showing would be just a single line of code like:

let event_name = ServiceName::new(b"MyEventName")?;
let event = zero_copy::Service::new(&event_name)
     .event()
     .open_or_create()?;

// this line instead of all the lines from the example
println!("{}", event);

@hydroid7
Copy link

Ok, thank you for the information. I'll wait until Dezember.

@elfenpiff
Copy link
Contributor Author

@hydroid7 Here is the issue in the new iceoryx2 repo: eclipse-iceoryx/iceoryx2#18 if you are still interested.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants