Fix #2514, change CFE_MSG_Message from union to struct #2515
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.
Checklist (Please check before submitting)
Describe the contribution
Having this abstract type as a "struct" makes it match the Command and Telemetry abstract types. Futhermore, it better conveys the intent that this is an abstract object and should not be directly used or accessed in other ways.
It may still be implemented as a union underneath (depending on how MSG module chooses to implement) but that is hidden from public API. In the case of the default MSG module implementation, there are just a handful of cases where it is accessed internally as bytes, and those are simple enough to do with a cast.
Fixes #2514
Testing performed
Build and run all tests
Expected behavior changes
API simplification
System(s) tested on
Debian
Additional context
There is a (very slight) possibility that some app code has used the
union CFE_MSG_Message
directly, and the change from union to struct will cause an error if any such code exists (but that could should be fixed anyway). None of the current CFS apps appear to do this, so its OK in that domain.If any users have implemented a custom MSG module, this will require a matching/corresponding update in that implementation.
Contributor Info - All information REQUIRED for consideration of pull request
Joseph Hickey, Vantage Systems, Inc.