Add requirements for GenericSkeleton by SebSparrowHawk · Pull Request #453 · eclipse-score/communication

SebSparrowHawk · 2026-05-19T15:27:39Z

No description provided.

crimson11 · 2026-05-20T15:07:25Z

+
+
+                ScoreReq.CompReq GenericSkeletonEventListSource {
+                    description = '''A {{GenericSkeleton}} instance shall deduce its supported events from the {{LoLa}} JSON configuration containing deployment information.


Hm. Not sure?
The GenericSkeleton gets the list of events/fields (and at some point also methods - we haven't implemented this yet, but need to do soonish) via parameter in Create(). So the TRUTH is in this parameter of type GenericSkeletonServiceElementInfo ... the related existance of these elements (events/fields) in the mw_com_config.json is also a requirement ... but I would then have a separate req!
The separate req. says, that the GenericSkeleton::Create() shall fail, if for one of the elements in GenericSkeletonServiceElementInfo there is no correlated type/deployment info ...

Changed the description of this ticket and introduced an extra requirement for the verification if elements exist in mw_com_config.json.

crimson11 · 2026-05-20T15:15:23Z

+                     version = 1
+                 }
+
+                 ScoreReq.CompReq GenericSkeletonGetEvents {


You could already create/duplicate these reqs. for fields! Even if it is currently not implemented ... but should be done soonish and then we already have the reqs.

crimson11 · 2026-05-20T15:17:17Z

+
+            }
+
+            section "Generic_Skeleton_Event" {


You can "copy" this section for Fields - do a simple 1:1 copy - which means, that right now we would not have get/set functionality for the GenericField ... this we will add later on req. level, when we now, how we want to deal with methods at all.

crimson11 · 2026-05-20T15:19:45Z

            }
            }
+
+            ScoreReq.CompReq DataTypeMetaInfo {


please double-check with Brendan! Afaik we also have/use {{score::memory::DataTypeSizeInfo}}, which is almost identically! Maybe we have to refactor/clean-up code

Sounds good (also for Brendan) and I removed this requirement and replaced it in the other requirements. I also added a TODO at the definition of DataTypeMetaInfo to replace it with the DataTypeSizeInfo type.

crimson11 · 2026-05-27T16:51:48Z

+                }
+
+                ScoreReq.CompReq GenericSkeletonExceptionLessCreation {
+                    description = '''The {{GenericSkeleton}} class shall provide a non-throwing constructor using the Named Constructor idom (See Creation of an object using Named Constructor approach.


closing ")" missing ;)

Good catch ;)

crimson11 · 2026-05-27T16:57:55Z

+                    * on success, a {{GenericSkeleton}}
+
+                    * {{score::result::Error}} containing the value {{ComErrc::kInstanceIDCouldNotBeResolved}} if the instance identifier could not be resolved from the instance specifier
+                    * {{score::result::Error}} containing the value {{ComErrc::kBindingFailure}} if the binding could not be created


kBindingFailure is "bad", because the user has to guess, what is the issue. FYI: Back then (beginnings of LoLa) we had to resort to the usage of kBindingFailure, because we had to follow AUTOSAR, which only provided/defined a fixed set of errors!. Whenever we had additional errors not yet foreseen by AUTOSAR, we had to fall back to kBindingFailure. This is not needed anymore! We aren't AUTOSAR slaves anymore :D
So please introduce new/descriptive error-codes if you need to. (and yes - we might need to fix the code then :P )

I introduced some new error codes for those specific errors, because the existing ones did not 100% match.

crimson11 · 2026-05-27T17:00:19Z

+                    version = 1
+                }
+
+                ScoreReq.CompReq GenericSkeletonInterfaceElementInConfigurationVerification {


Wouldn't we then also specify with what error we fail?

Added the return code specification.

crimson11 · 2026-05-27T17:02:07Z

+                ScoreReq.CompReq GenericSkeletonCopySemantics {
+                    description = '''The {{GenericSkeleton}} class shall neither be copy-constructable nor copy-assignable.'''
+                    safety = ScoreReq.Asil.B
+                    derived_from = [Communication.DataLoss@1, Communication.ZeroCopy@1]


What says "Communication.ZeroCopy@1"? I would be curious from what high-level requirement we deduce "non-copyable" semantics ...

I took this over from the GenericProxy requirement: https://github.com/eclipse-score/communication/blob/main/score/mw/com/dependability/requirements/component_requirements/component_requirements_ipc.trlc#L1099

Removed the link to that feature requirement wherever it was used to "justify" non-copy semantics.

crimson11 · 2026-05-27T17:04:16Z

+                 ScoreReq.CompReq GenericSkeletonGetEvents {
+                     description = '''The {{GenericSkeleton}} class shall contain a {{public}} method:
+
+                     {{{const GenericSkeleton::EventMap& GenericSkeleton::GetEvents() const noexcept }}}


Please adapt to the newest code (rofl) ... https://github.com/eclipse-score/communication/pull/475/changes#diff-da0c9333f8761ed2a0021cc3c1d6c755224f82bef5850f2d1ebcd8fdd38a29d2R74

crimson11 · 2026-05-28T16:40:42Z


-/// \brief Map that will be used in GenericProxies to store GenericProxyEvents and possibly GenericProxyFields and
-/// GenericProxyMethods once they're supported by LoLa.
+/// \brief Map that will be used in GenericProxies/GenericSkeletons to store the Generic interface elements


You can leave these changes out ... I'm currently refactoring it: #475

crimson11 · 2026-05-28T16:48:34Z

+                ScoreReq.CompReq GenericSkeletonEventSetReceiveHandlerChangedHandler {
+                    description = '''A {{{GenericSkeletonEvent}}} class shall provide a public method:
+
+                    {{{score::Result<void> GenericSkeletonEvent::SetReceiveHandlerChangedHandler(ReceiveHandlerRegistrationChangedCallback callback) noexcept; }}}


I guess the naming shall be rather like in your PR: https://cc-github.bmwgroup.net/oss/eclipse-score-communication/pull/218/files#diff-8f00a8b549d725cb8243dc7f673665fc0ccd567bf42667476bcce646564a1236R47 ?

crimson11 · 2026-05-28T16:49:57Z

+                ScoreReq.CompReq GenericSkeletonEventUnsetReceiveHandlerChangedHandler {
+                    description = '''A {{{GenericSkeletonEvent}}} class shall provide a public method:
+
+                    {{{score::Result<void> GenericSkeletonEvent::UnsetReceiveHandlerChangedHandler() noexcept; }}}


see above ... this is your PR: https://cc-github.bmwgroup.net/oss/eclipse-score-communication/pull/218/files#diff-8f00a8b549d725cb8243dc7f673665fc0ccd567bf42667476bcce646564a1236R51

crimson11 · 2026-05-28T16:50:52Z

+                        ScoreReq.CompReq GenericSkeletonFieldSetReceiveHandlerChangedHandler {
+                            description = '''A {{{GenericSkeletonField}}} class shall provide a public method:
+
+                            {{{score::Result<void> GenericSkeletonField::SetReceiveHandlerChangedHandler(ReceiveHandlerRegistrationChangedCallback callback) noexcept; }}}


see above in the event

crimson11 · 2026-05-28T16:51:14Z

+                        ScoreReq.CompReq GenericSkeletonFieldUnsetReceiveHandlerChangedHandler {
+                            description = '''A {{{GenericSkeletonField}}} class shall provide a public method:
+
+                            {{{score::Result<void> GenericSkeletonField::UnsetReceiveHandlerChangedHandler() noexcept; }}}


see above in the event

- Added requirements for GenericSkeleton and its service elements - Added requirements for GenericProxyField - Cleanup of Communication.ZeroCopy requirement linkage in the context of disabled copy-constructors - Changed requirements where EventMap, FieldMap was used to EventMapView and FieldMapView

SebSparrowHawk force-pushed the ssp_requirements_generic_skeleton branch from 6c035cd to 581ca2c Compare May 20, 2026 13:03

crimson11 requested changes May 20, 2026

View reviewed changes

SebSparrowHawk force-pushed the ssp_requirements_generic_skeleton branch from 581ca2c to 28c6611 Compare May 27, 2026 08:21

crimson11 requested changes May 28, 2026

View reviewed changes

SebSparrowHawk force-pushed the ssp_requirements_generic_skeleton branch 2 times, most recently from 90c5ee6 to 9accea1 Compare May 29, 2026 11:33

SebSparrowHawk force-pushed the ssp_requirements_generic_skeleton branch from 9accea1 to 81e876f Compare May 29, 2026 11:59



		ScoreReq.CompReq GenericSkeletonEventListSource {
		description = '''A {{GenericSkeleton}} instance shall deduce its supported events from the {{LoLa}} JSON configuration containing deployment information.

Conversation

SebSparrowHawk commented May 19, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants