SNIP_CLASSIC_STD_SECTION_5_6_5_Rte_Send

5.6.5 Rte_Send Purpose: Initiate an “explicit” sender-receiver transmission of data elements with “event” semantic (swImplPolicy equal to queued). Signature: [SWS_Rte_01072] Upstream requirements: SRS_BSW_00310, SRS_Rte_00141, SRS_Rte_- 00028, SRS_Rte_00131 ⌈ If returnValueProvision of the related dataSendPoint(s) is not set to noReturnValueProvided: Std_ReturnType Rte_[Byps_]Send_<p>_<o>([IN Rte_Instance <instance>], IN <data>, [IN Std_TransformerForwardCode forwardedCode], [IN uint8* metaDataPtr], [OUT Std_TransformerError transformerError]) If returnValueProvision of the related dataSendPoint(s) is set to noReturnValueProvided: void Rte_[Byps_]Send_<p>_<o>([IN Rte_Instance <instance>], IN <data>, [IN Std_TransformerForwardCode forwardedCode], [IN uint8* metaDataPtr], [OUT Std_TransformerError transformerError]) Where <p> is the port name and <o> the VariableDataPrototype within the sender-receiver interface categorizing the port. [Byps_] is an optional infix used when component wrapper method for bypass support is enabled for the related software component type.⌋ Existence: [SWS_Rte_01281] Upstream requirements: SRS_Rte_00051 ⌈The presence of a VariableAccess in the dataSendPoint role for a provided VariableDataPrototype with event semantics shall result in the generation of an Rte_Send API for the provided VariableDataPrototype.⌋ [SWS_Rte_CONSTR_09016] Rte_Send API may only be used by the runnable that describes its usage ⌈The Rte_Send API may only be used by the runnable that contains the corresponding VariableAccess in the dataSendPoint role⌋ [SWS_Rte_08562] Upstream requirements: SRS_Rte_00249 ⌈The optional OUT parameter transformerError of the API shall be generated if the PortPrototype of port <p> is referenced by a PortAPIOption which has the attribute errorHandling set to transformerErrorHandling.⌋ Description: The Rte_Send API call initiates a sender-receiver communication where the transmission occurs at the point the API call is made (cf. explicit transmission). The Rte_Send API call includes the IN parameter <data> to pass the data element to send. The IN parameter <data> is passed by value or reference according to the ImplementationDataType as described in the section 5.2.6.5. If the IN parameter <data> is passed by reference, the pointer must remain valid until the API call returns. The optional IN parameter metaDataPtr contains a pointer to the meta data byte array which is to be forwarded to COM. See [SWS_Rte_03620]. The optional IN parameter forwardedCode contains the transformer code which shall be forwarded to the E2E transformer. See [SWS_Rte_04572]. The OUT parameter transformerError contains the transformer error which occurred during execution of the transformer chain. See chapter 4.10.5. The RTE generator has to take into account the kind of connected require port which might not be just a variable but also a NV data. The table 4.5 gives an overview of compatibility rules. Return Value: None in case returnValueProvision of the related dataSendPoint(s) is set to noReturnValueProvided. Otherwise, the return value is used to indicate errors detected by the RTE during execution of the Rte_Send. • [SWS_Rte_07821] Upstream requirements: SRS_Rte_00094 ⌈RTE_E_OK – data passed to communication service successfully.⌋ • [SWS_Rte_07823] Upstream requirements: SRS_Rte_00094 ⌈RTE_E_COM_STOPPED – the RTE could not perform the operation because the communication service is currently not available (inter ECU communication only). RTE shall return RTE_E_COM_STOPPED when: – in case of COM the corresponding service returns COM_SERVICE_NOT_AVAILABLE – in case of Large Data Path in COM the corresponding Com_Transmit returns E_NOT_OK ⌋ • [SWS_Rte_02634] Upstream requirements: SRS_Rte_00143 ⌈RTE_E_LIMIT – an ‘event’ has been discarded due to a full queue by one of the ECU local receivers (intra ECU communication only).⌋ • [SWS_Rte_02754] Upstream requirements: SRS_Rte_00210 ⌈RTE_E_SEG_FAULT – a segmentation violation is detected in the handed over parameters to the RTE API as required in [SWS_Rte_02752] and [SWS_Rte_02753]. No transmission is executed.⌋ • [SWS_Rte_08547] Upstream requirements: SRS_Rte_00094, SRS_Rte_00091 ⌈RTE_E_HARD_TRANSFORMER_ERROR – The return value of one transformer in the transformer chain represented a hard transformer error.⌋ • [SWS_Rte_08553] Upstream requirements: SRS_Rte_00094, SRS_Rte_00091 ⌈RTE_E_SOFT_TRANSFORMER_ERROR – The return value of at least one transformer in the transformer chain was a soft error and no hard error occurred in the transformer chain.⌋ Notes: The Rte_Send call is used to transmit “events” (swImplPolicy = queued). [SWS_Rte_07825] Upstream requirements: SRS_Rte_00028, SRS_Rte_00131 ⌈In case of inter ECU communication, the Rte_Send shall cause an immediate transmission request.⌋ Note that depending on the configuration a transmission request may not result in an actual transmission, for example transmission may be rate limited (time-based filtering) and thus dependent on other factors than API calls. [SWS_Rte_07827] Upstream requirements: SRS_Rte_00028, SRS_Rte_00131 ⌈In case of inter ECU communication, the Rte_Send API shall return when the signal has been passed to the communication service for transmission.⌋ Depending on the communication server the transmission may or may not have been acknowledged by the receiver at the point the API call returns. [SWS_Rte_02633] Upstream requirements: SRS_Rte_00028, SRS_Rte_00131 ⌈In case of intra ECU communication, the Rte_Send API call shall return after attempting to enqueue the data in the IOC or RTE internal queues.⌋