Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Formalize and document msg number / topic id concept #2473

Closed
jphickey opened this issue Dec 6, 2023 · 0 comments · Fixed by #2474
Closed

Formalize and document msg number / topic id concept #2473

jphickey opened this issue Dec 6, 2023 · 0 comments · Fixed by #2474
Assignees

Comments

@jphickey
Copy link
Contributor

jphickey commented Dec 6, 2023

Is your feature request related to a problem? Please describe.
CFE implements a logical pattern for allocation of MsgIds on multiple CPUs:

The only issue is that this pattern is not documented, and isn't consistent across other CFS apps.

Describe the solution you'd like
Document the TopicID/MsgId assignment pattern in CFE
Formalize it in the CFE header files, such that CFS apps can easily use the same pattern

Additional context
Per discussion on 2023-12-05, it was concurred that this pattern is logical and reasonable to continue following going forward, as it hits most of the objectives users likely want/need:

  • MsgIds can still be directly assigned/customized by overriding the "msgids.h" file at the arch/platform-specific level. This meets the needs of users who may have historical reasons to directly assign msgids to every component, with no pattern or organizational assumption.
  • Alternatively, TopicIds can be assigned/customized by overriding the "topicids.h" file at the global/mission-specific level, in which case the instance-specific MsgId is algorithmically determined via the CFE patterns. This avoids the tedium of assigning individual message IDs, the user only needs to ensure that topic IDs are unique.
  • The user can also alter/tune the TopicID -> MsgId conversion logic if they want to use the topic ID approach but do not want a simple offset/addition. The algorithm can be anything they want, by changing a macro definition.

Requester Info
Joseph Hickey, Vantage Systems, Inc.

@jphickey jphickey self-assigned this Dec 6, 2023
jphickey added a commit to jphickey/cFE that referenced this issue Dec 6, 2023
A topic ID is the same concept as was previously referred to as a
portable message number.  This just formalizes it, gives it a name,
and adds some macros for easier customization of the behavior.
jphickey added a commit to jphickey/cFE that referenced this issue Dec 6, 2023
A topic ID is the same concept as was previously referred to as a
portable message number.  This just formalizes it, gives it a name,
and adds some macros for easier customization of the behavior.
jphickey added a commit to jphickey/cFE that referenced this issue Dec 7, 2023
A topic ID is the same concept as was previously referred to as a
portable message number.  This just formalizes it, gives it a name,
and adds some macros for easier customization of the behavior.
dzbaker added a commit that referenced this issue Dec 12, 2023
Fix #2473, 2475, document and use topicid numbers for cfe
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant